increase 1.156.0 → 1.157.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.
@@ -30,6 +30,12 @@ module Increase
30
30
  # @return [Increase::Models::RealTimeDecision::CardAuthorization, nil]
31
31
  required :card_authorization, -> { Increase::RealTimeDecision::CardAuthorization }, nil?: true
32
32
 
33
+ # @!attribute card_balance_inquiry
34
+ # Fields related to a card balance inquiry.
35
+ #
36
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry, nil]
37
+ required :card_balance_inquiry, -> { Increase::RealTimeDecision::CardBalanceInquiry }, nil?: true
38
+
33
39
  # @!attribute category
34
40
  # The category of the Real-Time Decision.
35
41
  #
@@ -77,7 +83,7 @@ module Increase
77
83
  # @return [Symbol, Increase::Models::RealTimeDecision::Type]
78
84
  required :type, enum: -> { Increase::RealTimeDecision::Type }
79
85
 
80
- # @!method initialize(id:, card_authentication:, card_authentication_challenge:, card_authorization:, category:, created_at:, digital_wallet_authentication:, digital_wallet_token:, status:, timeout_at:, type:)
86
+ # @!method initialize(id:, card_authentication:, card_authentication_challenge:, card_authorization:, card_balance_inquiry:, category:, created_at:, digital_wallet_authentication:, digital_wallet_token:, status:, timeout_at:, type:)
81
87
  # Some parameter documentations has been truncated, see
82
88
  # {Increase::Models::RealTimeDecision} for more details.
83
89
  #
@@ -94,6 +100,8 @@ module Increase
94
100
  #
95
101
  # @param card_authorization [Increase::Models::RealTimeDecision::CardAuthorization, nil] Fields related to a card authorization.
96
102
  #
103
+ # @param card_balance_inquiry [Increase::Models::RealTimeDecision::CardBalanceInquiry, nil] Fields related to a card balance inquiry.
104
+ #
97
105
  # @param category [Symbol, Increase::Models::RealTimeDecision::Category] The category of the Real-Time Decision.
98
106
  #
99
107
  # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
@@ -1564,14 +1572,1051 @@ module Increase
1564
1572
  end
1565
1573
  end
1566
1574
 
1567
- # The category of the Real-Time Decision.
1568
- #
1569
- # @see Increase::Models::RealTimeDecision#category
1570
- module Category
1571
- extend Increase::Internal::Type::Enum
1575
+ # @see Increase::Models::RealTimeDecision#card_balance_inquiry
1576
+ class CardBalanceInquiry < Increase::Internal::Type::BaseModel
1577
+ # @!attribute account_id
1578
+ # The identifier of the Account the authorization will debit.
1579
+ #
1580
+ # @return [String]
1581
+ required :account_id, String
1572
1582
 
