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