increase 1.273.0 → 1.275.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 +21 -0
- data/README.md +1 -1
- data/lib/increase/models/card_payment.rb +1847 -207
- data/lib/increase/models/declined_transaction.rb +183 -1
- data/lib/increase/models/entity.rb +1 -1
- data/lib/increase/models/entity_update_params.rb +49 -9
- data/lib/increase/models/pending_transaction.rb +185 -1
- data/lib/increase/models/transaction.rb +548 -3
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/card_payment.rbi +3985 -595
- data/rbi/increase/models/declined_transaction.rbi +374 -0
- data/rbi/increase/models/entity.rbi +1 -1
- data/rbi/increase/models/entity_update_params.rbi +128 -14
- data/rbi/increase/models/pending_transaction.rbi +374 -0
- data/rbi/increase/models/transaction.rbi +1157 -41
- data/sig/increase/models/card_payment.rbs +1912 -274
- data/sig/increase/models/declined_transaction.rbs +182 -0
- data/sig/increase/models/entity.rbs +1 -1
- data/sig/increase/models/entity_update_params.rbs +52 -10
- data/sig/increase/models/pending_transaction.rbs +182 -0
- data/sig/increase/models/transaction.rbs +546 -0
- metadata +2 -2
|
@@ -641,6 +641,13 @@ module Increase
|
|
|
641
641
|
# @return [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Reason]
|
|
642
642
|
required :reason, enum: -> { Increase::DeclinedTransaction::Source::CardDecline::Reason }
|
|
643
643
|
|
|
644
|
+
# @!attribute scheme_fees
|
|
645
|
+
# The scheme fees associated with this card decline.
|
|
646
|
+
#
|
|
647
|
+
# @return [Array<Increase::Models::DeclinedTransaction::Source::CardDecline::SchemeFee>]
|
|
648
|
+
required :scheme_fees,
|
|
649
|
+
-> { Increase::Internal::Type::ArrayOf[Increase::DeclinedTransaction::Source::CardDecline::SchemeFee] }
|
|
650
|
+
|
|
644
651
|
# @!attribute terminal_id
|
|
645
652
|
# The terminal identifier (commonly abbreviated as TID) of the terminal the card
|
|
646
653
|
# is transacting with.
|
|
@@ -654,7 +661,7 @@ module Increase
|
|
|
654
661
|
# @return [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification]
|
|
655
662
|
required :verification, -> { Increase::DeclinedTransaction::Source::CardDecline::Verification }
|
|
656
663
|
|
|
657
|
-
# @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, declined_transaction_id:, digital_wallet_token_id:, direction:, incremented_card_authorization_id:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, real_time_decision_reason:, reason:, terminal_id:, verification:)
|
|
664
|
+
# @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, declined_transaction_id:, digital_wallet_token_id:, direction:, incremented_card_authorization_id:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, real_time_decision_reason:, reason:, scheme_fees:, terminal_id:, verification:)
|
|
658
665
|
# Some parameter documentations has been truncated, see
|
|
659
666
|
# {Increase::Models::DeclinedTransaction::Source::CardDecline} for more details.
|
|
660
667
|
#
|
|
@@ -715,6 +722,8 @@ module Increase
|
|
|
715
722
|
#
|
|
716
723
|
# @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Reason] Why the transaction was declined.
|
|
717
724
|
#
|
|
725
|
+
# @param scheme_fees [Array<Increase::Models::DeclinedTransaction::Source::CardDecline::SchemeFee>] The scheme fees associated with this card decline.
|
|
726
|
+
#
|
|
718
727
|
# @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i
|
|
719
728
|
#
|
|
720
729
|
# @param verification [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification] Fields related to verification of cardholder-provided values.
|
|
@@ -1644,6 +1653,179 @@ module Increase
|
|
|
1644
1653
|
# @return [Array<Symbol>]
|
|
1645
1654
|
end
|
|
1646
1655
|
|
|
1656
|
+
class SchemeFee < Increase::Internal::Type::BaseModel
|
|
1657
|
+
# @!attribute amount
|
|
1658
|
+
# The fee amount given as a string containing a decimal number.
|
|
1659
|
+
#
|
|
1660
|
+
# @return [String]
|
|
1661
|
+
required :amount, String
|
|
1662
|
+
|
|
1663
|
+
# @!attribute created_at
|
|
1664
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
|
|
1665
|
+
# created.
|
|
1666
|
+
#
|
|
1667
|
+
# @return [Time]
|
|
1668
|
+
required :created_at, Time
|
|
1669
|
+
|
|
1670
|
+
# @!attribute currency
|
|
1671
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
|
|
1672
|
+
# reimbursement.
|
|
1673
|
+
#
|
|
1674
|
+
# @return [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::SchemeFee::Currency]
|
|
1675
|
+
required :currency, enum: -> { Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::Currency }
|
|
1676
|
+
|
|
1677
|
+
# @!attribute fee_type
|
|
1678
|
+
# The type of fee being assessed.
|
|
1679
|
+
#
|
|
1680
|
+
# @return [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType]
|
|
1681
|
+
required :fee_type, enum: -> { Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType }
|
|
1682
|
+
|
|
1683
|
+
# @!attribute fixed_component
|
|
1684
|
+
# The fixed component of the fee, if applicable, given in major units of the fee
|
|
1685
|
+
# amount.
|
|
1686
|
+
#
|
|
1687
|
+
# @return [String, nil]
|
|
1688
|
+
required :fixed_component, String, nil?: true
|
|
1689
|
+
|
|
1690
|
+
# @!attribute variable_rate
|
|
1691
|
+
# The variable rate component of the fee, if applicable, given as a decimal (e.g.,
|
|
1692
|
+
# 0.015 for 1.5%).
|
|
1693
|
+
#
|
|
1694
|
+
# @return [String, nil]
|
|
1695
|
+
required :variable_rate, String, nil?: true
|
|
1696
|
+
|
|
1697
|
+
# @!method initialize(amount:, created_at:, currency:, fee_type:, fixed_component:, variable_rate:)
|
|
1698
|
+
# Some parameter documentations has been truncated, see
|
|
1699
|
+
# {Increase::Models::DeclinedTransaction::Source::CardDecline::SchemeFee} for more
|
|
1700
|
+
# details.
|
|
1701
|
+
#
|
|
1702
|
+
# @param amount [String] The fee amount given as a string containing a decimal number.
|
|
1703
|
+
#
|
|
1704
|
+
# @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
|
|
1705
|
+
#
|
|
1706
|
+
# @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::SchemeFee::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimburs
|
|
1707
|
+
#
|
|
1708
|
+
# @param fee_type [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType] The type of fee being assessed.
|
|
1709
|
+
#
|
|
1710
|
+
# @param fixed_component [String, nil] The fixed component of the fee, if applicable, given in major units of the fee a
|
|
1711
|
+
#
|
|
1712
|
+
# @param variable_rate [String, nil] The variable rate component of the fee, if applicable, given as a decimal (e.g.,
|
|
1713
|
+
|
|
1714
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
|
|
1715
|
+
# reimbursement.
|
|
1716
|
+
#
|
|
1717
|
+
# @see Increase::Models::DeclinedTransaction::Source::CardDecline::SchemeFee#currency
|
|
1718
|
+
module Currency
|
|
1719
|
+
extend Increase::Internal::Type::Enum
|
|
1720
|
+
|
|
1721
|
+
# US Dollar (USD)
|
|
1722
|
+
USD = :USD
|
|
1723
|
+
|
|
1724
|
+
# @!method self.values
|
|
1725
|
+
# @return [Array<Symbol>]
|
|
1726
|
+
end
|
|
1727
|
+
|
|
1728
|
+
# The type of fee being assessed.
|
|
1729
|
+
#
|
|
1730
|
+
# @see Increase::Models::DeclinedTransaction::Source::CardDecline::SchemeFee#fee_type
|
|
1731
|
+
module FeeType
|
|
1732
|
+
extend Increase::Internal::Type::Enum
|
|
1733
|
+
|
|
1734
|
+
# International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency.
|
|
1735
|
+
VISA_INTERNATIONAL_SERVICE_ASSESSMENT_SINGLE_CURRENCY =
|
|
1736
|
+
:visa_international_service_assessment_single_currency
|
|
1737
|
+
|
|
1738
|
+
# International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies.
|
|
1739
|
+
VISA_INTERNATIONAL_SERVICE_ASSESSMENT_CROSS_CURRENCY =
|
|
1740
|
+
:visa_international_service_assessment_cross_currency
|
|
1741
|
+
|
|
1742
|
+
# Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.
|
|
1743
|
+
VISA_AUTHORIZATION_DOMESTIC_POINT_OF_SALE = :visa_authorization_domestic_point_of_sale
|
|
1744
|
+
|
|
1745
|
+
# Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.
|
|
1746
|
+
VISA_AUTHORIZATION_INTERNATIONAL_POINT_OF_SALE = :visa_authorization_international_point_of_sale
|
|
1747
|
+
|
|
1748
|
+
# Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified.
|
|
1749
|
+
VISA_AUTHORIZATION_CANADA_POINT_OF_SALE = :visa_authorization_canada_point_of_sale
|
|
1750
|
+
|
|
1751
|
+
# Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.
|
|
1752
|
+
VISA_AUTHORIZATION_REVERSAL_POINT_OF_SALE = :visa_authorization_reversal_point_of_sale
|
|
1753
|
+
|
|
1754
|
+
# Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.
|
|
1755
|
+
VISA_AUTHORIZATION_REVERSAL_INTERNATIONAL_POINT_OF_SALE =
|
|
1756
|
+
:visa_authorization_reversal_international_point_of_sale
|
|
1757
|
+
|
|
1758
|
+
# A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes.
|
|
1759
|
+
VISA_AUTHORIZATION_ADDRESS_VERIFICATION_SERVICE = :visa_authorization_address_verification_service
|
|
1760
|
+
|
|
1761
|
+
# Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions).
|
|
1762
|
+
VISA_ADVANCED_AUTHORIZATION = :visa_advanced_authorization
|
|
1763
|
+
|
|
1764
|
+
# Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point.
|
|
1765
|
+
VISA_MESSAGE_TRANSMISSION = :visa_message_transmission
|
|
1766
|
+
|
|
1767
|
+
# Activity, per inquiry, related to the domestic Issuer for Account Number Verification.
|
|
1768
|
+
VISA_ACCOUNT_VERIFICATION_DOMESTIC = :visa_account_verification_domestic
|
|
1769
|
+
|
|
1770
|
+
# Activity, per inquiry, related to the international Issuer for Account Number Verification.
|
|
1771
|
+
VISA_ACCOUNT_VERIFICATION_INTERNATIONAL = :visa_account_verification_international
|
|
1772
|
+
|
|
1773
|
+
# Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification.
|
|
1774
|
+
VISA_ACCOUNT_VERIFICATION_CANADA = :visa_account_verification_canada
|
|
1775
|
+
|
|
1776
|
+
# The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.
|
|
1777
|
+
VISA_CORPORATE_ACCEPTANCE_FEE = :visa_corporate_acceptance_fee
|
|
1778
|
+
|
|
1779
|
+
# The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation.
|
|
1780
|
+
VISA_CONSUMER_DEBIT_ACCEPTANCE_FEE = :visa_consumer_debit_acceptance_fee
|
|
1781
|
+
|
|
1782
|
+
# The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions.
|
|
1783
|
+
VISA_BUSINESS_DEBIT_ACCEPTANCE_FEE = :visa_business_debit_acceptance_fee
|
|
1784
|
+
|
|
1785
|
+
# The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.
|
|
1786
|
+
VISA_PURCHASING_ACCEPTANCE_FEE = :visa_purchasing_acceptance_fee
|
|
1787
|
+
|
|
1788
|
+
# Activity and fees for the processing of a sales draft original for a purchase transaction.
|
|
1789
|
+
VISA_PURCHASE_DOMESTIC = :visa_purchase_domestic
|
|
1790
|
+
|
|
1791
|
+
# Activity and fees for the processing of an international sales draft original for a purchase transaction.
|
|
1792
|
+
VISA_PURCHASE_INTERNATIONAL = :visa_purchase_international
|
|
1793
|
+
|
|
1794
|
+
# Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.
|
|
1795
|
+
VISA_CREDIT_PURCHASE_TOKEN = :visa_credit_purchase_token
|
|
1796
|
+
|
|
1797
|
+
# Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.
|
|
1798
|
+
VISA_DEBIT_PURCHASE_TOKEN = :visa_debit_purchase_token
|
|
1799
|
+
|
|
1800
|
+
# A per transaction fee assessed for Base II financial draft - Issuer.
|
|
1801
|
+
VISA_CLEARING_TRANSMISSION = :visa_clearing_transmission
|
|
1802
|
+
|
|
1803
|
+
# Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions.
|
|
1804
|
+
VISA_DIRECT_AUTHORIZATION = :visa_direct_authorization
|
|
1805
|
+
|
|
1806
|
+
# Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions.
|
|
1807
|
+
VISA_DIRECT_TRANSACTION_DOMESTIC = :visa_direct_transaction_domestic
|
|
1808
|
+
|
|
1809
|
+
# Issuer card service fee for Commercial Credit cards.
|
|
1810
|
+
VISA_SERVICE_COMMERCIAL_CREDIT = :visa_service_commercial_credit
|
|
1811
|
+
|
|
1812
|
+
# Issuer Advertising Service Fee for Commercial Credit cards.
|
|
1813
|
+
VISA_ADVERTISING_SERVICE_COMMERCIAL_CREDIT = :visa_advertising_service_commercial_credit
|
|
1814
|
+
|
|
1815
|
+
# Issuer Community Growth Acceleration Program Fee.
|
|
1816
|
+
VISA_COMMUNITY_GROWTH_ACCELERATION_PROGRAM = :visa_community_growth_acceleration_program
|
|
1817
|
+
|
|
1818
|
+
# Issuer Processing Guarantee for Commercial Credit cards.
|
|
1819
|
+
VISA_PROCESSING_GUARANTEE_COMMERCIAL_CREDIT = :visa_processing_guarantee_commercial_credit
|
|
1820
|
+
|
|
1821
|
+
# Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
|
|
1822
|
+
PULSE_SWITCH_FEE = :pulse_switch_fee
|
|
1823
|
+
|
|
1824
|
+
# @!method self.values
|
|
1825
|
+
# @return [Array<Symbol>]
|
|
1826
|
+
end
|
|
1827
|
+
end
|
|
1828
|
+
|
|
1647
1829
|
# @see Increase::Models::DeclinedTransaction::Source::CardDecline#verification
|
|
1648
1830
|
class Verification < Increase::Internal::Type::BaseModel
|
|
1649
1831
|
# @!attribute card_verification_code
|
|
@@ -1825,7 +1825,7 @@ module Increase
|
|
|
1825
1825
|
module Category
|
|
1826
1826
|
extend Increase::Internal::Type::Enum
|
|
1827
1827
|
|
|
1828
|
-
# The entity's tax identifier could not be validated. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.
|
|
1828
|
+
# The entity's tax identifier could not be validated. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).
|
|
1829
1829
|
ENTITY_TAX_IDENTIFIER = :entity_tax_identifier
|
|
1830
1830
|
|
|
1831
1831
|
# The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.address).
|
|
@@ -117,19 +117,20 @@ module Increase
|
|
|
117
117
|
# @return [String, nil]
|
|
118
118
|
optional :industry_code, String
|
|
119
119
|
|
|
120
|
+
# @!attribute legal_identifier
|
|
121
|
+
# The legal identifier of the corporation. This is usually the Employer
|
|
122
|
+
# Identification Number (EIN).
|
|
123
|
+
#
|
|
124
|
+
# @return [Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier, nil]
|
|
125
|
+
optional :legal_identifier, -> { Increase::EntityUpdateParams::Corporation::LegalIdentifier }
|
|
126
|
+
|
|
120
127
|
# @!attribute name
|
|
121
128
|
# The legal name of the corporation.
|
|
122
129
|
#
|
|
123
130
|
# @return [String, nil]
|
|
124
131
|
optional :name, String
|
|
125
132
|
|
|
126
|
-
# @!
|
|
127
|
-
# The Employer Identification Number (EIN) for the corporation.
|
|
128
|
-
#
|
|
129
|
-
# @return [String, nil]
|
|
130
|
-
optional :tax_identifier, String
|
|
131
|
-
|
|
132
|
-
# @!method initialize(address: nil, email: nil, incorporation_state: nil, industry_code: nil, name: nil, tax_identifier: nil)
|
|
133
|
+
# @!method initialize(address: nil, email: nil, incorporation_state: nil, industry_code: nil, legal_identifier: nil, name: nil)
|
|
133
134
|
# Some parameter documentations has been truncated, see
|
|
134
135
|
# {Increase::Models::EntityUpdateParams::Corporation} for more details.
|
|
135
136
|
#
|
|
@@ -144,9 +145,9 @@ module Increase
|
|
|
144
145
|
#
|
|
145
146
|
# @param industry_code [String] The North American Industry Classification System (NAICS) code for the corporati
|
|
146
147
|
#
|
|
147
|
-
# @param
|
|
148
|
+
# @param legal_identifier [Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier] The legal identifier of the corporation. This is usually the Employer Identifica
|
|
148
149
|
#
|
|
149
|
-
# @param
|
|
150
|
+
# @param name [String] The legal name of the corporation.
|
|
150
151
|
|
|
151
152
|
# @see Increase::Models::EntityUpdateParams::Corporation#address
|
|
152
153
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -206,6 +207,45 @@ module Increase
|
|
|
206
207
|
#
|
|
207
208
|
# @param zip [String] The ZIP or postal code of the address. Required in certain countries.
|
|
208
209
|
end
|
|
210
|
+
|
|
211
|
+
# @see Increase::Models::EntityUpdateParams::Corporation#legal_identifier
|
|
212
|
+
class LegalIdentifier < Increase::Internal::Type::BaseModel
|
|
213
|
+
# @!attribute value
|
|
214
|
+
# The identifier of the legal identifier.
|
|
215
|
+
#
|
|
216
|
+
# @return [String]
|
|
217
|
+
required :value, String
|
|
218
|
+
|
|
219
|
+
# @!attribute category
|
|
220
|
+
# The category of the legal identifier.
|
|
221
|
+
#
|
|
222
|
+
# @return [Symbol, Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier::Category, nil]
|
|
223
|
+
optional :category, enum: -> { Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category }
|
|
224
|
+
|
|
225
|
+
# @!method initialize(value:, category: nil)
|
|
226
|
+
# The legal identifier of the corporation. This is usually the Employer
|
|
227
|
+
# Identification Number (EIN).
|
|
228
|
+
#
|
|
229
|
+
# @param value [String] The identifier of the legal identifier.
|
|
230
|
+
#
|
|
231
|
+
# @param category [Symbol, Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier::Category] The category of the legal identifier.
|
|
232
|
+
|
|
233
|
+
# The category of the legal identifier.
|
|
234
|
+
#
|
|
235
|
+
# @see Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier#category
|
|
236
|
+
module Category
|
|
237
|
+
extend Increase::Internal::Type::Enum
|
|
238
|
+
|
|
239
|
+
# The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.
|
|
240
|
+
US_EMPLOYER_IDENTIFICATION_NUMBER = :us_employer_identification_number
|
|
241
|
+
|
|
242
|
+
# A legal identifier issued by a foreign government, like a tax identification number or registration number.
|
|
243
|
+
OTHER = :other
|
|
244
|
+
|
|
245
|
+
# @!method self.values
|
|
246
|
+
# @return [Array<Symbol>]
|
|
247
|
+
end
|
|
248
|
+
end
|
|
209
249
|
end
|
|
210
250
|
|
|
211
251
|
class GovernmentAuthority < Increase::Internal::Type::BaseModel
|
|
@@ -743,6 +743,13 @@ module Increase
|
|
|
743
743
|
# @return [String, nil]
|
|
744
744
|
required :real_time_decision_id, String, nil?: true
|
|
745
745
|
|
|
746
|
+
# @!attribute scheme_fees
|
|
747
|
+
# The scheme fees associated with this card authorization.
|
|
748
|
+
#
|
|
749
|
+
# @return [Array<Increase::Models::PendingTransaction::Source::CardAuthorization::SchemeFee>]
|
|
750
|
+
required :scheme_fees,
|
|
751
|
+
-> { Increase::Internal::Type::ArrayOf[Increase::PendingTransaction::Source::CardAuthorization::SchemeFee] }
|
|
752
|
+
|
|
746
753
|
# @!attribute terminal_id
|
|
747
754
|
# The terminal identifier (commonly abbreviated as TID) of the terminal the card
|
|
748
755
|
# is transacting with.
|
|
@@ -763,7 +770,7 @@ module Increase
|
|
|
763
770
|
# @return [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification]
|
|
764
771
|
required :verification, -> { Increase::PendingTransaction::Source::CardAuthorization::Verification }
|
|
765
772
|
|
|
766
|
-
# @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, terminal_id:, type:, verification:)
|
|
773
|
+
# @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, scheme_fees:, terminal_id:, type:, verification:)
|
|
767
774
|
# Some parameter documentations has been truncated, see
|
|
768
775
|
# {Increase::Models::PendingTransaction::Source::CardAuthorization} for more
|
|
769
776
|
# details.
|
|
@@ -823,6 +830,8 @@ module Increase
|
|
|
823
830
|
#
|
|
824
831
|
# @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this transac
|
|
825
832
|
#
|
|
833
|
+
# @param scheme_fees [Array<Increase::Models::PendingTransaction::Source::CardAuthorization::SchemeFee>] The scheme fees associated with this card authorization.
|
|
834
|
+
#
|
|
826
835
|
# @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i
|
|
827
836
|
#
|
|
828
837
|
# @param type [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Type] A constant representing the object's type. For this resource it will always be `
|
|
@@ -1666,6 +1675,181 @@ module Increase
|
|
|
1666
1675
|
# @return [Array<Symbol>]
|
|
1667
1676
|
end
|
|
1668
1677
|
|
|
1678
|
+
class SchemeFee < Increase::Internal::Type::BaseModel
|
|
1679
|
+
# @!attribute amount
|
|
1680
|
+
# The fee amount given as a string containing a decimal number.
|
|
1681
|
+
#
|
|
1682
|
+
# @return [String]
|
|
1683
|
+
required :amount, String
|
|
1684
|
+
|
|
1685
|
+
# @!attribute created_at
|
|
1686
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
|
|
1687
|
+
# created.
|
|
1688
|
+
#
|
|
1689
|
+
# @return [Time]
|
|
1690
|
+
required :created_at, Time
|
|
1691
|
+
|
|
1692
|
+
# @!attribute currency
|
|
1693
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
|
|
1694
|
+
# reimbursement.
|
|
1695
|
+
#
|
|
1696
|
+
# @return [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::SchemeFee::Currency]
|
|
1697
|
+
required :currency,
|
|
1698
|
+
enum: -> { Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::Currency }
|
|
1699
|
+
|
|
1700
|
+
# @!attribute fee_type
|
|
1701
|
+
# The type of fee being assessed.
|
|
1702
|
+
#
|
|
1703
|
+
# @return [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType]
|
|
1704
|
+
required :fee_type,
|
|
1705
|
+
enum: -> { Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType }
|
|
1706
|
+
|
|
1707
|
+
# @!attribute fixed_component
|
|
1708
|
+
# The fixed component of the fee, if applicable, given in major units of the fee
|
|
1709
|
+
# amount.
|
|
1710
|
+
#
|
|
1711
|
+
# @return [String, nil]
|
|
1712
|
+
required :fixed_component, String, nil?: true
|
|
1713
|
+
|
|
1714
|
+
# @!attribute variable_rate
|
|
1715
|
+
# The variable rate component of the fee, if applicable, given as a decimal (e.g.,
|
|
1716
|
+
# 0.015 for 1.5%).
|
|
1717
|
+
#
|
|
1718
|
+
# @return [String, nil]
|
|
1719
|
+
required :variable_rate, String, nil?: true
|
|
1720
|
+
|
|
1721
|
+
# @!method initialize(amount:, created_at:, currency:, fee_type:, fixed_component:, variable_rate:)
|
|
1722
|
+
# Some parameter documentations has been truncated, see
|
|
1723
|
+
# {Increase::Models::PendingTransaction::Source::CardAuthorization::SchemeFee} for
|
|
1724
|
+
# more details.
|
|
1725
|
+
#
|
|
1726
|
+
# @param amount [String] The fee amount given as a string containing a decimal number.
|
|
1727
|
+
#
|
|
1728
|
+
# @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
|
|
1729
|
+
#
|
|
1730
|
+
# @param currency [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::SchemeFee::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimburs
|
|
1731
|
+
#
|
|
1732
|
+
# @param fee_type [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType] The type of fee being assessed.
|
|
1733
|
+
#
|
|
1734
|
+
# @param fixed_component [String, nil] The fixed component of the fee, if applicable, given in major units of the fee a
|
|
1735
|
+
#
|
|
1736
|
+
# @param variable_rate [String, nil] The variable rate component of the fee, if applicable, given as a decimal (e.g.,
|
|
1737
|
+
|
|
1738
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
|
|
1739
|
+
# reimbursement.
|
|
1740
|
+
#
|
|
1741
|
+
# @see Increase::Models::PendingTransaction::Source::CardAuthorization::SchemeFee#currency
|
|
1742
|
+
module Currency
|
|
1743
|
+
extend Increase::Internal::Type::Enum
|
|
1744
|
+
|
|
1745
|
+
# US Dollar (USD)
|
|
1746
|
+
USD = :USD
|
|
1747
|
+
|
|
1748
|
+
# @!method self.values
|
|
1749
|
+
# @return [Array<Symbol>]
|
|
1750
|
+
end
|
|
1751
|
+
|
|
1752
|
+
# The type of fee being assessed.
|
|
1753
|
+
#
|
|
1754
|
+
# @see Increase::Models::PendingTransaction::Source::CardAuthorization::SchemeFee#fee_type
|
|
1755
|
+
module FeeType
|
|
1756
|
+
extend Increase::Internal::Type::Enum
|
|
1757
|
+
|
|
1758
|
+
# International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency.
|
|
1759
|
+
VISA_INTERNATIONAL_SERVICE_ASSESSMENT_SINGLE_CURRENCY =
|
|
1760
|
+
:visa_international_service_assessment_single_currency
|
|
1761
|
+
|
|
1762
|
+
# International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies.
|
|
1763
|
+
VISA_INTERNATIONAL_SERVICE_ASSESSMENT_CROSS_CURRENCY =
|
|
1764
|
+
:visa_international_service_assessment_cross_currency
|
|
1765
|
+
|
|
1766
|
+
# Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.
|
|
1767
|
+
VISA_AUTHORIZATION_DOMESTIC_POINT_OF_SALE = :visa_authorization_domestic_point_of_sale
|
|
1768
|
+
|
|
1769
|
+
# Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.
|
|
1770
|
+
VISA_AUTHORIZATION_INTERNATIONAL_POINT_OF_SALE = :visa_authorization_international_point_of_sale
|
|
1771
|
+
|
|
1772
|
+
# Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified.
|
|
1773
|
+
VISA_AUTHORIZATION_CANADA_POINT_OF_SALE = :visa_authorization_canada_point_of_sale
|
|
1774
|
+
|
|
1775
|
+
# Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.
|
|
1776
|
+
VISA_AUTHORIZATION_REVERSAL_POINT_OF_SALE = :visa_authorization_reversal_point_of_sale
|
|
1777
|
+
|
|
1778
|
+
# Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.
|
|
1779
|
+
VISA_AUTHORIZATION_REVERSAL_INTERNATIONAL_POINT_OF_SALE =
|
|
1780
|
+
:visa_authorization_reversal_international_point_of_sale
|
|
1781
|
+
|
|
1782
|
+
# A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes.
|
|
1783
|
+
VISA_AUTHORIZATION_ADDRESS_VERIFICATION_SERVICE = :visa_authorization_address_verification_service
|
|
1784
|
+
|
|
1785
|
+
# Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions).
|
|
1786
|
+
VISA_ADVANCED_AUTHORIZATION = :visa_advanced_authorization
|
|
1787
|
+
|
|
1788
|
+
# Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point.
|
|
1789
|
+
VISA_MESSAGE_TRANSMISSION = :visa_message_transmission
|
|
1790
|
+
|
|
1791
|
+
# Activity, per inquiry, related to the domestic Issuer for Account Number Verification.
|
|
1792
|
+
VISA_ACCOUNT_VERIFICATION_DOMESTIC = :visa_account_verification_domestic
|
|
1793
|
+
|
|
1794
|
+
# Activity, per inquiry, related to the international Issuer for Account Number Verification.
|
|
1795
|
+
VISA_ACCOUNT_VERIFICATION_INTERNATIONAL = :visa_account_verification_international
|
|
1796
|
+
|
|
1797
|
+
# Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification.
|
|
1798
|
+
VISA_ACCOUNT_VERIFICATION_CANADA = :visa_account_verification_canada
|
|
1799
|
+
|
|
1800
|
+
# The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.
|
|
1801
|
+
VISA_CORPORATE_ACCEPTANCE_FEE = :visa_corporate_acceptance_fee
|
|
1802
|
+
|
|
1803
|
+
# The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation.
|
|
1804
|
+
VISA_CONSUMER_DEBIT_ACCEPTANCE_FEE = :visa_consumer_debit_acceptance_fee
|
|
1805
|
+
|
|
1806
|
+
# The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions.
|
|
1807
|
+
VISA_BUSINESS_DEBIT_ACCEPTANCE_FEE = :visa_business_debit_acceptance_fee
|
|
1808
|
+
|
|
1809
|
+
# The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.
|
|
1810
|
+
VISA_PURCHASING_ACCEPTANCE_FEE = :visa_purchasing_acceptance_fee
|
|
1811
|
+
|
|
1812
|
+
# Activity and fees for the processing of a sales draft original for a purchase transaction.
|
|
1813
|
+
VISA_PURCHASE_DOMESTIC = :visa_purchase_domestic
|
|
1814
|
+
|
|
1815
|
+
# Activity and fees for the processing of an international sales draft original for a purchase transaction.
|
|
1816
|
+
VISA_PURCHASE_INTERNATIONAL = :visa_purchase_international
|
|
1817
|
+
|
|
1818
|
+
# Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.
|
|
1819
|
+
VISA_CREDIT_PURCHASE_TOKEN = :visa_credit_purchase_token
|
|
1820
|
+
|
|
1821
|
+
# Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.
|
|
1822
|
+
VISA_DEBIT_PURCHASE_TOKEN = :visa_debit_purchase_token
|
|
1823
|
+
|
|
1824
|
+
# A per transaction fee assessed for Base II financial draft - Issuer.
|
|
1825
|
+
VISA_CLEARING_TRANSMISSION = :visa_clearing_transmission
|
|
1826
|
+
|
|
1827
|
+
# Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions.
|
|
1828
|
+
VISA_DIRECT_AUTHORIZATION = :visa_direct_authorization
|
|
1829
|
+
|
|
1830
|
+
# Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions.
|
|
1831
|
+
VISA_DIRECT_TRANSACTION_DOMESTIC = :visa_direct_transaction_domestic
|
|
1832
|
+
|
|
1833
|
+
# Issuer card service fee for Commercial Credit cards.
|
|
1834
|
+
VISA_SERVICE_COMMERCIAL_CREDIT = :visa_service_commercial_credit
|
|
1835
|
+
|
|
1836
|
+
# Issuer Advertising Service Fee for Commercial Credit cards.
|
|
1837
|
+
VISA_ADVERTISING_SERVICE_COMMERCIAL_CREDIT = :visa_advertising_service_commercial_credit
|
|
1838
|
+
|
|
1839
|
+
# Issuer Community Growth Acceleration Program Fee.
|
|
1840
|
+
VISA_COMMUNITY_GROWTH_ACCELERATION_PROGRAM = :visa_community_growth_acceleration_program
|
|
1841
|
+
|
|
1842
|
+
# Issuer Processing Guarantee for Commercial Credit cards.
|
|
1843
|
+
VISA_PROCESSING_GUARANTEE_COMMERCIAL_CREDIT = :visa_processing_guarantee_commercial_credit
|
|
1844
|
+
|
|
1845
|
+
# Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
|
|
1846
|
+
PULSE_SWITCH_FEE = :pulse_switch_fee
|
|
1847
|
+
|
|
1848
|
+
# @!method self.values
|
|
1849
|
+
# @return [Array<Symbol>]
|
|
1850
|
+
end
|
|
1851
|
+
end
|
|
1852
|
+
|
|
1669
1853
|
# A constant representing the object's type. For this resource it will always be
|
|
1670
1854
|
# `card_authorization`.
|
|
1671
1855
|
#
|