1573
- # A card is being authorized.
1574
- CARD_AUTHORIZATION_REQUESTED = :card_authorization_requested
1583
+ # @!attribute additional_amounts
1584
+ # Additional amounts associated with the card authorization, such as ATM
1585
+ # surcharges fees. These are usually a subset of the `amount` field and are used
1586
+ # to provide more detailed information about the transaction.
1587
+ #
1588
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts]
1589
+ required :additional_amounts, -> { Increase::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts }
1590
+
1591
+ # @!attribute approval
1592
+ # Present if and only if `decision` is `approve`. Contains information related to
1593
+ # the approval of the balance inquiry.
1594
+ #
1595
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::Approval, nil]
1596
+ required :approval, -> { Increase::RealTimeDecision::CardBalanceInquiry::Approval }, nil?: true
1597
+
1598
+ # @!attribute card_id
1599
+ # The identifier of the Card that is being authorized.
1600
+ #
1601
+ # @return [String]
1602
+ required :card_id, String
1603
+
1604
+ # @!attribute decision
1605
+ # Whether or not the authorization was approved.
1606
+ #
1607
+ # @return [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::Decision, nil]
1608
+ required :decision, enum: -> { Increase::RealTimeDecision::CardBalanceInquiry::Decision }, nil?: true
1609
+
1610
+ # @!attribute digital_wallet_token_id
1611
+ # If the authorization was made via a Digital Wallet Token (such as an Apple Pay
1612
+ # purchase), the identifier of the token that was used.
1613
+ #
1614
+ # @return [String, nil]
1615
+ required :digital_wallet_token_id, String, nil?: true
1616
+
1617
+ # @!attribute merchant_acceptor_id
1618
+ # The merchant identifier (commonly abbreviated as MID) of the merchant the card
1619
+ # is transacting with.
1620
+ #
1621
+ # @return [String]
1622
+ required :merchant_acceptor_id, String
1623
+
1624
+ # @!attribute merchant_category_code
1625
+ # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
1626
+ # card is transacting with.
1627
+ #
1628
+ # @return [String]
1629
+ required :merchant_category_code, String
1630
+
1631
+ # @!attribute merchant_city
1632
+ # The city the merchant resides in.
1633
+ #
1634
+ # @return [String, nil]
1635
+ required :merchant_city, String, nil?: true
1636
+
1637
+ # @!attribute merchant_country
1638
+ # The country the merchant resides in.
1639
+ #
1640
+ # @return [String]
1641
+ required :merchant_country, String
1642
+
1643
+ # @!attribute merchant_descriptor
1644
+ # The merchant descriptor of the merchant the card is transacting with.
1645
+ #
1646
+ # @return [String]
1647
+ required :merchant_descriptor, String
1648
+
1649
+ # @!attribute merchant_postal_code
1650
+ # The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
1651
+ # ZIP code, where the first 5 and last 4 are separated by a dash.
1652
+ #
1653
+ # @return [String, nil]
1654
+ required :merchant_postal_code, String, nil?: true
1655
+
1656
+ # @!attribute merchant_state
1657
+ # The state the merchant resides in.
1658
+ #
1659
+ # @return [String, nil]
1660
+ required :merchant_state, String, nil?: true
1661
+
1662
+ # @!attribute network_details
1663
+ # Fields specific to the `network`.
1664
+ #
1665
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails]
1666
+ required :network_details, -> { Increase::RealTimeDecision::CardBalanceInquiry::NetworkDetails }
1667
+
1668
+ # @!attribute network_identifiers
1669
+ # Network-specific identifiers for a specific request or transaction.
1670
+ #
1671
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkIdentifiers]
1672
+ required :network_identifiers, -> { Increase::RealTimeDecision::CardBalanceInquiry::NetworkIdentifiers }
1673
+
1674
+ # @!attribute network_risk_score
1675
+ # The risk score generated by the card network. For Visa this is the Visa Advanced
1676
+ # Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
1677
+ # score is from 0 to 999, where 999 is the riskiest.
1678
+ #
1679
+ # @return [Integer, nil]
1680
+ required :network_risk_score, Integer, nil?: true
1681
+
1682
+ # @!attribute physical_card_id
1683
+ # If the authorization was made in-person with a physical card, the Physical Card
1684
+ # that was used.
1685
+ #
1686
+ # @return [String, nil]
1687
+ required :physical_card_id, String, nil?: true
1688
+
1689
+ # @!attribute terminal_id
1690
+ # The terminal identifier (commonly abbreviated as TID) of the terminal the card
1691
+ # is transacting with.
1692
+ #
1693
+ # @return [String, nil]
1694
+ required :terminal_id, String, nil?: true
1695
+
1696
+ # @!attribute upcoming_card_payment_id
1697
+ # The identifier of the Card Payment this authorization will belong to. Available
1698
+ # in the API once the card authorization has completed.
1699
+ #
1700
+ # @return [String]
1701
+ required :upcoming_card_payment_id, String
1702
+
1703
+ # @!attribute verification
1704
+ # Fields related to verification of cardholder-provided values.
1705
+ #
1706
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification]
1707
+ required :verification, -> { Increase::RealTimeDecision::CardBalanceInquiry::Verification }
1708
+
1709
+ # @!method initialize(account_id:, additional_amounts:, approval:, card_id:, decision:, digital_wallet_token_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:, terminal_id:, upcoming_card_payment_id:, verification:)
1710
+ # Some parameter documentations has been truncated, see
1711
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry} for more details.
1712
+ #
1713
+ # Fields related to a card balance inquiry.
1714
+ #
1715
+ # @param account_id [String] The identifier of the Account the authorization will debit.
1716
+ #
1717
+ # @param additional_amounts [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts] Additional amounts associated with the card authorization, such as ATM surcharge
1718
+ #
1719
+ # @param approval [Increase::Models::RealTimeDecision::CardBalanceInquiry::Approval, nil] Present if and only if `decision` is `approve`. Contains information related to
1720
+ #
1721
+ # @param card_id [String] The identifier of the Card that is being authorized.
1722
+ #
1723
+ # @param decision [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::Decision, nil] Whether or not the authorization was approved.
1724
+ #
1725
+ # @param digital_wallet_token_id [String, nil] If the authorization was made via a Digital Wallet Token (such as an Apple Pay p
1726
+ #
1727
+ # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
1728
+ #
1729
+ # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
1730
+ #
1731
+ # @param merchant_city [String, nil] The city the merchant resides in.
1732
+ #
1733
+ # @param merchant_country [String] The country the merchant resides in.
1734
+ #
1735
+ # @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with.
1736
+ #
1737
+ # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
1738
+ #
1739
+ # @param merchant_state [String, nil] The state the merchant resides in.
1740
+ #
1741
+ # @param network_details [Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails] Fields specific to the `network`.
1742
+ #
1743
+ # @param network_identifiers [Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction.
1744
+ #
1745
+ # @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced
1746
+ #
1747
+ # @param physical_card_id [String, nil] If the authorization was made in-person with a physical card, the Physical Card
1748
+ #
1749
+ # @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i
1750
+ #
1751
+ # @param upcoming_card_payment_id [String] The identifier of the Card Payment this authorization will belong to. Available
1752
+ #
1753
+ # @param verification [Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification] Fields related to verification of cardholder-provided values.
1754
+
1755
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry#additional_amounts
1756
+ class AdditionalAmounts < Increase::Internal::Type::BaseModel
1757
+ # @!attribute clinic
1758
+ # The part of this transaction amount that was for clinic-related services.
1759
+ #
1760
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Clinic, nil]
1761
+ required :clinic,
1762
+ -> { Increase::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Clinic },
1763
+ nil?: true
1764
+
1765
+ # @!attribute dental
1766
+ # The part of this transaction amount that was for dental-related services.
1767
+ #
1768
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Dental, nil]
1769
+ required :dental,
1770
+ -> { Increase::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Dental },
1771
+ nil?: true
1772
+
1773
+ # @!attribute original
1774
+ # The original pre-authorized amount.
1775
+ #
1776
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Original, nil]
1777
+ required :original,
1778
+ -> { Increase::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Original },
1779
+ nil?: true
1780
+
1781
+ # @!attribute prescription
1782
+ # The part of this transaction amount that was for healthcare prescriptions.
1783
+ #
1784
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Prescription, nil]
1785
+ required :prescription,
1786
+ -> { Increase::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Prescription },
1787
+ nil?: true
1788
+
1789
+ # @!attribute surcharge
1790
+ # The surcharge amount charged for this transaction by the merchant.
1791
+ #
1792
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Surcharge, nil]
1793
+ required :surcharge,
1794
+ -> { Increase::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Surcharge },
1795
+ nil?: true
1796
+
1797
+ # @!attribute total_cumulative
1798
+ # The total amount of a series of incremental authorizations, optionally provided.
1799
+ #
1800
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::TotalCumulative, nil]
1801
+ required :total_cumulative,
1802
+ -> { Increase::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::TotalCumulative },
1803
+ nil?: true
1804
+
1805
+ # @!attribute total_healthcare
1806
+ # The total amount of healthcare-related additional amounts.
1807
+ #
1808
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::TotalHealthcare, nil]
1809
+ required :total_healthcare,
1810
+ -> { Increase::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::TotalHealthcare },
1811
+ nil?: true
1812
+
1813
+ # @!attribute transit
1814
+ # The part of this transaction amount that was for transit-related services.
1815
+ #
1816
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Transit, nil]
1817
+ required :transit,
1818
+ -> { Increase::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Transit },
1819
+ nil?: true
1820
+
1821
+ # @!attribute unknown
1822
+ # An unknown additional amount.
1823
+ #
1824
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Unknown, nil]
1825
+ required :unknown,
1826
+ -> { Increase::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Unknown },
1827
+ nil?: true
1828
+
1829
+ # @!attribute vision
1830
+ # The part of this transaction amount that was for vision-related services.
1831
+ #
1832
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Vision, nil]
1833
+ required :vision,
1834
+ -> { Increase::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Vision },
1835
+ nil?: true
1836
+
1837
+ # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
1838
+ # Some parameter documentations has been truncated, see
1839
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts} for
1840
+ # more details.
1841
+ #
1842
+ # Additional amounts associated with the card authorization, such as ATM
1843
+ # surcharges fees. These are usually a subset of the `amount` field and are used
1844
+ # to provide more detailed information about the transaction.
1845
+ #
1846
+ # @param clinic [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Clinic, nil] The part of this transaction amount that was for clinic-related services.
1847
+ #
1848
+ # @param dental [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
1849
+ #
1850
+ # @param original [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Original, nil] The original pre-authorized amount.
1851
+ #
1852
+ # @param prescription [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
1853
+ #
1854
+ # @param surcharge [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
1855
+ #
1856
+ # @param total_cumulative [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::TotalCumulative, nil] The total amount of a series of incremental authorizations, optionally provided.
1857
+ #
1858
+ # @param total_healthcare [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::TotalHealthcare, nil] The total amount of healthcare-related additional amounts.
1859
+ #
1860
+ # @param transit [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Transit, nil] The part of this transaction amount that was for transit-related services.
1861
+ #
1862
+ # @param unknown [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Unknown, nil] An unknown additional amount.
1863
+ #
1864
+ # @param vision [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Vision, nil] The part of this transaction amount that was for vision-related services.
1865
+
1866
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#clinic
1867
+ class Clinic < Increase::Internal::Type::BaseModel
1868
+ # @!attribute amount
1869
+ # The amount in minor units of the `currency` field. The amount is positive if it
1870
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1871
+ # subtracted from the amount (such as a discount).
1872
+ #
1873
+ # @return [Integer]
1874
+ required :amount, Integer
1875
+
1876
+ # @!attribute currency
1877
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1878
+ # amount's currency.
1879
+ #
1880
+ # @return [String]
1881
+ required :currency, String
1882
+
1883
+ # @!method initialize(amount:, currency:)
1884
+ # Some parameter documentations has been truncated, see
1885
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Clinic}
1886
+ # for more details.
1887
+ #
1888
+ # The part of this transaction amount that was for clinic-related services.
1889
+ #
1890
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1891
+ #
1892
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1893
+ end
1894
+
1895
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#dental
1896
+ class Dental < Increase::Internal::Type::BaseModel
1897
+ # @!attribute amount
1898
+ # The amount in minor units of the `currency` field. The amount is positive if it
1899
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1900
+ # subtracted from the amount (such as a discount).
1901
+ #
1902
+ # @return [Integer]
1903
+ required :amount, Integer
1904
+
1905
+ # @!attribute currency
1906
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1907
+ # amount's currency.
1908
+ #
1909
+ # @return [String]
1910
+ required :currency, String
1911
+
1912
+ # @!method initialize(amount:, currency:)
1913
+ # Some parameter documentations has been truncated, see
1914
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Dental}
1915
+ # for more details.
1916
+ #
1917
+ # The part of this transaction amount that was for dental-related services.
1918
+ #
1919
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1920
+ #
1921
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1922
+ end
1923
+
1924
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#original
1925
+ class Original < Increase::Internal::Type::BaseModel
1926
+ # @!attribute amount
1927
+ # The amount in minor units of the `currency` field. The amount is positive if it
1928
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1929
+ # subtracted from the amount (such as a discount).
1930
+ #
1931
+ # @return [Integer]
1932
+ required :amount, Integer
1933
+
1934
+ # @!attribute currency
1935
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1936
+ # amount's currency.
1937
+ #
1938
+ # @return [String]
1939
+ required :currency, String
1940
+
1941
+ # @!method initialize(amount:, currency:)
1942
+ # Some parameter documentations has been truncated, see
1943
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Original}
1944
+ # for more details.
1945
+ #
1946
+ # The original pre-authorized amount.
1947
+ #
1948
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1949
+ #
1950
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1951
+ end
1952
+
1953
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#prescription
1954
+ class Prescription < Increase::Internal::Type::BaseModel
1955
+ # @!attribute amount
1956
+ # The amount in minor units of the `currency` field. The amount is positive if it
1957
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1958
+ # subtracted from the amount (such as a discount).
1959
+ #
1960
+ # @return [Integer]
1961
+ required :amount, Integer
1962
+
1963
+ # @!attribute currency
1964
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1965
+ # amount's currency.
1966
+ #
1967
+ # @return [String]
1968
+ required :currency, String
1969
+
1970
+ # @!method initialize(amount:, currency:)
1971
+ # Some parameter documentations has been truncated, see
1972
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Prescription}
1973
+ # for more details.
1974
+ #
1975
+ # The part of this transaction amount that was for healthcare prescriptions.
1976
+ #
1977
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1978
+ #
1979
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1980
+ end
1981
+
1982
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#surcharge
1983
+ class Surcharge < Increase::Internal::Type::BaseModel
1984
+ # @!attribute amount
1985
+ # The amount in minor units of the `currency` field. The amount is positive if it
1986
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1987
+ # subtracted from the amount (such as a discount).
1988
+ #
1989
+ # @return [Integer]
1990
+ required :amount, Integer
1991
+
1992
+ # @!attribute currency
1993
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1994
+ # amount's currency.
1995
+ #
1996
+ # @return [String]
1997
+ required :currency, String
1998
+
1999
+ # @!method initialize(amount:, currency:)
2000
+ # Some parameter documentations has been truncated, see
2001
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Surcharge}
2002
+ # for more details.
2003
+ #
2004
+ # The surcharge amount charged for this transaction by the merchant.
2005
+ #
2006
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2007
+ #
2008
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2009
+ end
2010
+
2011
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#total_cumulative
2012
+ class TotalCumulative < Increase::Internal::Type::BaseModel
2013
+ # @!attribute amount
2014
+ # The amount in minor units of the `currency` field. The amount is positive if it
2015
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2016
+ # subtracted from the amount (such as a discount).
2017
+ #
2018
+ # @return [Integer]
2019
+ required :amount, Integer
2020
+
2021
+ # @!attribute currency
2022
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2023
+ # amount's currency.
2024
+ #
2025
+ # @return [String]
2026
+ required :currency, String
2027
+
2028
+ # @!method initialize(amount:, currency:)
2029
+ # Some parameter documentations has been truncated, see
2030
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::TotalCumulative}
2031
+ # for more details.
2032
+ #
2033
+ # The total amount of a series of incremental authorizations, optionally provided.
2034
+ #
2035
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2036
+ #
2037
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2038
+ end
2039
+
2040
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#total_healthcare
2041
+ class TotalHealthcare < Increase::Internal::Type::BaseModel
2042
+ # @!attribute amount
2043
+ # The amount in minor units of the `currency` field. The amount is positive if it
2044
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2045
+ # subtracted from the amount (such as a discount).
2046
+ #
2047
+ # @return [Integer]
2048
+ required :amount, Integer
2049
+
2050
+ # @!attribute currency
2051
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2052
+ # amount's currency.
2053
+ #
2054
+ # @return [String]
2055
+ required :currency, String
2056
+
2057
+ # @!method initialize(amount:, currency:)
2058
+ # Some parameter documentations has been truncated, see
2059
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::TotalHealthcare}
2060
+ # for more details.
2061
+ #
2062
+ # The total amount of healthcare-related additional amounts.
2063
+ #
2064
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2065
+ #
2066
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2067
+ end
2068
+
2069
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#transit
2070
+ class Transit < Increase::Internal::Type::BaseModel
2071
+ # @!attribute amount
2072
+ # The amount in minor units of the `currency` field. The amount is positive if it
2073
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2074
+ # subtracted from the amount (such as a discount).
2075
+ #
2076
+ # @return [Integer]
2077
+ required :amount, Integer
2078
+
2079
+ # @!attribute currency
2080
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2081
+ # amount's currency.
2082
+ #
2083
+ # @return [String]
2084
+ required :currency, String
2085
+
2086
+ # @!method initialize(amount:, currency:)
2087
+ # Some parameter documentations has been truncated, see
2088
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Transit}
2089
+ # for more details.
2090
+ #
2091
+ # The part of this transaction amount that was for transit-related services.
2092
+ #
2093
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2094
+ #
2095
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2096
+ end
2097
+
2098
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#unknown
2099
+ class Unknown < Increase::Internal::Type::BaseModel
2100
+ # @!attribute amount
2101
+ # The amount in minor units of the `currency` field. The amount is positive if it
2102
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2103
+ # subtracted from the amount (such as a discount).
2104
+ #
2105
+ # @return [Integer]
2106
+ required :amount, Integer
2107
+
2108
+ # @!attribute currency
2109
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2110
+ # amount's currency.
2111
+ #
2112
+ # @return [String]
2113
+ required :currency, String
2114
+
2115
+ # @!method initialize(amount:, currency:)
2116
+ # Some parameter documentations has been truncated, see
2117
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Unknown}
2118
+ # for more details.
2119
+ #
2120
+ # An unknown additional amount.
2121
+ #
2122
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2123
+ #
2124
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2125
+ end
2126
+
2127
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#vision
2128
+ class Vision < Increase::Internal::Type::BaseModel
2129
+ # @!attribute amount
2130
+ # The amount in minor units of the `currency` field. The amount is positive if it
2131
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2132
+ # subtracted from the amount (such as a discount).
2133
+ #
2134
+ # @return [Integer]
2135
+ required :amount, Integer
2136
+
2137
+ # @!attribute currency
2138
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2139
+ # amount's currency.
2140
+ #
2141
+ # @return [String]
2142
+ required :currency, String
2143
+
2144
+ # @!method initialize(amount:, currency:)
2145
+ # Some parameter documentations has been truncated, see
2146
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Vision}
2147
+ # for more details.
2148
+ #
2149
+ # The part of this transaction amount that was for vision-related services.
2150
+ #
2151
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2152
+ #
2153
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2154
+ end
2155
+ end
2156
+
2157
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry#approval
2158
+ class Approval < Increase::Internal::Type::BaseModel
2159
+ # @!attribute balance
2160
+ # If the balance inquiry was approved, this field contains the balance in the
2161
+ # minor unit of the settlement currency.
2162
+ #
2163
+ # @return [Integer]
2164
+ required :balance, Integer
2165
+
2166
+ # @!method initialize(balance:)
2167
+ # Some parameter documentations has been truncated, see
2168
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry::Approval} for more
2169
+ # details.
2170
+ #
2171
+ # Present if and only if `decision` is `approve`. Contains information related to
2172
+ # the approval of the balance inquiry.
2173
+ #
2174
+ # @param balance [Integer] If the balance inquiry was approved, this field contains the balance in the mino
2175
+ end
2176
+
2177
+ # Whether or not the authorization was approved.
2178
+ #
2179
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry#decision
2180
+ module Decision
2181
+ extend Increase::Internal::Type::Enum
2182
+
2183
+ # Approve the authorization.
2184
+ APPROVE = :approve
2185
+
2186
+ # Decline the authorization.
2187
+ DECLINE = :decline
2188
+
2189
+ # @!method self.values
2190
+ # @return [Array<Symbol>]
2191
+ end
2192
+
2193
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry#network_details
2194
+ class NetworkDetails < Increase::Internal::Type::BaseModel
2195
+ # @!attribute category
2196
+ # The payment network used to process this card authorization.
2197
+ #
2198
+ # @return [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Category]
2199
+ required :category, enum: -> { Increase::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Category }
2200
+
2201
+ # @!attribute pulse
2202
+ # Fields specific to the `pulse` network.
2203
+ #
2204
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Pulse, nil]
2205
+ required :pulse,
2206
+ -> {
2207
+ Increase::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Pulse
2208
+ },
2209
+ nil?: true
2210
+
2211
+ # @!attribute visa
2212
+ # Fields specific to the `visa` network.
2213
+ #
2214
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa, nil]
2215
+ required :visa,
2216
+ -> {
2217
+ Increase::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa
2218
+ },
2219
+ nil?: true
2220
+
2221
+ # @!method initialize(category:, pulse:, visa:)
2222
+ # Fields specific to the `network`.
2223
+ #
2224
+ # @param category [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Category] The payment network used to process this card authorization.
2225
+ #
2226
+ # @param pulse [Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Pulse, nil] Fields specific to the `pulse` network.
2227
+ #
2228
+ # @param visa [Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa, nil] Fields specific to the `visa` network.
2229
+
2230
+ # The payment network used to process this card authorization.
2231
+ #
2232
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails#category
2233
+ module Category
2234
+ extend Increase::Internal::Type::Enum
2235
+
2236
+ # Visa
2237
+ VISA = :visa
2238
+
2239
+ # Pulse
2240
+ PULSE = :pulse
2241
+
2242
+ # @!method self.values
2243
+ # @return [Array<Symbol>]
2244
+ end
2245
+
2246
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails#pulse
2247
+ class Pulse < Increase::Internal::Type::BaseModel
2248
+ # @!method initialize
2249
+ # Fields specific to the `pulse` network.
2250
+ end
2251
+
2252
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails#visa
2253
+ class Visa < Increase::Internal::Type::BaseModel
2254
+ # @!attribute electronic_commerce_indicator
2255
+ # For electronic commerce transactions, this identifies the level of security used
2256
+ # in obtaining the customer's payment credential. For mail or telephone order
2257
+ # transactions, identifies the type of mail or telephone order.
2258
+ #
2259
+ # @return [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator, nil]
2260
+ required :electronic_commerce_indicator,
2261
+ enum: -> {
2262
+ Increase::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator
2263
+ },
2264
+ nil?: true
2265
+
2266
+ # @!attribute point_of_service_entry_mode
2267
+ # The method used to enter the cardholder's primary account number and card
2268
+ # expiration date.
2269
+ #
2270
+ # @return [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode, nil]
2271
+ required :point_of_service_entry_mode,
2272
+ enum: -> {
2273
+ Increase::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode
2274
+ },
2275
+ nil?: true
2276
+
2277
+ # @!attribute stand_in_processing_reason
2278
+ # Only present when `actioner: network`. Describes why a card authorization was
2279
+ # approved or declined by Visa through stand-in processing.
2280
+ #
2281
+ # @return [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason, nil]
2282
+ required :stand_in_processing_reason,
2283
+ enum: -> {
2284
+ Increase::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason
2285
+ },
2286
+ nil?: true
2287
+
2288
+ # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:)
2289
+ # Some parameter documentations has been truncated, see
2290
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa}
2291
+ # for more details.
2292
+ #
2293
+ # Fields specific to the `visa` network.
2294
+ #
2295
+ # @param electronic_commerce_indicator [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] For electronic commerce transactions, this identifies the level of security used
2296
+ #
2297
+ # @param point_of_service_entry_mode [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode, nil] The method used to enter the cardholder's primary account number and card expira
2298
+ #
2299
+ # @param stand_in_processing_reason [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason, nil] Only present when `actioner: network`. Describes why a card authorization was ap
2300
+
2301
+ # For electronic commerce transactions, this identifies the level of security used
2302
+ # in obtaining the customer's payment credential. For mail or telephone order
2303
+ # transactions, identifies the type of mail or telephone order.
2304
+ #
2305
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa#electronic_commerce_indicator
2306
+ module ElectronicCommerceIndicator
2307
+ extend Increase::Internal::Type::Enum
2308
+
2309
+ # Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.
2310
+ MAIL_PHONE_ORDER = :mail_phone_order
2311
+
2312
+ # Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.
2313
+ RECURRING = :recurring
2314
+
2315
+ # Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.
2316
+ INSTALLMENT = :installment
2317
+
2318
+ # Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.
2319
+ UNKNOWN_MAIL_PHONE_ORDER = :unknown_mail_phone_order
2320
+
2321
+ # Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure
2322
+ SECURE_ELECTRONIC_COMMERCE = :secure_electronic_commerce
2323
+
2324
+ # Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.
2325
+ NON_AUTHENTICATED_SECURITY_TRANSACTION_AT_3DS_CAPABLE_MERCHANT =
2326
+ :non_authenticated_security_transaction_at_3ds_capable_merchant
2327
+
2328
+ # Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.
2329
+ NON_AUTHENTICATED_SECURITY_TRANSACTION = :non_authenticated_security_transaction
2330
+
2331
+ # Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection.
2332
+ NON_SECURE_TRANSACTION = :non_secure_transaction
2333
+
2334
+ # @!method self.values
2335
+ # @return [Array<Symbol>]
2336
+ end
2337
+
2338
+ # The method used to enter the cardholder's primary account number and card
2339
+ # expiration date.
2340
+ #
2341
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa#point_of_service_entry_mode
2342
+ module PointOfServiceEntryMode
2343
+ extend Increase::Internal::Type::Enum
2344
+
2345
+ # Unknown
2346
+ UNKNOWN = :unknown
2347
+
2348
+ # Manual key entry
2349
+ MANUAL = :manual
2350
+
2351
+ # Magnetic stripe read, without card verification value
2352
+ MAGNETIC_STRIPE_NO_CVV = :magnetic_stripe_no_cvv
2353
+
2354
+ # Optical code
2355
+ OPTICAL_CODE = :optical_code
2356
+
2357
+ # Contact chip card
2358
+ INTEGRATED_CIRCUIT_CARD = :integrated_circuit_card
2359
+
2360
+ # Contactless read of chip card
2361
+ CONTACTLESS = :contactless
2362
+
2363
+ # Transaction initiated using a credential that has previously been stored on file
2364
+ CREDENTIAL_ON_FILE = :credential_on_file
2365
+
2366
+ # Magnetic stripe read
2367
+ MAGNETIC_STRIPE = :magnetic_stripe
2368
+
2369
+ # Contactless read of magnetic stripe data
2370
+ CONTACTLESS_MAGNETIC_STRIPE = :contactless_magnetic_stripe
2371
+
2372
+ # Contact chip card, without card verification value
2373
+ INTEGRATED_CIRCUIT_CARD_NO_CVV = :integrated_circuit_card_no_cvv
2374
+
2375
+ # @!method self.values
2376
+ # @return [Array<Symbol>]
2377
+ end
2378
+
2379
+ # Only present when `actioner: network`. Describes why a card authorization was
2380
+ # approved or declined by Visa through stand-in processing.
2381
+ #
2382
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa#stand_in_processing_reason
2383
+ module StandInProcessingReason
2384
+ extend Increase::Internal::Type::Enum
2385
+
2386
+ # Increase failed to process the authorization in a timely manner.
2387
+ ISSUER_ERROR = :issuer_error
2388
+
2389
+ # The physical card read had an invalid CVV, dCVV, or authorization request cryptogram.
2390
+ INVALID_PHYSICAL_CARD = :invalid_physical_card
2391
+
2392
+ # The 3DS cardholder authentication verification value was invalid.
2393
+ INVALID_CARDHOLDER_AUTHENTICATION_VERIFICATION_VALUE =
2394
+ :invalid_cardholder_authentication_verification_value
2395
+
2396
+ # An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays.
2397
+ INTERNAL_VISA_ERROR = :internal_visa_error
2398
+
2399
+ # The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier.
2400
+ MERCHANT_TRANSACTION_ADVISORY_SERVICE_AUTHENTICATION_REQUIRED =
2401
+ :merchant_transaction_advisory_service_authentication_required
2402
+
2403
+ # The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing.
2404
+ PAYMENT_FRAUD_DISRUPTION_ACQUIRER_BLOCK = :payment_fraud_disruption_acquirer_block
2405
+
2406
+ # An unspecific reason for stand-in processing.
2407
+ OTHER = :other
2408
+
2409
+ # @!method self.values
2410
+ # @return [Array<Symbol>]
2411
+ end
2412
+ end
2413
+ end
2414
+
2415
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry#network_identifiers
2416
+ class NetworkIdentifiers < Increase::Internal::Type::BaseModel
2417
+ # @!attribute authorization_identification_response
2418
+ # The randomly generated 6-character Authorization Identification Response code
2419
+ # sent back to the acquirer in an approved response.
2420
+ #
2421
+ # @return [String, nil]
2422
+ required :authorization_identification_response, String, nil?: true
2423
+
2424
+ # @!attribute retrieval_reference_number
2425
+ # A life-cycle identifier used across e.g., an authorization and a reversal.
2426
+ # Expected to be unique per acquirer within a window of time. For some card
2427
+ # networks the retrieval reference number includes the trace counter.
2428
+ #
2429
+ # @return [String, nil]
2430
+ required :retrieval_reference_number, String, nil?: true
2431
+
2432
+ # @!attribute trace_number
2433
+ # A counter used to verify an individual authorization. Expected to be unique per
2434
+ # acquirer within a window of time.
2435
+ #
2436
+ # @return [String, nil]
2437
+ required :trace_number, String, nil?: true
2438
+
2439
+ # @!attribute transaction_id
2440
+ # A globally unique transaction identifier provided by the card network, used
2441
+ # across multiple life-cycle requests.
2442
+ #
2443
+ # @return [String, nil]
2444
+ required :transaction_id, String, nil?: true
2445
+
2446
+ # @!method initialize(authorization_identification_response:, retrieval_reference_number:, trace_number:, transaction_id:)
2447
+ # Some parameter documentations has been truncated, see
2448
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkIdentifiers} for
2449
+ # more details.
2450
+ #
2451
+ # Network-specific identifiers for a specific request or transaction.
2452
+ #
2453
+ # @param authorization_identification_response [String, nil] The randomly generated 6-character Authorization Identification Response code se
2454
+ #
2455
+ # @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec
2456
+ #
2457
+ # @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per
2458
+ #
2459
+ # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro
2460
+ end
2461
+
2462
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry#verification
2463
+ class Verification < Increase::Internal::Type::BaseModel
2464
+ # @!attribute card_verification_code
2465
+ # Fields related to verification of the Card Verification Code, a 3-digit code on
2466
+ # the back of the card.
2467
+ #
2468
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardVerificationCode]
2469
+ required :card_verification_code,
2470
+ -> { Increase::RealTimeDecision::CardBalanceInquiry::Verification::CardVerificationCode }
2471
+
2472
+ # @!attribute cardholder_address
2473
+ # Cardholder address provided in the authorization request and the address on file
2474
+ # we verified it against.
2475
+ #
2476
+ # @return [Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardholderAddress]
2477
+ required :cardholder_address,
2478
+ -> { Increase::RealTimeDecision::CardBalanceInquiry::Verification::CardholderAddress }
2479
+
2480
+ # @!method initialize(card_verification_code:, cardholder_address:)
2481
+ # Some parameter documentations has been truncated, see
2482
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification} for more
2483
+ # details.
2484
+ #
2485
+ # Fields related to verification of cardholder-provided values.
2486
+ #
2487
+ # @param card_verification_code [Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardVerificationCode] Fields related to verification of the Card Verification Code, a 3-digit code on
2488
+ #
2489
+ # @param cardholder_address [Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardholderAddress] Cardholder address provided in the authorization request and the address on file
2490
+
2491
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification#card_verification_code
2492
+ class CardVerificationCode < Increase::Internal::Type::BaseModel
2493
+ # @!attribute result
2494
+ # The result of verifying the Card Verification Code.
2495
+ #
2496
+ # @return [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardVerificationCode::Result]
2497
+ required :result,
2498
+ enum: -> { Increase::RealTimeDecision::CardBalanceInquiry::Verification::CardVerificationCode::Result }
2499
+
2500
+ # @!method initialize(result:)
2501
+ # Fields related to verification of the Card Verification Code, a 3-digit code on
2502
+ # the back of the card.
2503
+ #
2504
+ # @param result [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardVerificationCode::Result] The result of verifying the Card Verification Code.
2505
+
2506
+ # The result of verifying the Card Verification Code.
2507
+ #
2508
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardVerificationCode#result
2509
+ module Result
2510
+ extend Increase::Internal::Type::Enum
2511
+
2512
+ # No card verification code was provided in the authorization request.
2513
+ NOT_CHECKED = :not_checked
2514
+
2515
+ # The card verification code matched the one on file.
2516
+ MATCH = :match
2517
+
2518
+ # The card verification code did not match the one on file.
2519
+ NO_MATCH = :no_match
2520
+
2521
+ # @!method self.values
2522
+ # @return [Array<Symbol>]
2523
+ end
2524
+ end
2525
+
2526
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification#cardholder_address
2527
+ class CardholderAddress < Increase::Internal::Type::BaseModel
2528
+ # @!attribute actual_line1
2529
+ # Line 1 of the address on file for the cardholder.
2530
+ #
2531
+ # @return [String, nil]
2532
+ required :actual_line1, String, nil?: true
2533
+
2534
+ # @!attribute actual_postal_code
2535
+ # The postal code of the address on file for the cardholder.
2536
+ #
2537
+ # @return [String, nil]
2538
+ required :actual_postal_code, String, nil?: true
2539
+
2540
+ # @!attribute provided_line1
2541
+ # The cardholder address line 1 provided for verification in the authorization
2542
+ # request.
2543
+ #
2544
+ # @return [String, nil]
2545
+ required :provided_line1, String, nil?: true
2546
+
2547
+ # @!attribute provided_postal_code
2548
+ # The postal code provided for verification in the authorization request.
2549
+ #
2550
+ # @return [String, nil]
2551
+ required :provided_postal_code, String, nil?: true
2552
+
2553
+ # @!attribute result
2554
+ # The address verification result returned to the card network.
2555
+ #
2556
+ # @return [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardholderAddress::Result]
2557
+ required :result,
2558
+ enum: -> { Increase::RealTimeDecision::CardBalanceInquiry::Verification::CardholderAddress::Result }
2559
+
2560
+ # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:)
2561
+ # Some parameter documentations has been truncated, see
2562
+ # {Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardholderAddress}
2563
+ # for more details.
2564
+ #
2565
+ # Cardholder address provided in the authorization request and the address on file
2566
+ # we verified it against.
2567
+ #
2568
+ # @param actual_line1 [String, nil] Line 1 of the address on file for the cardholder.
2569
+ #
2570
+ # @param actual_postal_code [String, nil] The postal code of the address on file for the cardholder.
2571
+ #
2572
+ # @param provided_line1 [String, nil] The cardholder address line 1 provided for verification in the authorization req
2573
+ #
2574
+ # @param provided_postal_code [String, nil] The postal code provided for verification in the authorization request.
2575
+ #
2576
+ # @param result [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardholderAddress::Result] The address verification result returned to the card network.
2577
+
2578
+ # The address verification result returned to the card network.
2579
+ #
2580
+ # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardholderAddress#result
2581
+ module Result
2582
+ extend Increase::Internal::Type::Enum
2583
+
2584
+ # No address information was provided in the authorization request.
2585
+ NOT_CHECKED = :not_checked
2586
+
2587
+ # Postal code matches, but the street address does not match or was not provided.
2588
+ POSTAL_CODE_MATCH_ADDRESS_NO_MATCH = :postal_code_match_address_no_match
2589
+
2590
+ # Postal code does not match, but the street address matches or was not provided.
2591
+ POSTAL_CODE_NO_MATCH_ADDRESS_MATCH = :postal_code_no_match_address_match
2592
+
2593
+ # Postal code and street address match.
2594
+ MATCH = :match
2595
+
2596
+ # Postal code and street address do not match.
2597
+ NO_MATCH = :no_match
2598
+
2599
+ # Postal code matches, but the street address was not verified. (deprecated)
2600
+ POSTAL_CODE_MATCH_ADDRESS_NOT_CHECKED = :postal_code_match_address_not_checked
2601
+
2602
+ # @!method self.values
2603
+ # @return [Array<Symbol>]
2604
+ end
2605
+ end
2606
+ end
2607
+ end
2608
+
2609
+ # The category of the Real-Time Decision.
2610
+ #
2611
+ # @see Increase::Models::RealTimeDecision#category
2612
+ module Category
2613
+ extend Increase::Internal::Type::Enum
2614
+
2615
+ # A card is being authorized.
2616
+ CARD_AUTHORIZATION_REQUESTED = :card_authorization_requested
2617
+
2618
+ # A balance inquiry is being made on a card.
2619
+ CARD_BALANCE_INQUIRY_REQUESTED = :card_balance_inquiry_requested
1575
2620
 
1576
2621
  # 3DS authentication is requested.
1577
2622
  CARD_AUTHENTICATION_REQUESTED = :card_authentication_requested