increase 0.8.0 → 0.8.1

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.
Files changed (219) hide show
  1. package/CHANGELOG.md +40 -0
  2. package/README.md +8 -4
  3. package/_shims/ReadableStream.d.ts +38 -0
  4. package/_shims/ReadableStream.js +5 -0
  5. package/_shims/ReadableStream.mjs +7 -0
  6. package/_shims/ReadableStream.node.d.ts +6 -0
  7. package/_shims/ReadableStream.node.d.ts.map +1 -0
  8. package/_shims/ReadableStream.node.js +14 -0
  9. package/_shims/ReadableStream.node.js.map +1 -0
  10. package/_shims/ReadableStream.node.mjs +3 -0
  11. package/_shims/ReadableStream.node.mjs.map +1 -0
  12. package/core.d.ts +10 -0
  13. package/core.d.ts.map +1 -1
  14. package/core.js +96 -2
  15. package/core.js.map +1 -1
  16. package/core.mjs +86 -2
  17. package/core.mjs.map +1 -1
  18. package/error.d.ts +1 -0
  19. package/error.d.ts.map +1 -1
  20. package/error.js +12 -3
  21. package/error.js.map +1 -1
  22. package/error.mjs +12 -3
  23. package/error.mjs.map +1 -1
  24. package/index.d.mts +6 -1
  25. package/index.d.ts +6 -1
  26. package/index.d.ts.map +1 -1
  27. package/index.js +11 -8
  28. package/index.js.map +1 -1
  29. package/index.mjs +11 -8
  30. package/index.mjs.map +1 -1
  31. package/package.json +1 -1
  32. package/resources/account-numbers.d.ts.map +1 -1
  33. package/resources/account-statements.d.ts.map +1 -1
  34. package/resources/account-transfers.d.ts.map +1 -1
  35. package/resources/accounts.d.ts.map +1 -1
  36. package/resources/ach-prenotifications.d.ts.map +1 -1
  37. package/resources/ach-transfers.d.ts.map +1 -1
  38. package/resources/balance-lookups.d.ts.map +1 -1
  39. package/resources/bookkeeping-accounts.d.ts.map +1 -1
  40. package/resources/bookkeeping-entries.d.ts.map +1 -1
  41. package/resources/bookkeeping-entry-sets.d.ts.map +1 -1
  42. package/resources/card-disputes.d.ts.map +1 -1
  43. package/resources/card-profiles.d.ts +17 -4
  44. package/resources/card-profiles.d.ts.map +1 -1
  45. package/resources/card-profiles.js.map +1 -1
  46. package/resources/card-profiles.mjs.map +1 -1
  47. package/resources/card-purchase-supplements.d.ts +270 -0
  48. package/resources/card-purchase-supplements.d.ts.map +1 -0
  49. package/resources/card-purchase-supplements.js +28 -0
  50. package/resources/card-purchase-supplements.js.map +1 -0
  51. package/resources/card-purchase-supplements.mjs +21 -0
  52. package/resources/card-purchase-supplements.mjs.map +1 -0
  53. package/resources/cards.d.ts.map +1 -1
  54. package/resources/check-deposits.d.ts.map +1 -1
  55. package/resources/check-transfers.d.ts +3 -1
  56. package/resources/check-transfers.d.ts.map +1 -1
  57. package/resources/check-transfers.js.map +1 -1
  58. package/resources/check-transfers.mjs.map +1 -1
  59. package/resources/declined-transactions.d.ts.map +1 -1
  60. package/resources/digital-wallet-tokens.d.ts.map +1 -1
  61. package/resources/documents.d.ts.map +1 -1
  62. package/resources/entities/beneficial-owners.d.ts +219 -0
  63. package/resources/entities/beneficial-owners.d.ts.map +1 -0
  64. package/resources/entities/beneficial-owners.js +18 -0
  65. package/resources/entities/beneficial-owners.js.map +1 -0
  66. package/resources/entities/beneficial-owners.mjs +12 -0
  67. package/resources/entities/beneficial-owners.mjs.map +1 -0
  68. package/resources/entities/entities.d.ts +4 -0
  69. package/resources/entities/entities.d.ts.map +1 -1
  70. package/resources/entities/entities.js +3 -0
  71. package/resources/entities/entities.js.map +1 -1
  72. package/resources/entities/entities.mjs +3 -0
  73. package/resources/entities/entities.mjs.map +1 -1
  74. package/resources/entities/index.d.ts +1 -0
  75. package/resources/entities/index.d.ts.map +1 -1
  76. package/resources/entities/index.js +8 -0
  77. package/resources/entities/index.js.map +1 -1
  78. package/resources/entities/index.mjs +1 -0
  79. package/resources/entities/index.mjs.map +1 -1
  80. package/resources/entities/supplemental-documents.d.ts.map +1 -1
  81. package/resources/event-subscriptions.d.ts.map +1 -1
  82. package/resources/events.d.ts.map +1 -1
  83. package/resources/exports.d.ts.map +1 -1
  84. package/resources/external-accounts.d.ts.map +1 -1
  85. package/resources/files.d.ts.map +1 -1
  86. package/resources/groups.d.ts.map +1 -1
  87. package/resources/inbound-ach-transfer-returns.d.ts.map +1 -1
  88. package/resources/inbound-wire-drawdown-requests.d.ts.map +1 -1
  89. package/resources/index.d.ts +6 -0
  90. package/resources/index.d.ts.map +1 -1
  91. package/resources/index.js +18 -3
  92. package/resources/index.js.map +1 -1
  93. package/resources/index.mjs +1 -0
  94. package/resources/index.mjs.map +1 -1
  95. package/resources/limits.d.ts.map +1 -1
  96. package/resources/oauth-connections.d.ts.map +1 -1
  97. package/resources/pending-transactions.d.ts +4 -0
  98. package/resources/pending-transactions.d.ts.map +1 -1
  99. package/resources/pending-transactions.js.map +1 -1
  100. package/resources/pending-transactions.mjs.map +1 -1
  101. package/resources/programs.d.ts.map +1 -1
  102. package/resources/real-time-decisions.d.ts.map +1 -1
  103. package/resources/real-time-payments-transfers.d.ts.map +1 -1
  104. package/resources/routing-numbers.d.ts.map +1 -1
  105. package/resources/simulations/account-statements.d.ts.map +1 -1
  106. package/resources/simulations/ach-transfers.d.ts +939 -19
  107. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  108. package/resources/simulations/ach-transfers.js.map +1 -1
  109. package/resources/simulations/ach-transfers.mjs.map +1 -1
  110. package/resources/simulations/card-disputes.d.ts.map +1 -1
  111. package/resources/simulations/card-refunds.d.ts.map +1 -1
  112. package/resources/simulations/cards.d.ts +4 -0
  113. package/resources/simulations/cards.d.ts.map +1 -1
  114. package/resources/simulations/cards.js.map +1 -1
  115. package/resources/simulations/cards.mjs.map +1 -1
  116. package/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -1
  117. package/resources/simulations/documents.d.ts.map +1 -1
  118. package/resources/simulations/inbound-funds-holds.d.ts +4 -0
  119. package/resources/simulations/inbound-funds-holds.d.ts.map +1 -1
  120. package/resources/simulations/inbound-funds-holds.js.map +1 -1
  121. package/resources/simulations/inbound-funds-holds.mjs.map +1 -1
  122. package/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -1
  123. package/resources/simulations/interest-payments.d.ts +947 -19
  124. package/resources/simulations/interest-payments.d.ts.map +1 -1
  125. package/resources/simulations/interest-payments.js.map +1 -1
  126. package/resources/simulations/interest-payments.mjs.map +1 -1
  127. package/resources/simulations/programs.d.ts.map +1 -1
  128. package/resources/simulations/real-time-payments-transfers.d.ts +939 -19
  129. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  130. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  131. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  132. package/resources/simulations/simulations.d.ts.map +1 -1
  133. package/resources/simulations/simulations.js.map +1 -1
  134. package/resources/simulations/wire-transfers.d.ts +939 -19
  135. package/resources/simulations/wire-transfers.d.ts.map +1 -1
  136. package/resources/simulations/wire-transfers.js.map +1 -1
  137. package/resources/simulations/wire-transfers.mjs.map +1 -1
  138. package/resources/transactions.d.ts +939 -20
  139. package/resources/transactions.d.ts.map +1 -1
  140. package/resources/transactions.js.map +1 -1
  141. package/resources/transactions.mjs.map +1 -1
  142. package/resources/wire-drawdown-requests.d.ts.map +1 -1
  143. package/resources/wire-transfers.d.ts.map +1 -1
  144. package/src/_shims/ReadableStream.d.ts +38 -0
  145. package/src/_shims/ReadableStream.js +5 -0
  146. package/src/_shims/ReadableStream.mjs +7 -0
  147. package/src/_shims/ReadableStream.node.ts +6 -0
  148. package/src/_shims/fetch.deno.ts +23 -0
  149. package/src/_shims/formdata.deno.ts +16 -0
  150. package/src/core.ts +103 -4
  151. package/src/error.ts +11 -1
  152. package/src/index.ts +16 -9
  153. package/src/resources/account-numbers.ts +1 -1
  154. package/src/resources/account-statements.ts +1 -1
  155. package/src/resources/account-transfers.ts +1 -1
  156. package/src/resources/accounts.ts +1 -1
  157. package/src/resources/ach-prenotifications.ts +1 -1
  158. package/src/resources/ach-transfers.ts +1 -1
  159. package/src/resources/balance-lookups.ts +1 -1
  160. package/src/resources/bookkeeping-accounts.ts +1 -1
  161. package/src/resources/bookkeeping-entries.ts +1 -1
  162. package/src/resources/bookkeeping-entry-sets.ts +1 -1
  163. package/src/resources/card-disputes.ts +1 -1
  164. package/src/resources/card-profiles.ts +19 -5
  165. package/src/resources/card-purchase-supplements.ts +331 -0
  166. package/src/resources/cards.ts +1 -1
  167. package/src/resources/check-deposits.ts +1 -1
  168. package/src/resources/check-transfers.ts +4 -2
  169. package/src/resources/declined-transactions.ts +1 -1
  170. package/src/resources/digital-wallet-tokens.ts +1 -1
  171. package/src/resources/documents.ts +1 -1
  172. package/src/resources/entities/beneficial-owners.ts +255 -0
  173. package/src/resources/entities/entities.ts +6 -1
  174. package/src/resources/entities/index.ts +1 -0
  175. package/src/resources/entities/supplemental-documents.ts +1 -1
  176. package/src/resources/event-subscriptions.ts +1 -1
  177. package/src/resources/events.ts +1 -1
  178. package/src/resources/exports.ts +1 -1
  179. package/src/resources/external-accounts.ts +1 -1
  180. package/src/resources/files.ts +1 -1
  181. package/src/resources/groups.ts +1 -1
  182. package/src/resources/inbound-ach-transfer-returns.ts +1 -1
  183. package/src/resources/inbound-wire-drawdown-requests.ts +1 -1
  184. package/src/resources/index.ts +6 -0
  185. package/src/resources/limits.ts +1 -1
  186. package/src/resources/oauth-connections.ts +1 -1
  187. package/src/resources/pending-transactions.ts +6 -1
  188. package/src/resources/programs.ts +1 -1
  189. package/src/resources/real-time-decisions.ts +1 -1
  190. package/src/resources/real-time-payments-transfers.ts +1 -1
  191. package/src/resources/routing-numbers.ts +1 -1
  192. package/src/resources/simulations/account-statements.ts +1 -1
  193. package/src/resources/simulations/ach-transfers.ts +1076 -22
  194. package/src/resources/simulations/card-disputes.ts +1 -1
  195. package/src/resources/simulations/card-refunds.ts +1 -1
  196. package/src/resources/simulations/cards.ts +6 -1
  197. package/src/resources/simulations/digital-wallet-token-requests.ts +1 -1
  198. package/src/resources/simulations/documents.ts +1 -1
  199. package/src/resources/simulations/inbound-funds-holds.ts +6 -1
  200. package/src/resources/simulations/inbound-wire-drawdown-requests.ts +1 -1
  201. package/src/resources/simulations/interest-payments.ts +1086 -22
  202. package/src/resources/simulations/programs.ts +1 -1
  203. package/src/resources/simulations/real-time-payments-transfers.ts +1076 -22
  204. package/src/resources/simulations/simulations.ts +1 -1
  205. package/src/resources/simulations/wire-transfers.ts +1076 -22
  206. package/src/resources/transactions.ts +1076 -23
  207. package/src/resources/wire-drawdown-requests.ts +1 -1
  208. package/src/resources/wire-transfers.ts +1 -1
  209. package/src/uploads.ts +7 -6
  210. package/src/version.ts +1 -1
  211. package/uploads.d.ts +5 -4
  212. package/uploads.d.ts.map +1 -1
  213. package/uploads.js +2 -2
  214. package/uploads.js.map +1 -1
  215. package/uploads.mjs +2 -2
  216. package/uploads.mjs.map +1 -1
  217. package/version.d.ts +1 -1
  218. package/version.js +1 -1
  219. package/version.mjs +1 -1
