increase 0.343.0 → 0.344.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.
- package/CHANGELOG.md +8 -0
- package/package.json +1 -1
- package/resources/card-payments.d.ts +589 -1
- package/resources/card-payments.d.ts.map +1 -1
- package/resources/card-payments.js.map +1 -1
- package/resources/card-payments.mjs.map +1 -1
- package/src/resources/card-payments.ts +708 -0
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.344.0 (2025-10-28)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.343.0...v0.344.0](https://github.com/Increase/increase-node/compare/v0.343.0...v0.344.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([c87b65e](https://github.com/Increase/increase-node/commit/c87b65ecd352369f5065af0a68d3e9353d0d2d96))
|
|
10
|
+
|
|
3
11
|
## 0.343.0 (2025-10-27)
|
|
4
12
|
|
|
5
13
|
Full Changelog: [v0.342.0...v0.343.0](https://github.com/Increase/increase-node/compare/v0.342.0...v0.343.0)
|
package/package.json
CHANGED
|
@@ -100,6 +100,12 @@ export declare namespace CardPayment {
|
|
|
100
100
|
* only if `category` is equal to `card_decline`.
|
|
101
101
|
*/
|
|
102
102
|
card_decline: Element.CardDecline | null;
|
|
103
|
+
/**
|
|
104
|
+
* A Card Financial object. This field will be present in the JSON response if and
|
|
105
|
+
* only if `category` is equal to `card_financial`. Card Financials are temporary
|
|
106
|
+
* holds placed on a customers funds with the intent to later clear a transaction.
|
|
107
|
+
*/
|
|
108
|
+
card_financial: Element.CardFinancial | null;
|
|
103
109
|
/**
|
|
104
110
|
* A Card Fuel Confirmation object. This field will be present in the JSON response
|
|
105
111
|
* if and only if `category` is equal to `card_fuel_confirmation`. Card Fuel
|
|
@@ -165,9 +171,11 @@ export declare namespace CardPayment {
|
|
|
165
171
|
* - `card_refund` - Card Refund: details will be under the `card_refund` object.
|
|
166
172
|
* - `card_fuel_confirmation` - Card Fuel Confirmation: details will be under the
|
|
167
173
|
* `card_fuel_confirmation` object.
|
|
174
|
+
* - `card_financial` - Card Financial: details will be under the `card_financial`
|
|
175
|
+
* object.
|
|
168
176
|
* - `other` - Unknown card payment element.
|
|
169
177
|
*/
|
|
170
|
-
category: 'card_authorization' | 'card_authentication' | 'card_validation' | 'card_decline' | 'card_reversal' | 'card_authorization_expiration' | 'card_increment' | 'card_settlement' | 'card_refund' | 'card_fuel_confirmation' | 'other';
|
|
178
|
+
category: 'card_authorization' | 'card_authentication' | 'card_validation' | 'card_decline' | 'card_reversal' | 'card_authorization_expiration' | 'card_increment' | 'card_settlement' | 'card_refund' | 'card_fuel_confirmation' | 'card_financial' | 'other';
|
|
171
179
|
/**
|
|
172
180
|
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
173
181
|
* the card payment element was created.
|
|
@@ -1602,6 +1610,586 @@ export declare namespace CardPayment {
|
|
|
1602
1610
|
}
|
|
1603
1611
|
}
|
|
1604
1612
|
}
|
|
1613
|
+
/**
|
|
1614
|
+
* A Card Financial object. This field will be present in the JSON response if and
|
|
1615
|
+
* only if `category` is equal to `card_financial`. Card Financials are temporary
|
|
1616
|
+
* holds placed on a customers funds with the intent to later clear a transaction.
|
|
1617
|
+
*/
|
|
1618
|
+
interface CardFinancial {
|
|
1619
|
+
/**
|
|
1620
|
+
* The Card Financial identifier.
|
|
1621
|
+
*/
|
|
1622
|
+
id: string;
|
|
1623
|
+
/**
|
|
1624
|
+
* Whether this financial was approved by Increase, the card network through
|
|
1625
|
+
* stand-in processing, or the user through a real-time decision.
|
|
1626
|
+
*
|
|
1627
|
+
* - `user` - This object was actioned by the user through a real-time decision.
|
|
1628
|
+
* - `increase` - This object was actioned by Increase without user intervention.
|
|
1629
|
+
* - `network` - This object was actioned by the network, through stand-in
|
|
1630
|
+
* processing.
|
|
1631
|
+
*/
|
|
1632
|
+
actioner: 'user' | 'increase' | 'network';
|
|
1633
|
+
/**
|
|
1634
|
+
* Additional amounts associated with the card authorization, such as ATM
|
|
1635
|
+
* surcharges fees. These are usually a subset of the `amount` field and are used
|
|
1636
|
+
* to provide more detailed information about the transaction.
|
|
1637
|
+
*/
|
|
1638
|
+
additional_amounts: CardFinancial.AdditionalAmounts;
|
|
1639
|
+
/**
|
|
1640
|
+
* The pending amount in the minor unit of the transaction's currency. For dollars,
|
|
1641
|
+
* for example, this is cents.
|
|
1642
|
+
*/
|
|
1643
|
+
amount: number;
|
|
1644
|
+
/**
|
|
1645
|
+
* The ID of the Card Payment this transaction belongs to.
|
|
1646
|
+
*/
|
|
1647
|
+
card_payment_id: string;
|
|
1648
|
+
/**
|
|
1649
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
1650
|
+
* transaction's currency.
|
|
1651
|
+
*
|
|
1652
|
+
* - `CAD` - Canadian Dollar (CAD)
|
|
1653
|
+
* - `CHF` - Swiss Franc (CHF)
|
|
1654
|
+
* - `EUR` - Euro (EUR)
|
|
1655
|
+
* - `GBP` - British Pound (GBP)
|
|
1656
|
+
* - `JPY` - Japanese Yen (JPY)
|
|
1657
|
+
* - `USD` - US Dollar (USD)
|
|
1658
|
+
*/
|
|
1659
|
+
currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
|
|
1660
|
+
/**
|
|
1661
|
+
* If the authorization was made via a Digital Wallet Token (such as an Apple Pay
|
|
1662
|
+
* purchase), the identifier of the token that was used.
|
|
1663
|
+
*/
|
|
1664
|
+
digital_wallet_token_id: string | null;
|
|
1665
|
+
/**
|
|
1666
|
+
* The direction describes the direction the funds will move, either from the
|
|
1667
|
+
* cardholder to the merchant or from the merchant to the cardholder.
|
|
1668
|
+
*
|
|
1669
|
+
* - `settlement` - A regular card authorization where funds are debited from the
|
|
1670
|
+
* cardholder.
|
|
1671
|
+
* - `refund` - A refund card authorization, sometimes referred to as a credit
|
|
1672
|
+
* voucher authorization, where funds are credited to the cardholder.
|
|
1673
|
+
*/
|
|
1674
|
+
direction: 'settlement' | 'refund';
|
|
1675
|
+
/**
|
|
1676
|
+
* The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
1677
|
+
* is transacting with.
|
|
1678
|
+
*/
|
|
1679
|
+
merchant_acceptor_id: string;
|
|
1680
|
+
/**
|
|
1681
|
+
* The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
|
1682
|
+
* card is transacting with.
|
|
1683
|
+
*/
|
|
1684
|
+
merchant_category_code: string;
|
|
1685
|
+
/**
|
|
1686
|
+
* The city the merchant resides in.
|
|
1687
|
+
*/
|
|
1688
|
+
merchant_city: string | null;
|
|
1689
|
+
/**
|
|
1690
|
+
* The country the merchant resides in.
|
|
1691
|
+
*/
|
|
1692
|
+
merchant_country: string;
|
|
1693
|
+
/**
|
|
1694
|
+
* The merchant descriptor of the merchant the card is transacting with.
|
|
1695
|
+
*/
|
|
1696
|
+
merchant_descriptor: string;
|
|
1697
|
+
/**
|
|
1698
|
+
* The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
|
|
1699
|
+
* ZIP code, where the first 5 and last 4 are separated by a dash.
|
|
1700
|
+
*/
|
|
1701
|
+
merchant_postal_code: string | null;
|
|
1702
|
+
/**
|
|
1703
|
+
* The state the merchant resides in.
|
|
1704
|
+
*/
|
|
1705
|
+
merchant_state: string | null;
|
|
1706
|
+
/**
|
|
1707
|
+
* Fields specific to the `network`.
|
|
1708
|
+
*/
|
|
1709
|
+
network_details: CardFinancial.NetworkDetails;
|
|
1710
|
+
/**
|
|
1711
|
+
* Network-specific identifiers for a specific request or transaction.
|
|
1712
|
+
*/
|
|
1713
|
+
network_identifiers: CardFinancial.NetworkIdentifiers;
|
|
1714
|
+
/**
|
|
1715
|
+
* The risk score generated by the card network. For Visa this is the Visa Advanced
|
|
1716
|
+
* Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
|
|
1717
|
+
* score is from 0 to 999, where 999 is the riskiest.
|
|
1718
|
+
*/
|
|
1719
|
+
network_risk_score: number | null;
|
|
1720
|
+
/**
|
|
1721
|
+
* If the authorization was made in-person with a physical card, the Physical Card
|
|
1722
|
+
* that was used.
|
|
1723
|
+
*/
|
|
1724
|
+
physical_card_id: string | null;
|
|
1725
|
+
/**
|
|
1726
|
+
* The pending amount in the minor unit of the transaction's presentment currency.
|
|
1727
|
+
*/
|
|
1728
|
+
presentment_amount: number;
|
|
1729
|
+
/**
|
|
1730
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
1731
|
+
* transaction's presentment currency.
|
|
1732
|
+
*/
|
|
1733
|
+
presentment_currency: string;
|
|
1734
|
+
/**
|
|
1735
|
+
* The processing category describes the intent behind the financial, such as
|
|
1736
|
+
* whether it was used for bill payments or an automatic fuel dispenser.
|
|
1737
|
+
*
|
|
1738
|
+
* - `account_funding` - Account funding transactions are transactions used to
|
|
1739
|
+
* e.g., fund an account or transfer funds between accounts.
|
|
1740
|
+
* - `automatic_fuel_dispenser` - Automatic fuel dispenser authorizations occur
|
|
1741
|
+
* when a card is used at a gas pump, prior to the actual transaction amount
|
|
1742
|
+
* being known. They are followed by an advice message that updates the amount of
|
|
1743
|
+
* the pending transaction.
|
|
1744
|
+
* - `bill_payment` - A transaction used to pay a bill.
|
|
1745
|
+
* - `original_credit` - Original credit transactions are used to send money to a
|
|
1746
|
+
* cardholder.
|
|
1747
|
+
* - `purchase` - A regular purchase.
|
|
1748
|
+
* - `quasi_cash` - Quasi-cash transactions represent purchases of items which may
|
|
1749
|
+
* be convertible to cash.
|
|
1750
|
+
* - `refund` - A refund card authorization, sometimes referred to as a credit
|
|
1751
|
+
* voucher authorization, where funds are credited to the cardholder.
|
|
1752
|
+
* - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
|
|
1753
|
+
* from an ATM or a point of sale.
|
|
1754
|
+
* - `unknown` - The processing category is unknown.
|
|
1755
|
+
*/
|
|
1756
|
+
processing_category: 'account_funding' | 'automatic_fuel_dispenser' | 'bill_payment' | 'original_credit' | 'purchase' | 'quasi_cash' | 'refund' | 'cash_disbursement' | 'unknown';
|
|
1757
|
+
/**
|
|
1758
|
+
* The identifier of the Real-Time Decision sent to approve or decline this
|
|
1759
|
+
* transaction.
|
|
1760
|
+
*/
|
|
1761
|
+
real_time_decision_id: string | null;
|
|
1762
|
+
/**
|
|
1763
|
+
* The terminal identifier (commonly abbreviated as TID) of the terminal the card
|
|
1764
|
+
* is transacting with.
|
|
1765
|
+
*/
|
|
1766
|
+
terminal_id: string | null;
|
|
1767
|
+
/**
|
|
1768
|
+
* The identifier of the Transaction associated with this Transaction.
|
|
1769
|
+
*/
|
|
1770
|
+
transaction_id: string;
|
|
1771
|
+
/**
|
|
1772
|
+
* A constant representing the object's type. For this resource it will always be
|
|
1773
|
+
* `card_financial`.
|
|
1774
|
+
*/
|
|
1775
|
+
type: 'card_financial';
|
|
1776
|
+
/**
|
|
1777
|
+
* Fields related to verification of cardholder-provided values.
|
|
1778
|
+
*/
|
|
1779
|
+
verification: CardFinancial.Verification;
|
|
1780
|
+
}
|
|
1781
|
+
namespace CardFinancial {
|
|
1782
|
+
/**
|
|
1783
|
+
* Additional amounts associated with the card authorization, such as ATM
|
|
1784
|
+
* surcharges fees. These are usually a subset of the `amount` field and are used
|
|
1785
|
+
* to provide more detailed information about the transaction.
|
|
1786
|
+
*/
|
|
1787
|
+
interface AdditionalAmounts {
|
|
1788
|
+
/**
|
|
1789
|
+
* The part of this transaction amount that was for clinic-related services.
|
|
1790
|
+
*/
|
|
1791
|
+
clinic: AdditionalAmounts.Clinic | null;
|
|
1792
|
+
/**
|
|
1793
|
+
* The part of this transaction amount that was for dental-related services.
|
|
1794
|
+
*/
|
|
1795
|
+
dental: AdditionalAmounts.Dental | null;
|
|
1796
|
+
/**
|
|
1797
|
+
* The original pre-authorized amount.
|
|
1798
|
+
*/
|
|
1799
|
+
original: AdditionalAmounts.Original | null;
|
|
1800
|
+
/**
|
|
1801
|
+
* The part of this transaction amount that was for healthcare prescriptions.
|
|
1802
|
+
*/
|
|
1803
|
+
prescription: AdditionalAmounts.Prescription | null;
|
|
1804
|
+
/**
|
|
1805
|
+
* The surcharge amount charged for this transaction by the merchant.
|
|
1806
|
+
*/
|
|
1807
|
+
surcharge: AdditionalAmounts.Surcharge | null;
|
|
1808
|
+
/**
|
|
1809
|
+
* The total amount of a series of incremental authorizations, optionally provided.
|
|
1810
|
+
*/
|
|
1811
|
+
total_cumulative: AdditionalAmounts.TotalCumulative | null;
|
|
1812
|
+
/**
|
|
1813
|
+
* The total amount of healthcare-related additional amounts.
|
|
1814
|
+
*/
|
|
1815
|
+
total_healthcare: AdditionalAmounts.TotalHealthcare | null;
|
|
1816
|
+
/**
|
|
1817
|
+
* The part of this transaction amount that was for transit-related services.
|
|
1818
|
+
*/
|
|
1819
|
+
transit: AdditionalAmounts.Transit | null;
|
|
1820
|
+
/**
|
|
1821
|
+
* An unknown additional amount.
|
|
1822
|
+
*/
|
|
1823
|
+
unknown: AdditionalAmounts.Unknown | null;
|
|
1824
|
+
/**
|
|
1825
|
+
* The part of this transaction amount that was for vision-related services.
|
|
1826
|
+
*/
|
|
1827
|
+
vision: AdditionalAmounts.Vision | null;
|
|
1828
|
+
}
|
|
1829
|
+
namespace AdditionalAmounts {
|
|
1830
|
+
/**
|
|
1831
|
+
* The part of this transaction amount that was for clinic-related services.
|
|
1832
|
+
*/
|
|
1833
|
+
interface Clinic {
|
|
1834
|
+
/**
|
|
1835
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1836
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1837
|
+
* subtracted from the amount (such as a discount).
|
|
1838
|
+
*/
|
|
1839
|
+
amount: number;
|
|
1840
|
+
/**
|
|
1841
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1842
|
+
* amount's currency.
|
|
1843
|
+
*/
|
|
1844
|
+
currency: string;
|
|
1845
|
+
}
|
|
1846
|
+
/**
|
|
1847
|
+
* The part of this transaction amount that was for dental-related services.
|
|
1848
|
+
*/
|
|
1849
|
+
interface Dental {
|
|
1850
|
+
/**
|
|
1851
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1852
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1853
|
+
* subtracted from the amount (such as a discount).
|
|
1854
|
+
*/
|
|
1855
|
+
amount: number;
|
|
1856
|
+
/**
|
|
1857
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1858
|
+
* amount's currency.
|
|
1859
|
+
*/
|
|
1860
|
+
currency: string;
|
|
1861
|
+
}
|
|
1862
|
+
/**
|
|
1863
|
+
* The original pre-authorized amount.
|
|
1864
|
+
*/
|
|
1865
|
+
interface Original {
|
|
1866
|
+
/**
|
|
1867
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1868
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1869
|
+
* subtracted from the amount (such as a discount).
|
|
1870
|
+
*/
|
|
1871
|
+
amount: number;
|
|
1872
|
+
/**
|
|
1873
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1874
|
+
* amount's currency.
|
|
1875
|
+
*/
|
|
1876
|
+
currency: string;
|
|
1877
|
+
}
|
|
1878
|
+
/**
|
|
1879
|
+
* The part of this transaction amount that was for healthcare prescriptions.
|
|
1880
|
+
*/
|
|
1881
|
+
interface Prescription {
|
|
1882
|
+
/**
|
|
1883
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1884
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1885
|
+
* subtracted from the amount (such as a discount).
|
|
1886
|
+
*/
|
|
1887
|
+
amount: number;
|
|
1888
|
+
/**
|
|
1889
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1890
|
+
* amount's currency.
|
|
1891
|
+
*/
|
|
1892
|
+
currency: string;
|
|
1893
|
+
}
|
|
1894
|
+
/**
|
|
1895
|
+
* The surcharge amount charged for this transaction by the merchant.
|
|
1896
|
+
*/
|
|
1897
|
+
interface Surcharge {
|
|
1898
|
+
/**
|
|
1899
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1900
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1901
|
+
* subtracted from the amount (such as a discount).
|
|
1902
|
+
*/
|
|
1903
|
+
amount: number;
|
|
1904
|
+
/**
|
|
1905
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1906
|
+
* amount's currency.
|
|
1907
|
+
*/
|
|
1908
|
+
currency: string;
|
|
1909
|
+
}
|
|
1910
|
+
/**
|
|
1911
|
+
* The total amount of a series of incremental authorizations, optionally provided.
|
|
1912
|
+
*/
|
|
1913
|
+
interface TotalCumulative {
|
|
1914
|
+
/**
|
|
1915
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1916
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1917
|
+
* subtracted from the amount (such as a discount).
|
|
1918
|
+
*/
|
|
1919
|
+
amount: number;
|
|
1920
|
+
/**
|
|
1921
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1922
|
+
* amount's currency.
|
|
1923
|
+
*/
|
|
1924
|
+
currency: string;
|
|
1925
|
+
}
|
|
1926
|
+
/**
|
|
1927
|
+
* The total amount of healthcare-related additional amounts.
|
|
1928
|
+
*/
|
|
1929
|
+
interface TotalHealthcare {
|
|
1930
|
+
/**
|
|
1931
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1932
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1933
|
+
* subtracted from the amount (such as a discount).
|
|
1934
|
+
*/
|
|
1935
|
+
amount: number;
|
|
1936
|
+
/**
|
|
1937
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1938
|
+
* amount's currency.
|
|
1939
|
+
*/
|
|
1940
|
+
currency: string;
|
|
1941
|
+
}
|
|
1942
|
+
/**
|
|
1943
|
+
* The part of this transaction amount that was for transit-related services.
|
|
1944
|
+
*/
|
|
1945
|
+
interface Transit {
|
|
1946
|
+
/**
|
|
1947
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1948
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1949
|
+
* subtracted from the amount (such as a discount).
|
|
1950
|
+
*/
|
|
1951
|
+
amount: number;
|
|
1952
|
+
/**
|
|
1953
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1954
|
+
* amount's currency.
|
|
1955
|
+
*/
|
|
1956
|
+
currency: string;
|
|
1957
|
+
}
|
|
1958
|
+
/**
|
|
1959
|
+
* An unknown additional amount.
|
|
1960
|
+
*/
|
|
1961
|
+
interface Unknown {
|
|
1962
|
+
/**
|
|
1963
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1964
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1965
|
+
* subtracted from the amount (such as a discount).
|
|
1966
|
+
*/
|
|
1967
|
+
amount: number;
|
|
1968
|
+
/**
|
|
1969
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1970
|
+
* amount's currency.
|
|
1971
|
+
*/
|
|
1972
|
+
currency: string;
|
|
1973
|
+
}
|
|
1974
|
+
/**
|
|
1975
|
+
* The part of this transaction amount that was for vision-related services.
|
|
1976
|
+
*/
|
|
1977
|
+
interface Vision {
|
|
1978
|
+
/**
|
|
1979
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1980
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1981
|
+
* subtracted from the amount (such as a discount).
|
|
1982
|
+
*/
|
|
1983
|
+
amount: number;
|
|
1984
|
+
/**
|
|
1985
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1986
|
+
* amount's currency.
|
|
1987
|
+
*/
|
|
1988
|
+
currency: string;
|
|
1989
|
+
}
|
|
1990
|
+
}
|
|
1991
|
+
/**
|
|
1992
|
+
* Fields specific to the `network`.
|
|
1993
|
+
*/
|
|
1994
|
+
interface NetworkDetails {
|
|
1995
|
+
/**
|
|
1996
|
+
* The payment network used to process this card authorization.
|
|
1997
|
+
*
|
|
1998
|
+
* - `visa` - Visa
|
|
1999
|
+
* - `pulse` - Pulse
|
|
2000
|
+
*/
|
|
2001
|
+
category: 'visa' | 'pulse';
|
|
2002
|
+
/**
|
|
2003
|
+
* Fields specific to the `pulse` network.
|
|
2004
|
+
*/
|
|
2005
|
+
pulse: unknown | null;
|
|
2006
|
+
/**
|
|
2007
|
+
* Fields specific to the `visa` network.
|
|
2008
|
+
*/
|
|
2009
|
+
visa: NetworkDetails.Visa | null;
|
|
2010
|
+
}
|
|
2011
|
+
namespace NetworkDetails {
|
|
2012
|
+
/**
|
|
2013
|
+
* Fields specific to the `visa` network.
|
|
2014
|
+
*/
|
|
2015
|
+
interface Visa {
|
|
2016
|
+
/**
|
|
2017
|
+
* For electronic commerce transactions, this identifies the level of security used
|
|
2018
|
+
* in obtaining the customer's payment credential. For mail or telephone order
|
|
2019
|
+
* transactions, identifies the type of mail or telephone order.
|
|
2020
|
+
*
|
|
2021
|
+
* - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
|
|
2022
|
+
* that the transaction is a mail/phone order purchase, not a recurring
|
|
2023
|
+
* transaction or installment payment. For domestic transactions in the US
|
|
2024
|
+
* region, this value may also indicate one bill payment transaction in the
|
|
2025
|
+
* card-present or card-absent environments.
|
|
2026
|
+
* - `recurring` - Recurring transaction: Payment indicator used to indicate a
|
|
2027
|
+
* recurring transaction that originates from an acquirer in the US region.
|
|
2028
|
+
* - `installment` - Installment payment: Payment indicator used to indicate one
|
|
2029
|
+
* purchase of goods or services that is billed to the account in multiple
|
|
2030
|
+
* charges over a period of time agreed upon by the cardholder and merchant from
|
|
2031
|
+
* transactions that originate from an acquirer in the US region.
|
|
2032
|
+
* - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
|
|
2033
|
+
* indicate that the type of mail/telephone order is unknown.
|
|
2034
|
+
* - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
|
|
2035
|
+
* indicate that the electronic commerce transaction has been authenticated using
|
|
2036
|
+
* e.g., 3-D Secure
|
|
2037
|
+
* - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
|
|
2038
|
+
* Non-authenticated security transaction at a 3-D Secure-capable merchant, and
|
|
2039
|
+
* merchant attempted to authenticate the cardholder using 3-D Secure: Use to
|
|
2040
|
+
* identify an electronic commerce transaction where the merchant attempted to
|
|
2041
|
+
* authenticate the cardholder using 3-D Secure, but was unable to complete the
|
|
2042
|
+
* authentication because the issuer or cardholder does not participate in the
|
|
2043
|
+
* 3-D Secure program.
|
|
2044
|
+
* - `non_authenticated_security_transaction` - Non-authenticated security
|
|
2045
|
+
* transaction: Use to identify an electronic commerce transaction that uses data
|
|
2046
|
+
* encryption for security however, cardholder authentication is not performed
|
|
2047
|
+
* using 3-D Secure.
|
|
2048
|
+
* - `non_secure_transaction` - Non-secure transaction: Use to identify an
|
|
2049
|
+
* electronic commerce transaction that has no data protection.
|
|
2050
|
+
*/
|
|
2051
|
+
electronic_commerce_indicator: 'mail_phone_order' | 'recurring' | 'installment' | 'unknown_mail_phone_order' | 'secure_electronic_commerce' | 'non_authenticated_security_transaction_at_3ds_capable_merchant' | 'non_authenticated_security_transaction' | 'non_secure_transaction' | null;
|
|
2052
|
+
/**
|
|
2053
|
+
* The method used to enter the cardholder's primary account number and card
|
|
2054
|
+
* expiration date.
|
|
2055
|
+
*
|
|
2056
|
+
* - `unknown` - Unknown
|
|
2057
|
+
* - `manual` - Manual key entry
|
|
2058
|
+
* - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
|
|
2059
|
+
* value
|
|
2060
|
+
* - `optical_code` - Optical code
|
|
2061
|
+
* - `integrated_circuit_card` - Contact chip card
|
|
2062
|
+
* - `contactless` - Contactless read of chip card
|
|
2063
|
+
* - `credential_on_file` - Transaction initiated using a credential that has
|
|
2064
|
+
* previously been stored on file
|
|
2065
|
+
* - `magnetic_stripe` - Magnetic stripe read
|
|
2066
|
+
* - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
|
|
2067
|
+
* - `integrated_circuit_card_no_cvv` - Contact chip card, without card
|
|
2068
|
+
* verification value
|
|
2069
|
+
*/
|
|
2070
|
+
point_of_service_entry_mode: 'unknown' | 'manual' | 'magnetic_stripe_no_cvv' | 'optical_code' | 'integrated_circuit_card' | 'contactless' | 'credential_on_file' | 'magnetic_stripe' | 'contactless_magnetic_stripe' | 'integrated_circuit_card_no_cvv' | null;
|
|
2071
|
+
/**
|
|
2072
|
+
* Only present when `actioner: network`. Describes why a card authorization was
|
|
2073
|
+
* approved or declined by Visa through stand-in processing.
|
|
2074
|
+
*
|
|
2075
|
+
* - `issuer_error` - Increase failed to process the authorization in a timely
|
|
2076
|
+
* manner.
|
|
2077
|
+
* - `invalid_physical_card` - The physical card read had an invalid CVV, dCVV, or
|
|
2078
|
+
* authorization request cryptogram.
|
|
2079
|
+
* - `invalid_cardholder_authentication_verification_value` - The 3DS cardholder
|
|
2080
|
+
* authentication verification value was invalid.
|
|
2081
|
+
* - `internal_visa_error` - An internal Visa error occurred. Visa uses this reason
|
|
2082
|
+
* code for certain expected occurrences as well, such as Application Transaction
|
|
2083
|
+
* Counter (ATC) replays.
|
|
2084
|
+
* - `merchant_transaction_advisory_service_authentication_required` - The merchant
|
|
2085
|
+
* has enabled Visa's Transaction Advisory Service and requires further
|
|
2086
|
+
* authentication to perform the transaction. In practice this is often utilized
|
|
2087
|
+
* at fuel pumps to tell the cardholder to see the cashier.
|
|
2088
|
+
* - `payment_fraud_disruption_acquirer_block` - The transaction was blocked by
|
|
2089
|
+
* Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior,
|
|
2090
|
+
* such as card testing.
|
|
2091
|
+
* - `other` - An unspecific reason for stand-in processing.
|
|
2092
|
+
*/
|
|
2093
|
+
stand_in_processing_reason: 'issuer_error' | 'invalid_physical_card' | 'invalid_cardholder_authentication_verification_value' | 'internal_visa_error' | 'merchant_transaction_advisory_service_authentication_required' | 'payment_fraud_disruption_acquirer_block' | 'other' | null;
|
|
2094
|
+
}
|
|
2095
|
+
}
|
|
2096
|
+
/**
|
|
2097
|
+
* Network-specific identifiers for a specific request or transaction.
|
|
2098
|
+
*/
|
|
2099
|
+
interface NetworkIdentifiers {
|
|
2100
|
+
/**
|
|
2101
|
+
* The randomly generated 6-character Authorization Identification Response code
|
|
2102
|
+
* sent back to the acquirer in an approved response.
|
|
2103
|
+
*/
|
|
2104
|
+
authorization_identification_response: string | null;
|
|
2105
|
+
/**
|
|
2106
|
+
* A life-cycle identifier used across e.g., an authorization and a reversal.
|
|
2107
|
+
* Expected to be unique per acquirer within a window of time. For some card
|
|
2108
|
+
* networks the retrieval reference number includes the trace counter.
|
|
2109
|
+
*/
|
|
2110
|
+
retrieval_reference_number: string | null;
|
|
2111
|
+
/**
|
|
2112
|
+
* A counter used to verify an individual authorization. Expected to be unique per
|
|
2113
|
+
* acquirer within a window of time.
|
|
2114
|
+
*/
|
|
2115
|
+
trace_number: string | null;
|
|
2116
|
+
/**
|
|
2117
|
+
* A globally unique transaction identifier provided by the card network, used
|
|
2118
|
+
* across multiple life-cycle requests.
|
|
2119
|
+
*/
|
|
2120
|
+
transaction_id: string | null;
|
|
2121
|
+
}
|
|
2122
|
+
/**
|
|
2123
|
+
* Fields related to verification of cardholder-provided values.
|
|
2124
|
+
*/
|
|
2125
|
+
interface Verification {
|
|
2126
|
+
/**
|
|
2127
|
+
* Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
2128
|
+
* the back of the card.
|
|
2129
|
+
*/
|
|
2130
|
+
card_verification_code: Verification.CardVerificationCode;
|
|
2131
|
+
/**
|
|
2132
|
+
* Cardholder address provided in the authorization request and the address on file
|
|
2133
|
+
* we verified it against.
|
|
2134
|
+
*/
|
|
2135
|
+
cardholder_address: Verification.CardholderAddress;
|
|
2136
|
+
}
|
|
2137
|
+
namespace Verification {
|
|
2138
|
+
/**
|
|
2139
|
+
* Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
2140
|
+
* the back of the card.
|
|
2141
|
+
*/
|
|
2142
|
+
interface CardVerificationCode {
|
|
2143
|
+
/**
|
|
2144
|
+
* The result of verifying the Card Verification Code.
|
|
2145
|
+
*
|
|
2146
|
+
* - `not_checked` - No card verification code was provided in the authorization
|
|
2147
|
+
* request.
|
|
2148
|
+
* - `match` - The card verification code matched the one on file.
|
|
2149
|
+
* - `no_match` - The card verification code did not match the one on file.
|
|
2150
|
+
*/
|
|
2151
|
+
result: 'not_checked' | 'match' | 'no_match';
|
|
2152
|
+
}
|
|
2153
|
+
/**
|
|
2154
|
+
* Cardholder address provided in the authorization request and the address on file
|
|
2155
|
+
* we verified it against.
|
|
2156
|
+
*/
|
|
2157
|
+
interface CardholderAddress {
|
|
2158
|
+
/**
|
|
2159
|
+
* Line 1 of the address on file for the cardholder.
|
|
2160
|
+
*/
|
|
2161
|
+
actual_line1: string | null;
|
|
2162
|
+
/**
|
|
2163
|
+
* The postal code of the address on file for the cardholder.
|
|
2164
|
+
*/
|
|
2165
|
+
actual_postal_code: string | null;
|
|
2166
|
+
/**
|
|
2167
|
+
* The cardholder address line 1 provided for verification in the authorization
|
|
2168
|
+
* request.
|
|
2169
|
+
*/
|
|
2170
|
+
provided_line1: string | null;
|
|
2171
|
+
/**
|
|
2172
|
+
* The postal code provided for verification in the authorization request.
|
|
2173
|
+
*/
|
|
2174
|
+
provided_postal_code: string | null;
|
|
2175
|
+
/**
|
|
2176
|
+
* The address verification result returned to the card network.
|
|
2177
|
+
*
|
|
2178
|
+
* - `not_checked` - No address information was provided in the authorization
|
|
2179
|
+
* request.
|
|
2180
|
+
* - `postal_code_match_address_no_match` - Postal code matches, but the street
|
|
2181
|
+
* address does not match or was not provided.
|
|
2182
|
+
* - `postal_code_no_match_address_match` - Postal code does not match, but the
|
|
2183
|
+
* street address matches or was not provided.
|
|
2184
|
+
* - `match` - Postal code and street address match.
|
|
2185
|
+
* - `no_match` - Postal code and street address do not match.
|
|
2186
|
+
* - `postal_code_match_address_not_checked` - Postal code matches, but the street
|
|
2187
|
+
* address was not verified. (deprecated)
|
|
2188
|
+
*/
|
|
2189
|
+
result: 'not_checked' | 'postal_code_match_address_no_match' | 'postal_code_no_match_address_match' | 'match' | 'no_match' | 'postal_code_match_address_not_checked';
|
|
2190
|
+
}
|
|
2191
|
+
}
|
|
2192
|
+
}
|
|
1605
2193
|
/**
|
|
1606
2194
|
* A Card Fuel Confirmation object. This field will be present in the JSON response
|
|
1607
2195
|
* if and only if `category` is equal to `card_fuel_confirmation`. Card Fuel
|