@@ -4,7 +4,7 @@ import * as Core from '../../core';
4
4
  import { APIResource } from '../../resource';
5
5
  import * as RealTimePaymentsTransfers_ from '../real-time-payments-transfers';
6
6
  import * as Shared from '../shared';
7
- import * as API from '.';
7
+ import * as API from './index';
8
8
 
9
9
  export class RealTimePaymentsTransfers extends APIResource {
10
10
  /**
@@ -910,8 +910,6 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
910
910
  * Deposit object. Details will be under the `check_transfer_deposit` object.
911
911
  * - `check_transfer_intention` - The Transaction was created by a Check Transfer
912
912
  * Intention object. Details will be under the `check_transfer_intention` object.
913
- * - `check_transfer_rejection` - The Transaction was created by a Check Transfer
914
- * Rejection object. Details will be under the `check_transfer_rejection` object.
915
913
  * - `check_transfer_stop_payment_request` - The Transaction was created by a Check
916
914
  * Transfer Stop Payment Request object. Details will be under the
917
915
  * `check_transfer_stop_payment_request` object.
@@ -968,7 +966,6 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
968
966
  | 'check_deposit_return'
969
967
  | 'check_transfer_deposit'
970
968
  | 'check_transfer_intention'
971
- | 'check_transfer_rejection'
972
969
  | 'check_transfer_stop_payment_request'
973
970
  | 'fee_payment'
974
971
  | 'inbound_ach_transfer'
@@ -1012,12 +1009,6 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1012
1009
  */
1013
1010
  check_transfer_intention: Source.CheckTransferIntention | null;
1014
1011
 
1015
- /**
1016
- * A Check Transfer Rejection object. This field will be present in the JSON
1017
- * response if and only if `category` is equal to `check_transfer_rejection`.
1018
- */
1019
- check_transfer_rejection: Source.CheckTransferRejection | null;
1020
-
1021
1012
  /**
1022
1013
  * A Check Transfer Stop Payment Request object. This field will be present in the
1023
1014
  * JSON response if and only if `category` is equal to
@@ -1530,6 +1521,12 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1530
1521
  */
1531
1522
  merchant_state: string | null;
1532
1523
 
1524
+ /**
1525
+ * Additional details about the card purchase, such as tax and industry-specific
1526
+ * fields.
1527
+ */
1528
+ purchase_details: CardRefund.PurchaseDetails | null;
1529
+
1533
1530
  /**
1534
1531
  * The identifier of the Transaction associated with this Transaction.
1535
1532
  */
@@ -1542,6 +1539,535 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1542
1539
  type: 'card_refund';
1543
1540
  }
1544
1541
 
1542
+ export namespace CardRefund {
1543
+ /**
1544
+ * Additional details about the card purchase, such as tax and industry-specific
1545
+ * fields.
1546
+ */
1547
+ export interface PurchaseDetails {
1548
+ /**
1549
+ * Fields specific to car rentals.
1550
+ */
1551
+ car_rental: PurchaseDetails.CarRental | null;
1552
+
1553
+ /**
1554
+ * An identifier from the merchant for the customer or consumer.
1555
+ */
1556
+ customer_reference_identifier: string | null;
1557
+
1558
+ /**
1559
+ * The state or provincial tax amount in minor units.
1560
+ */
1561
+ local_tax_amount: number | null;
1562
+
1563
+ /**
1564
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1565
+ * assessed.
1566
+ */
1567
+ local_tax_currency: string | null;
1568
+
1569
+ /**
1570
+ * Fields specific to lodging.
1571
+ */
1572
+ lodging: PurchaseDetails.Lodging | null;
1573
+
1574
+ /**
1575
+ * The national tax amount in minor units.
1576
+ */
1577
+ national_tax_amount: number | null;
1578
+
1579
+ /**
1580
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1581
+ * assessed.
1582
+ */
1583
+ national_tax_currency: string | null;
1584
+
1585
+ /**
1586
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
1587
+ */
1588
+ purchase_identifier: string | null;
1589
+
1590
+ /**
1591
+ * The format of the purchase identifier.
1592
+ *
1593
+ * - `free_text` - Free text
1594
+ * - `order_number` - Order number
1595
+ * - `rental_agreement_number` - Rental agreement number
1596
+ * - `hotel_folio_number` - Hotel folio number
1597
+ * - `invoice_number` - Invoice number
1598
+ */
1599
+ purchase_identifier_format:
1600
+ | 'free_text'
1601
+ | 'order_number'
1602
+ | 'rental_agreement_number'
1603
+ | 'hotel_folio_number'
1604
+ | 'invoice_number'
1605
+ | null;
1606
+
1607
+ /**
1608
+ * Fields specific to travel.
1609
+ */
1610
+ travel: PurchaseDetails.Travel | null;
1611
+ }
1612
+
1613
+ export namespace PurchaseDetails {
1614
+ /**
1615
+ * Fields specific to car rentals.
1616
+ */
1617
+ export interface CarRental {
1618
+ /**
1619
+ * Code indicating the vehicle's class.
1620
+ */
1621
+ car_class_code: string | null;
1622
+
1623
+ /**
1624
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
1625
+ * transaction, the scheduled pick up date.
1626
+ */
1627
+ checkout_date: string | null;
1628
+
1629
+ /**
1630
+ * Daily rate being charged for the vehicle.
1631
+ */
1632
+ daily_rental_rate_amount: number | null;
1633
+
1634
+ /**
1635
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
1636
+ * rate.
1637
+ */
1638
+ daily_rental_rate_currency: string | null;
1639
+
1640
+ /**
1641
+ * Number of days the vehicle was rented.
1642
+ */
1643
+ days_rented: number | null;
1644
+
1645
+ /**
1646
+ * Additional charges (gas, late fee, etc.) being billed.
1647
+ *
1648
+ * - `no_extra_charge` - No extra charge
1649
+ * - `gas` - Gas
1650
+ * - `extra_mileage` - Extra mileage
1651
+ * - `late_return` - Late return
1652
+ * - `one_way_service_fee` - One way service fee
1653
+ * - `parking_violation` - Parking violation
1654
+ */
1655
+ extra_charges:
1656
+ | 'no_extra_charge'
1657
+ | 'gas'
1658
+ | 'extra_mileage'
1659
+ | 'late_return'
1660
+ | 'one_way_service_fee'
1661
+ | 'parking_violation'
1662
+ | null;
1663
+
1664
+ /**
1665
+ * Fuel charges for the vehicle.
1666
+ */
1667
+ fuel_charges_amount: number | null;
1668
+
1669
+ /**
1670
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
1671
+ * assessed.
1672
+ */
1673
+ fuel_charges_currency: string | null;
1674
+
1675
+ /**
1676
+ * Any insurance being charged for the vehicle.
1677
+ */
1678
+ insurance_charges_amount: number | null;
1679
+
1680
+ /**
1681
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
1682
+ * charges assessed.
1683
+ */
1684
+ insurance_charges_currency: string | null;
1685
+
1686
+ /**
1687
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
1688
+ * not actually rented (that is, a "no-show" charge).
1689
+ *
1690
+ * - `not_applicable` - Not applicable
1691
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
1692
+ */
1693
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
1694
+
1695
+ /**
1696
+ * Charges for returning the vehicle at a different location than where it was
1697
+ * picked up.
1698
+ */
1699
+ one_way_drop_off_charges_amount: number | null;
1700
+
1701
+ /**
1702
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
1703
+ * drop-off charges assessed.
1704
+ */
1705
+ one_way_drop_off_charges_currency: string | null;
1706
+
1707
+ /**
1708
+ * Name of the person renting the vehicle.
1709
+ */
1710
+ renter_name: string | null;
1711
+
1712
+ /**
1713
+ * Weekly rate being charged for the vehicle.
1714
+ */
1715
+ weekly_rental_rate_amount: number | null;
1716
+
1717
+ /**
1718
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
1719
+ * rental rate.
1720
+ */
1721
+ weekly_rental_rate_currency: string | null;
1722
+ }
1723
+
1724
+ /**
1725
+ * Fields specific to lodging.
1726
+ */
1727
+ export interface Lodging {
1728
+ /**
1729
+ * Date the customer checked in.
1730
+ */
1731
+ check_in_date: string | null;
1732
+
1733
+ /**
1734
+ * Daily rate being charged for the room.
1735
+ */
1736
+ daily_room_rate_amount: number | null;
1737
+
1738
+ /**
1739
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
1740
+ * rate.
1741
+ */
1742
+ daily_room_rate_currency: string | null;
1743
+
1744
+ /**
1745
+ * Additional charges (phone, late check-out, etc.) being billed.
1746
+ *
1747
+ * - `no_extra_charge` - No extra charge
1748
+ * - `restaurant` - Restaurant
1749
+ * - `gift_shop` - Gift shop
1750
+ * - `mini_bar` - Mini bar
1751
+ * - `telephone` - Telephone
1752
+ * - `other` - Other
1753
+ * - `laundry` - Laundry
1754
+ */
1755
+ extra_charges:
1756
+ | 'no_extra_charge'
1757
+ | 'restaurant'
1758
+ | 'gift_shop'
1759
+ | 'mini_bar'
1760
+ | 'telephone'
1761
+ | 'other'
1762
+ | 'laundry'
1763
+ | null;
1764
+
1765
+ /**
1766
+ * Folio cash advances for the room.
1767
+ */
1768
+ folio_cash_advances_amount: number | null;
1769
+
1770
+ /**
1771
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
1772
+ * advances.
1773
+ */
1774
+ folio_cash_advances_currency: string | null;
1775
+
1776
+ /**
1777
+ * Food and beverage charges for the room.
1778
+ */
1779
+ food_beverage_charges_amount: number | null;
1780
+
1781
+ /**
1782
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
1783
+ * beverage charges.
1784
+ */
1785
+ food_beverage_charges_currency: string | null;
1786
+
1787
+ /**
1788
+ * Indicator that the cardholder is being billed for a reserved room that was not
1789
+ * actually used.
1790
+ *
1791
+ * - `not_applicable` - Not applicable
1792
+ * - `no_show` - No show
1793
+ */
1794
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
1795
+
1796
+ /**
1797
+ * Prepaid expenses being charged for the room.
1798
+ */
1799
+ prepaid_expenses_amount: number | null;
1800
+
1801
+ /**
1802
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
1803
+ * expenses.
1804
+ */
1805
+ prepaid_expenses_currency: string | null;
1806
+
1807
+ /**
1808
+ * Number of nights the room was rented.
1809
+ */
1810
+ room_nights: number | null;
1811
+
1812
+ /**
1813
+ * Total room tax being charged.
1814
+ */
1815
+ total_room_tax_amount: number | null;
1816
+
1817
+ /**
1818
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
1819
+ * tax.
1820
+ */
1821
+ total_room_tax_currency: string | null;
1822
+
1823
+ /**
1824
+ * Total tax being charged for the room.
1825
+ */
1826
+ total_tax_amount: number | null;
1827
+
1828
+ /**
1829
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
1830
+ * assessed.
1831
+ */
1832
+ total_tax_currency: string | null;
1833
+ }
1834
+
1835
+ /**
1836
+ * Fields specific to travel.
1837
+ */
1838
+ export interface Travel {
1839
+ /**
1840
+ * Ancillary purchases in addition to the airfare.
1841
+ */
1842
+ ancillary: Travel.Ancillary | null;
1843
+
1844
+ /**
1845
+ * Indicates the computerized reservation system used to book the ticket.
1846
+ */
1847
+ computerized_reservation_system: string | null;
1848
+
1849
+ /**
1850
+ * Indicates the reason for a credit to the cardholder.
1851
+ *
1852
+ * - `no_credit` - No credit
1853
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1854
+ * ancillary purchase cancellation
1855
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1856
+ * Airline ticket and passenger transport ancillary purchase cancellation
1857
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
1858
+ * - `other` - Other
1859
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
1860
+ */
1861
+ credit_reason_indicator:
1862
+ | 'no_credit'
1863
+ | 'passenger_transport_ancillary_purchase_cancellation'
1864
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1865
+ | 'airline_ticket_cancellation'
1866
+ | 'other'
1867
+ | 'partial_refund_of_airline_ticket'
1868
+ | null;
1869
+
1870
+ /**
1871
+ * Date of departure.
1872
+ */
1873
+ departure_date: string | null;
1874
+
1875
+ /**
1876
+ * Code for the originating city or airport.
1877
+ */
1878
+ origination_city_airport_code: string | null;
1879
+
1880
+ /**
1881
+ * Name of the passenger.
1882
+ */
1883
+ passenger_name: string | null;
1884
+
1885
+ /**
1886
+ * Indicates whether this ticket is non-refundable.
1887
+ *
1888
+ * - `no_restrictions` - No restrictions
1889
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
1890
+ */
1891
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
1892
+
1893
+ /**
1894
+ * Indicates why a ticket was changed.
1895
+ *
1896
+ * - `none` - None
1897
+ * - `change_to_existing_ticket` - Change to existing ticket
1898
+ * - `new_ticket` - New ticket
1899
+ */
1900
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
1901
+
1902
+ /**
1903
+ * Ticket number.
1904
+ */
1905
+ ticket_number: string | null;
1906
+
1907
+ /**
1908
+ * Code for the travel agency if the ticket was issued by a travel agency.
1909
+ */
1910
+ travel_agency_code: string | null;
1911
+
1912
+ /**
1913
+ * Name of the travel agency if the ticket was issued by a travel agency.
1914
+ */
1915
+ travel_agency_name: string | null;
1916
+
1917
+ /**
1918
+ * Fields specific to each leg of the journey.
1919
+ */
1920
+ trip_legs: Array<Travel.TripLeg> | null;
1921
+ }
1922
+
1923
+ export namespace Travel {
1924
+ /**
1925
+ * Ancillary purchases in addition to the airfare.
1926
+ */
1927
+ export interface Ancillary {
1928
+ /**
1929
+ * If this purchase has a connection or relationship to another purchase, such as a
1930
+ * baggage fee for a passenger transport ticket, this field should contain the
1931
+ * ticket document number for the other purchase.
1932
+ */
1933
+ connected_ticket_document_number: string | null;
1934
+
1935
+ /**
1936
+ * Indicates the reason for a credit to the cardholder.
1937
+ *
1938
+ * - `no_credit` - No credit
1939
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1940
+ * ancillary purchase cancellation
1941
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1942
+ * Airline ticket and passenger transport ancillary purchase cancellation
1943
+ * - `other` - Other
1944
+ */
1945
+ credit_reason_indicator:
1946
+ | 'no_credit'
1947
+ | 'passenger_transport_ancillary_purchase_cancellation'
1948
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1949
+ | 'other'
1950
+ | null;
1951
+
1952
+ /**
1953
+ * Name of the passenger or description of the ancillary purchase.
1954
+ */
1955
+ passenger_name_or_description: string | null;
1956
+
1957
+ /**
1958
+ * Additional travel charges, such as baggage fees.
1959
+ */
1960
+ services: Array<Ancillary.Service>;
1961
+
1962
+ /**
1963
+ * Ticket document number.
1964
+ */
1965
+ ticket_document_number: string | null;
1966
+ }
1967
+
1968
+ export namespace Ancillary {
1969
+ export interface Service {
1970
+ /**
1971
+ * Category of the ancillary service.
1972
+ *
1973
+ * - `none` - None
1974
+ * - `bundled_service` - Bundled service
1975
+ * - `baggage_fee` - Baggage fee
1976
+ * - `change_fee` - Change fee
1977
+ * - `cargo` - Cargo
1978
+ * - `carbon_offset` - Carbon offset
1979
+ * - `frequent_flyer` - Frequent flyer
1980
+ * - `gift_card` - Gift card
1981
+ * - `ground_transport` - Ground transport
1982
+ * - `in_flight_entertainment` - In-flight entertainment
1983
+ * - `lounge` - Lounge
1984
+ * - `medical` - Medical
1985
+ * - `meal_beverage` - Meal beverage
1986
+ * - `other` - Other
1987
+ * - `passenger_assist_fee` - Passenger assist fee
1988
+ * - `pets` - Pets
1989
+ * - `seat_fees` - Seat fees
1990
+ * - `standby` - Standby
1991
+ * - `service_fee` - Service fee
1992
+ * - `store` - Store
1993
+ * - `travel_service` - Travel service
1994
+ * - `unaccompanied_travel` - Unaccompanied travel
1995
+ * - `upgrades` - Upgrades
1996
+ * - `wifi` - Wi-fi
1997
+ */
1998
+ category:
1999
+ | 'none'
2000
+ | 'bundled_service'
2001
+ | 'baggage_fee'
2002
+ | 'change_fee'
2003
+ | 'cargo'
2004
+ | 'carbon_offset'
2005
+ | 'frequent_flyer'
2006
+ | 'gift_card'
2007
+ | 'ground_transport'
2008
+ | 'in_flight_entertainment'
2009
+ | 'lounge'
2010
+ | 'medical'
2011
+ | 'meal_beverage'
2012
+ | 'other'
2013
+ | 'passenger_assist_fee'
2014
+ | 'pets'
2015
+ | 'seat_fees'
2016
+ | 'standby'
2017
+ | 'service_fee'
2018
+ | 'store'
2019
+ | 'travel_service'
2020
+ | 'unaccompanied_travel'
2021
+ | 'upgrades'
2022
+ | 'wifi'
2023
+ | null;
2024
+
2025
+ /**
2026
+ * Sub-category of the ancillary service, free-form.
2027
+ */
2028
+ sub_category: string | null;
2029
+ }
2030
+ }
2031
+
2032
+ export interface TripLeg {
2033
+ /**
2034
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
2035
+ */
2036
+ carrier_code: string | null;
2037
+
2038
+ /**
2039
+ * Code for the destination city or airport.
2040
+ */
2041
+ destination_city_airport_code: string | null;
2042
+
2043
+ /**
2044
+ * Fare basis code.
2045
+ */
2046
+ fare_basis_code: string | null;
2047
+
2048
+ /**
2049
+ * Flight number.
2050
+ */
2051
+ flight_number: string | null;
2052
+
2053
+ /**
2054
+ * Service class (e.g., first class, business class, etc.).
2055
+ */
2056
+ service_class: string | null;
2057
+
2058
+ /**
2059
+ * Indicates whether a stopover is allowed on this ticket.
2060
+ *
2061
+ * - `none` - None
2062
+ * - `stop_over_allowed` - Stop over allowed
2063
+ * - `stop_over_not_allowed` - Stop over not allowed
2064
+ */
2065
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
2066
+ }
2067
+ }
2068
+ }
2069
+ }
2070
+
1545
2071
  /**
1546
2072
  * A Card Revenue Payment object. This field will be present in the JSON response
1547
2073
  * if and only if `category` is equal to `card_revenue_payment`.
@@ -1664,6 +2190,12 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1664
2190
  */
1665
2191
  presentment_currency: string;
1666
2192
 
2193
+ /**
2194
+ * Additional details about the card purchase, such as tax and industry-specific
2195
+ * fields.
2196
+ */
2197
+ purchase_details: CardSettlement.PurchaseDetails | null;
2198
+
1667
2199
  /**
1668
2200
  * The identifier of the Transaction associated with this Transaction.
1669
2201
  */
@@ -1676,6 +2208,535 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1676
2208
  type: 'card_settlement';
1677
2209
  }
1678
2210
 
2211
+ export namespace CardSettlement {
2212
+ /**
2213
+ * Additional details about the card purchase, such as tax and industry-specific
2214
+ * fields.
2215
+ */
2216
+ export interface PurchaseDetails {
2217
+ /**
2218
+ * Fields specific to car rentals.
2219
+ */
2220
+ car_rental: PurchaseDetails.CarRental | null;
2221
+
2222
+ /**
2223
+ * An identifier from the merchant for the customer or consumer.
2224
+ */
2225
+ customer_reference_identifier: string | null;
2226
+
2227
+ /**
2228
+ * The state or provincial tax amount in minor units.
2229
+ */
2230
+ local_tax_amount: number | null;
2231
+
2232
+ /**
2233
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
2234
+ * assessed.
2235
+ */
2236
+ local_tax_currency: string | null;
2237
+
2238
+ /**
2239
+ * Fields specific to lodging.
2240
+ */
2241
+ lodging: PurchaseDetails.Lodging | null;
2242
+
2243
+ /**
2244
+ * The national tax amount in minor units.
2245
+ */
2246
+ national_tax_amount: number | null;
2247
+
2248
+ /**
2249
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
2250
+ * assessed.
2251
+ */
2252
+ national_tax_currency: string | null;
2253
+
2254
+ /**
2255
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
2256
+ */
2257
+ purchase_identifier: string | null;
2258
+
2259
+ /**
2260
+ * The format of the purchase identifier.
2261
+ *
2262
+ * - `free_text` - Free text
2263
+ * - `order_number` - Order number
2264
+ * - `rental_agreement_number` - Rental agreement number
2265
+ * - `hotel_folio_number` - Hotel folio number
2266
+ * - `invoice_number` - Invoice number
2267
+ */
2268
+ purchase_identifier_format:
2269
+ | 'free_text'
2270
+ | 'order_number'
2271
+ | 'rental_agreement_number'
2272
+ | 'hotel_folio_number'
2273
+ | 'invoice_number'
2274
+ | null;
2275
+
2276
+ /**
2277
+ * Fields specific to travel.
2278
+ */
2279
+ travel: PurchaseDetails.Travel | null;
2280
+ }
2281
+
2282
+ export namespace PurchaseDetails {
2283
+ /**
2284
+ * Fields specific to car rentals.
2285
+ */
2286
+ export interface CarRental {
2287
+ /**
2288
+ * Code indicating the vehicle's class.
2289
+ */
2290
+ car_class_code: string | null;
2291
+
2292
+ /**
2293
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
2294
+ * transaction, the scheduled pick up date.
2295
+ */
2296
+ checkout_date: string | null;
2297
+
2298
+ /**
2299
+ * Daily rate being charged for the vehicle.
2300
+ */
2301
+ daily_rental_rate_amount: number | null;
2302
+
2303
+ /**
2304
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
2305
+ * rate.
2306
+ */
2307
+ daily_rental_rate_currency: string | null;
2308
+
2309
+ /**
2310
+ * Number of days the vehicle was rented.
2311
+ */
2312
+ days_rented: number | null;
2313
+
2314
+ /**
2315
+ * Additional charges (gas, late fee, etc.) being billed.
2316
+ *
2317
+ * - `no_extra_charge` - No extra charge
2318
+ * - `gas` - Gas
2319
+ * - `extra_mileage` - Extra mileage
2320
+ * - `late_return` - Late return
2321
+ * - `one_way_service_fee` - One way service fee
2322
+ * - `parking_violation` - Parking violation
2323
+ */
2324
+ extra_charges:
2325
+ | 'no_extra_charge'
2326
+ | 'gas'
2327
+ | 'extra_mileage'
2328
+ | 'late_return'
2329
+ | 'one_way_service_fee'
2330
+ | 'parking_violation'
2331
+ | null;
2332
+
2333
+ /**
2334
+ * Fuel charges for the vehicle.
2335
+ */
2336
+ fuel_charges_amount: number | null;
2337
+
2338
+ /**
2339
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
2340
+ * assessed.
2341
+ */
2342
+ fuel_charges_currency: string | null;
2343
+
2344
+ /**
2345
+ * Any insurance being charged for the vehicle.
2346
+ */
2347
+ insurance_charges_amount: number | null;
2348
+
2349
+ /**
2350
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
2351
+ * charges assessed.
2352
+ */
2353
+ insurance_charges_currency: string | null;
2354
+
2355
+ /**
2356
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
2357
+ * not actually rented (that is, a "no-show" charge).
2358
+ *
2359
+ * - `not_applicable` - Not applicable
2360
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
2361
+ */
2362
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
2363
+
2364
+ /**
2365
+ * Charges for returning the vehicle at a different location than where it was
2366
+ * picked up.
2367
+ */
2368
+ one_way_drop_off_charges_amount: number | null;
2369
+
2370
+ /**
2371
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
2372
+ * drop-off charges assessed.
2373
+ */
2374
+ one_way_drop_off_charges_currency: string | null;
2375
+
2376
+ /**
2377
+ * Name of the person renting the vehicle.
2378
+ */
2379
+ renter_name: string | null;
2380
+
2381
+ /**
2382
+ * Weekly rate being charged for the vehicle.
2383
+ */
2384
+ weekly_rental_rate_amount: number | null;
2385
+
2386
+ /**
2387
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
2388
+ * rental rate.
2389
+ */
2390
+ weekly_rental_rate_currency: string | null;
2391
+ }
2392
+
2393
+ /**
2394
+ * Fields specific to lodging.
2395
+ */
2396
+ export interface Lodging {
2397
+ /**
2398
+ * Date the customer checked in.
2399
+ */
2400
+ check_in_date: string | null;
2401
+
2402
+ /**
2403
+ * Daily rate being charged for the room.
2404
+ */
2405
+ daily_room_rate_amount: number | null;
2406
+
2407
+ /**
2408
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
2409
+ * rate.
2410
+ */
2411
+ daily_room_rate_currency: string | null;
2412
+
2413
+ /**
2414
+ * Additional charges (phone, late check-out, etc.) being billed.
2415
+ *
2416
+ * - `no_extra_charge` - No extra charge
2417
+ * - `restaurant` - Restaurant
2418
+ * - `gift_shop` - Gift shop
2419
+ * - `mini_bar` - Mini bar
2420
+ * - `telephone` - Telephone
2421
+ * - `other` - Other
2422
+ * - `laundry` - Laundry
2423
+ */
2424
+ extra_charges:
2425
+ | 'no_extra_charge'
2426
+ | 'restaurant'
2427
+ | 'gift_shop'
2428
+ | 'mini_bar'
2429
+ | 'telephone'
2430
+ | 'other'
2431
+ | 'laundry'
2432
+ | null;
2433
+
2434
+ /**
2435
+ * Folio cash advances for the room.
2436
+ */
2437
+ folio_cash_advances_amount: number | null;
2438
+
2439
+ /**
2440
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
2441
+ * advances.
2442
+ */
2443
+ folio_cash_advances_currency: string | null;
2444
+
2445
+ /**
2446
+ * Food and beverage charges for the room.
2447
+ */
2448
+ food_beverage_charges_amount: number | null;
2449
+
2450
+ /**
2451
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
2452
+ * beverage charges.
2453
+ */
2454
+ food_beverage_charges_currency: string | null;
2455
+
2456
+ /**
2457
+ * Indicator that the cardholder is being billed for a reserved room that was not
2458
+ * actually used.
2459
+ *
2460
+ * - `not_applicable` - Not applicable
2461
+ * - `no_show` - No show
2462
+ */
2463
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
2464
+
2465
+ /**
2466
+ * Prepaid expenses being charged for the room.
2467
+ */
2468
+ prepaid_expenses_amount: number | null;
2469
+
2470
+ /**
2471
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
2472
+ * expenses.
2473
+ */
2474
+ prepaid_expenses_currency: string | null;
2475
+
2476
+ /**
2477
+ * Number of nights the room was rented.
2478
+ */
2479
+ room_nights: number | null;
2480
+
2481
+ /**
2482
+ * Total room tax being charged.
2483
+ */
2484
+ total_room_tax_amount: number | null;
2485
+
2486
+ /**
2487
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
2488
+ * tax.
2489
+ */
2490
+ total_room_tax_currency: string | null;
2491
+
2492
+ /**
2493
+ * Total tax being charged for the room.
2494
+ */
2495
+ total_tax_amount: number | null;
2496
+
2497
+ /**
2498
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
2499
+ * assessed.
2500
+ */
2501
+ total_tax_currency: string | null;
2502
+ }
2503
+
2504
+ /**
2505
+ * Fields specific to travel.
2506
+ */
2507
+ export interface Travel {
2508
+ /**
2509
+ * Ancillary purchases in addition to the airfare.
2510
+ */
2511
+ ancillary: Travel.Ancillary | null;
2512
+
2513
+ /**
2514
+ * Indicates the computerized reservation system used to book the ticket.
2515
+ */
2516
+ computerized_reservation_system: string | null;
2517
+
2518
+ /**
2519
+ * Indicates the reason for a credit to the cardholder.
2520
+ *
2521
+ * - `no_credit` - No credit
2522
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
2523
+ * ancillary purchase cancellation
2524
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
2525
+ * Airline ticket and passenger transport ancillary purchase cancellation
2526
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
2527
+ * - `other` - Other
2528
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
2529
+ */
2530
+ credit_reason_indicator:
2531
+ | 'no_credit'
2532
+ | 'passenger_transport_ancillary_purchase_cancellation'
2533
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
2534
+ | 'airline_ticket_cancellation'
2535
+ | 'other'
2536
+ | 'partial_refund_of_airline_ticket'
2537
+ | null;
2538
+
2539
+ /**
2540
+ * Date of departure.
2541
+ */
2542
+ departure_date: string | null;
2543
+
2544
+ /**
2545
+ * Code for the originating city or airport.
2546
+ */
2547
+ origination_city_airport_code: string | null;
2548
+
2549
+ /**
2550
+ * Name of the passenger.
2551
+ */
2552
+ passenger_name: string | null;
2553
+
2554
+ /**
2555
+ * Indicates whether this ticket is non-refundable.
2556
+ *
2557
+ * - `no_restrictions` - No restrictions
2558
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
2559
+ */
2560
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
2561
+
2562
+ /**
2563
+ * Indicates why a ticket was changed.
2564
+ *
2565
+ * - `none` - None
2566
+ * - `change_to_existing_ticket` - Change to existing ticket
2567
+ * - `new_ticket` - New ticket
2568
+ */
2569
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
2570
+
2571
+ /**
2572
+ * Ticket number.
2573
+ */
2574
+ ticket_number: string | null;
2575
+
2576
+ /**
2577
+ * Code for the travel agency if the ticket was issued by a travel agency.
2578
+ */
2579
+ travel_agency_code: string | null;
2580
+
2581
+ /**
2582
+ * Name of the travel agency if the ticket was issued by a travel agency.
2583
+ */
2584
+ travel_agency_name: string | null;
2585
+
2586
+ /**
2587
+ * Fields specific to each leg of the journey.
2588
+ */
2589
+ trip_legs: Array<Travel.TripLeg> | null;
2590
+ }
2591
+
2592
+ export namespace Travel {
2593
+ /**
2594
+ * Ancillary purchases in addition to the airfare.
2595
+ */
2596
+ export interface Ancillary {
2597
+ /**
2598
+ * If this purchase has a connection or relationship to another purchase, such as a
2599
+ * baggage fee for a passenger transport ticket, this field should contain the
2600
+ * ticket document number for the other purchase.
2601
+ */
2602
+ connected_ticket_document_number: string | null;
2603
+
2604
+ /**
2605
+ * Indicates the reason for a credit to the cardholder.
2606
+ *
2607
+ * - `no_credit` - No credit
2608
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
2609
+ * ancillary purchase cancellation
2610
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
2611
+ * Airline ticket and passenger transport ancillary purchase cancellation
2612
+ * - `other` - Other
2613
+ */
2614
+ credit_reason_indicator:
2615
+ | 'no_credit'
2616
+ | 'passenger_transport_ancillary_purchase_cancellation'
2617
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
2618
+ | 'other'
2619
+ | null;
2620
+
2621
+ /**
2622
+ * Name of the passenger or description of the ancillary purchase.
2623
+ */
2624
+ passenger_name_or_description: string | null;
2625
+
2626
+ /**
2627
+ * Additional travel charges, such as baggage fees.
2628
+ */
2629
+ services: Array<Ancillary.Service>;
2630
+
2631
+ /**
2632
+ * Ticket document number.
2633
+ */
2634
+ ticket_document_number: string | null;
2635
+ }
2636
+
2637
+ export namespace Ancillary {
2638
+ export interface Service {
2639
+ /**
2640
+ * Category of the ancillary service.
2641
+ *
2642
+ * - `none` - None
2643
+ * - `bundled_service` - Bundled service
2644
+ * - `baggage_fee` - Baggage fee
2645
+ * - `change_fee` - Change fee
2646
+ * - `cargo` - Cargo
2647
+ * - `carbon_offset` - Carbon offset
2648
+ * - `frequent_flyer` - Frequent flyer
2649
+ * - `gift_card` - Gift card
2650
+ * - `ground_transport` - Ground transport
2651
+ * - `in_flight_entertainment` - In-flight entertainment
2652
+ * - `lounge` - Lounge
2653
+ * - `medical` - Medical
2654
+ * - `meal_beverage` - Meal beverage
2655
+ * - `other` - Other
2656
+ * - `passenger_assist_fee` - Passenger assist fee
2657
+ * - `pets` - Pets
2658
+ * - `seat_fees` - Seat fees
2659
+ * - `standby` - Standby
2660
+ * - `service_fee` - Service fee
2661
+ * - `store` - Store
2662
+ * - `travel_service` - Travel service
2663
+ * - `unaccompanied_travel` - Unaccompanied travel
2664
+ * - `upgrades` - Upgrades
2665
+ * - `wifi` - Wi-fi
2666
+ */
2667
+ category:
2668
+ | 'none'
2669
+ | 'bundled_service'
2670
+ | 'baggage_fee'
2671
+ | 'change_fee'
2672
+ | 'cargo'
2673
+ | 'carbon_offset'
2674
+ | 'frequent_flyer'
2675
+ | 'gift_card'
2676
+ | 'ground_transport'
2677
+ | 'in_flight_entertainment'
2678
+ | 'lounge'
2679
+ | 'medical'
2680
+ | 'meal_beverage'
2681
+ | 'other'
2682
+ | 'passenger_assist_fee'
2683
+ | 'pets'
2684
+ | 'seat_fees'
2685
+ | 'standby'
2686
+ | 'service_fee'
2687
+ | 'store'
2688
+ | 'travel_service'
2689
+ | 'unaccompanied_travel'
2690
+ | 'upgrades'
2691
+ | 'wifi'
2692
+ | null;
2693
+
2694
+ /**
2695
+ * Sub-category of the ancillary service, free-form.
2696
+ */
2697
+ sub_category: string | null;
2698
+ }
2699
+ }
2700
+
2701
+ export interface TripLeg {
2702
+ /**
2703
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
2704
+ */
2705
+ carrier_code: string | null;
2706
+
2707
+ /**
2708
+ * Code for the destination city or airport.
2709
+ */
2710
+ destination_city_airport_code: string | null;
2711
+
2712
+ /**
2713
+ * Fare basis code.
2714
+ */
2715
+ fare_basis_code: string | null;
2716
+
2717
+ /**
2718
+ * Flight number.
2719
+ */
2720
+ flight_number: string | null;
2721
+
2722
+ /**
2723
+ * Service class (e.g., first class, business class, etc.).
2724
+ */
2725
+ service_class: string | null;
2726
+
2727
+ /**
2728
+ * Indicates whether a stopover is allowed on this ticket.
2729
+ *
2730
+ * - `none` - None
2731
+ * - `stop_over_allowed` - Stop over allowed
2732
+ * - `stop_over_not_allowed` - Stop over not allowed
2733
+ */
2734
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
2735
+ }
2736
+ }
2737
+ }
2738
+ }
2739
+
1679
2740
  /**
1680
2741
  * A Check Deposit Acceptance object. This field will be present in the JSON
1681
2742
  * response if and only if `category` is equal to `check_deposit_acceptance`.
@@ -1891,17 +2952,6 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1891
2952
  transfer_id: string;
1892
2953
  }
1893
2954
 
1894
- /**
1895
- * A Check Transfer Rejection object. This field will be present in the JSON
1896
- * response if and only if `category` is equal to `check_transfer_rejection`.
1897
- */
1898
- export interface CheckTransferRejection {
1899
- /**
1900
- * The identifier of the Check Transfer that led to this Transaction.
1901
- */
1902
- transfer_id: string;
1903
- }
1904
-
1905
2955
  /**
1906
2956
  * A Check Transfer Stop Payment Request object. This field will be present in the
1907
2957
  * JSON response if and only if `category` is equal to
@@ -1912,9 +2962,11 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1912
2962
  * The reason why this transfer was stopped.
1913
2963
  *
1914
2964
  * - `mail_delivery_failed` - The check could not be delivered.
2965
+ * - `rejected_by_increase` - The check was cancelled by an Increase operator who
2966
+ * will provide details out-of-band.
1915
2967
  * - `unknown` - The check was stopped for another reason.
1916
2968
  */
1917
- reason: 'mail_delivery_failed' | 'unknown';
2969
+ reason: 'mail_delivery_failed' | 'rejected_by_increase' | 'unknown';
1918
2970
 
1919
2971
  /**
1920
2972
  * The time the stop-payment was requested.
@@ -2449,6 +3501,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
2449
3501
  * - `account_closure` - Account closure
2450
3502
  * - `bank_migration` - Bank migration
2451
3503
  * - `cashback` - Cashback
3504
+ * - `check_adjustment` - Check adjustment
2452
3505
  * - `collection_receivable` - Collection receivable
2453
3506
  * - `empyreal_adjustment` - Empyreal adjustment
2454
3507
  * - `error` - Error
@@ -2463,6 +3516,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
2463
3516
  | 'account_closure'
2464
3517
  | 'bank_migration'
2465
3518
  | 'cashback'
3519
+ | 'check_adjustment'
2466
3520
  | 'collection_receivable'
2467
3521
  | 'empyreal_adjustment'
2468
3522
  | 'error'