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
@@ -173,8 +173,6 @@ export declare namespace InterestPaymentSimulationResult {
173
173
  * Deposit object. Details will be under the `check_transfer_deposit` object.
174
174
  * - `check_transfer_intention` - The Transaction was created by a Check Transfer
175
175
  * Intention object. Details will be under the `check_transfer_intention` object.
176
- * - `check_transfer_rejection` - The Transaction was created by a Check Transfer
177
- * Rejection object. Details will be under the `check_transfer_rejection` object.
178
176
  * - `check_transfer_stop_payment_request` - The Transaction was created by a Check
179
177
  * Transfer Stop Payment Request object. Details will be under the
180
178
  * `check_transfer_stop_payment_request` object.
@@ -231,7 +229,6 @@ export declare namespace InterestPaymentSimulationResult {
231
229
  | 'check_deposit_return'
232
230
  | 'check_transfer_deposit'
233
231
  | 'check_transfer_intention'
234
- | 'check_transfer_rejection'
235
232
  | 'check_transfer_stop_payment_request'
236
233
  | 'fee_payment'
237
234
  | 'inbound_ach_transfer'
@@ -270,11 +267,6 @@ export declare namespace InterestPaymentSimulationResult {
270
267
  * response if and only if `category` is equal to `check_transfer_intention`.
271
268
  */
272
269
  check_transfer_intention: Source.CheckTransferIntention | null;
273
- /**
274
- * A Check Transfer Rejection object. This field will be present in the JSON
275
- * response if and only if `category` is equal to `check_transfer_rejection`.
276
- */
277
- check_transfer_rejection: Source.CheckTransferRejection | null;
278
270
  /**
279
271
  * A Check Transfer Stop Payment Request object. This field will be present in the
280
272
  * JSON response if and only if `category` is equal to
@@ -742,6 +734,11 @@ export declare namespace InterestPaymentSimulationResult {
742
734
  * The state the merchant resides in.
743
735
  */
744
736
  merchant_state: string | null;
737
+ /**
738
+ * Additional details about the card purchase, such as tax and industry-specific
739
+ * fields.
740
+ */
741
+ purchase_details: CardRefund.PurchaseDetails | null;
745
742
  /**
746
743
  * The identifier of the Transaction associated with this Transaction.
747
744
  */
@@ -752,6 +749,468 @@ export declare namespace InterestPaymentSimulationResult {
752
749
  */
753
750
  type: 'card_refund';
754
751
  }
752
+ namespace CardRefund {
753
+ /**
754
+ * Additional details about the card purchase, such as tax and industry-specific
755
+ * fields.
756
+ */
757
+ interface PurchaseDetails {
758
+ /**
759
+ * Fields specific to car rentals.
760
+ */
761
+ car_rental: PurchaseDetails.CarRental | null;
762
+ /**
763
+ * An identifier from the merchant for the customer or consumer.
764
+ */
765
+ customer_reference_identifier: string | null;
766
+ /**
767
+ * The state or provincial tax amount in minor units.
768
+ */
769
+ local_tax_amount: number | null;
770
+ /**
771
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
772
+ * assessed.
773
+ */
774
+ local_tax_currency: string | null;
775
+ /**
776
+ * Fields specific to lodging.
777
+ */
778
+ lodging: PurchaseDetails.Lodging | null;
779
+ /**
780
+ * The national tax amount in minor units.
781
+ */
782
+ national_tax_amount: number | null;
783
+ /**
784
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
785
+ * assessed.
786
+ */
787
+ national_tax_currency: string | null;
788
+ /**
789
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
790
+ */
791
+ purchase_identifier: string | null;
792
+ /**
793
+ * The format of the purchase identifier.
794
+ *
795
+ * - `free_text` - Free text
796
+ * - `order_number` - Order number
797
+ * - `rental_agreement_number` - Rental agreement number
798
+ * - `hotel_folio_number` - Hotel folio number
799
+ * - `invoice_number` - Invoice number
800
+ */
801
+ purchase_identifier_format:
802
+ | 'free_text'
803
+ | 'order_number'
804
+ | 'rental_agreement_number'
805
+ | 'hotel_folio_number'
806
+ | 'invoice_number'
807
+ | null;
808
+ /**
809
+ * Fields specific to travel.
810
+ */
811
+ travel: PurchaseDetails.Travel | null;
812
+ }
813
+ namespace PurchaseDetails {
814
+ /**
815
+ * Fields specific to car rentals.
816
+ */
817
+ interface CarRental {
818
+ /**
819
+ * Code indicating the vehicle's class.
820
+ */
821
+ car_class_code: string | null;
822
+ /**
823
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
824
+ * transaction, the scheduled pick up date.
825
+ */
826
+ checkout_date: string | null;
827
+ /**
828
+ * Daily rate being charged for the vehicle.
829
+ */
830
+ daily_rental_rate_amount: number | null;
831
+ /**
832
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
833
+ * rate.
834
+ */
835
+ daily_rental_rate_currency: string | null;
836
+ /**
837
+ * Number of days the vehicle was rented.
838
+ */
839
+ days_rented: number | null;
840
+ /**
841
+ * Additional charges (gas, late fee, etc.) being billed.
842
+ *
843
+ * - `no_extra_charge` - No extra charge
844
+ * - `gas` - Gas
845
+ * - `extra_mileage` - Extra mileage
846
+ * - `late_return` - Late return
847
+ * - `one_way_service_fee` - One way service fee
848
+ * - `parking_violation` - Parking violation
849
+ */
850
+ extra_charges:
851
+ | 'no_extra_charge'
852
+ | 'gas'
853
+ | 'extra_mileage'
854
+ | 'late_return'
855
+ | 'one_way_service_fee'
856
+ | 'parking_violation'
857
+ | null;
858
+ /**
859
+ * Fuel charges for the vehicle.
860
+ */
861
+ fuel_charges_amount: number | null;
862
+ /**
863
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
864
+ * assessed.
865
+ */
866
+ fuel_charges_currency: string | null;
867
+ /**
868
+ * Any insurance being charged for the vehicle.
869
+ */
870
+ insurance_charges_amount: number | null;
871
+ /**
872
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
873
+ * charges assessed.
874
+ */
875
+ insurance_charges_currency: string | null;
876
+ /**
877
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
878
+ * not actually rented (that is, a "no-show" charge).
879
+ *
880
+ * - `not_applicable` - Not applicable
881
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
882
+ */
883
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
884
+ /**
885
+ * Charges for returning the vehicle at a different location than where it was
886
+ * picked up.
887
+ */
888
+ one_way_drop_off_charges_amount: number | null;
889
+ /**
890
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
891
+ * drop-off charges assessed.
892
+ */
893
+ one_way_drop_off_charges_currency: string | null;
894
+ /**
895
+ * Name of the person renting the vehicle.
896
+ */
897
+ renter_name: string | null;
898
+ /**
899
+ * Weekly rate being charged for the vehicle.
900
+ */
901
+ weekly_rental_rate_amount: number | null;
902
+ /**
903
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
904
+ * rental rate.
905
+ */
906
+ weekly_rental_rate_currency: string | null;
907
+ }
908
+ /**
909
+ * Fields specific to lodging.
910
+ */
911
+ interface Lodging {
912
+ /**
913
+ * Date the customer checked in.
914
+ */
915
+ check_in_date: string | null;
916
+ /**
917
+ * Daily rate being charged for the room.
918
+ */
919
+ daily_room_rate_amount: number | null;
920
+ /**
921
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
922
+ * rate.
923
+ */
924
+ daily_room_rate_currency: string | null;
925
+ /**
926
+ * Additional charges (phone, late check-out, etc.) being billed.
927
+ *
928
+ * - `no_extra_charge` - No extra charge
929
+ * - `restaurant` - Restaurant
930
+ * - `gift_shop` - Gift shop
931
+ * - `mini_bar` - Mini bar
932
+ * - `telephone` - Telephone
933
+ * - `other` - Other
934
+ * - `laundry` - Laundry
935
+ */
936
+ extra_charges:
937
+ | 'no_extra_charge'
938
+ | 'restaurant'
939
+ | 'gift_shop'
940
+ | 'mini_bar'
941
+ | 'telephone'
942
+ | 'other'
943
+ | 'laundry'
944
+ | null;
945
+ /**
946
+ * Folio cash advances for the room.
947
+ */
948
+ folio_cash_advances_amount: number | null;
949
+ /**
950
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
951
+ * advances.
952
+ */
953
+ folio_cash_advances_currency: string | null;
954
+ /**
955
+ * Food and beverage charges for the room.
956
+ */
957
+ food_beverage_charges_amount: number | null;
958
+ /**
959
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
960
+ * beverage charges.
961
+ */
962
+ food_beverage_charges_currency: string | null;
963
+ /**
964
+ * Indicator that the cardholder is being billed for a reserved room that was not
965
+ * actually used.
966
+ *
967
+ * - `not_applicable` - Not applicable
968
+ * - `no_show` - No show
969
+ */
970
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
971
+ /**
972
+ * Prepaid expenses being charged for the room.
973
+ */
974
+ prepaid_expenses_amount: number | null;
975
+ /**
976
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
977
+ * expenses.
978
+ */
979
+ prepaid_expenses_currency: string | null;
980
+ /**
981
+ * Number of nights the room was rented.
982
+ */
983
+ room_nights: number | null;
984
+ /**
985
+ * Total room tax being charged.
986
+ */
987
+ total_room_tax_amount: number | null;
988
+ /**
989
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
990
+ * tax.
991
+ */
992
+ total_room_tax_currency: string | null;
993
+ /**
994
+ * Total tax being charged for the room.
995
+ */
996
+ total_tax_amount: number | null;
997
+ /**
998
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
999
+ * assessed.
1000
+ */
1001
+ total_tax_currency: string | null;
1002
+ }
1003
+ /**
1004
+ * Fields specific to travel.
1005
+ */
1006
+ interface Travel {
1007
+ /**
1008
+ * Ancillary purchases in addition to the airfare.
1009
+ */
1010
+ ancillary: Travel.Ancillary | null;
1011
+ /**
1012
+ * Indicates the computerized reservation system used to book the ticket.
1013
+ */
1014
+ computerized_reservation_system: string | null;
1015
+ /**
1016
+ * Indicates the reason for a credit to the cardholder.
1017
+ *
1018
+ * - `no_credit` - No credit
1019
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1020
+ * ancillary purchase cancellation
1021
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1022
+ * Airline ticket and passenger transport ancillary purchase cancellation
1023
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
1024
+ * - `other` - Other
1025
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
1026
+ */
1027
+ credit_reason_indicator:
1028
+ | 'no_credit'
1029
+ | 'passenger_transport_ancillary_purchase_cancellation'
1030
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1031
+ | 'airline_ticket_cancellation'
1032
+ | 'other'
1033
+ | 'partial_refund_of_airline_ticket'
1034
+ | null;
1035
+ /**
1036
+ * Date of departure.
1037
+ */
1038
+ departure_date: string | null;
1039
+ /**
1040
+ * Code for the originating city or airport.
1041
+ */
1042
+ origination_city_airport_code: string | null;
1043
+ /**
1044
+ * Name of the passenger.
1045
+ */
1046
+ passenger_name: string | null;
1047
+ /**
1048
+ * Indicates whether this ticket is non-refundable.
1049
+ *
1050
+ * - `no_restrictions` - No restrictions
1051
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
1052
+ */
1053
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
1054
+ /**
1055
+ * Indicates why a ticket was changed.
1056
+ *
1057
+ * - `none` - None
1058
+ * - `change_to_existing_ticket` - Change to existing ticket
1059
+ * - `new_ticket` - New ticket
1060
+ */
1061
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
1062
+ /**
1063
+ * Ticket number.
1064
+ */
1065
+ ticket_number: string | null;
1066
+ /**
1067
+ * Code for the travel agency if the ticket was issued by a travel agency.
1068
+ */
1069
+ travel_agency_code: string | null;
1070
+ /**
1071
+ * Name of the travel agency if the ticket was issued by a travel agency.
1072
+ */
1073
+ travel_agency_name: string | null;
1074
+ /**
1075
+ * Fields specific to each leg of the journey.
1076
+ */
1077
+ trip_legs: Array<Travel.TripLeg> | null;
1078
+ }
1079
+ namespace Travel {
1080
+ /**
1081
+ * Ancillary purchases in addition to the airfare.
1082
+ */
1083
+ interface Ancillary {
1084
+ /**
1085
+ * If this purchase has a connection or relationship to another purchase, such as a
1086
+ * baggage fee for a passenger transport ticket, this field should contain the
1087
+ * ticket document number for the other purchase.
1088
+ */
1089
+ connected_ticket_document_number: string | null;
1090
+ /**
1091
+ * Indicates the reason for a credit to the cardholder.
1092
+ *
1093
+ * - `no_credit` - No credit
1094
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1095
+ * ancillary purchase cancellation
1096
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1097
+ * Airline ticket and passenger transport ancillary purchase cancellation
1098
+ * - `other` - Other
1099
+ */
1100
+ credit_reason_indicator:
1101
+ | 'no_credit'
1102
+ | 'passenger_transport_ancillary_purchase_cancellation'
1103
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1104
+ | 'other'
1105
+ | null;
1106
+ /**
1107
+ * Name of the passenger or description of the ancillary purchase.
1108
+ */
1109
+ passenger_name_or_description: string | null;
1110
+ /**
1111
+ * Additional travel charges, such as baggage fees.
1112
+ */
1113
+ services: Array<Ancillary.Service>;
1114
+ /**
1115
+ * Ticket document number.
1116
+ */
1117
+ ticket_document_number: string | null;
1118
+ }
1119
+ namespace Ancillary {
1120
+ interface Service {
1121
+ /**
1122
+ * Category of the ancillary service.
1123
+ *
1124
+ * - `none` - None
1125
+ * - `bundled_service` - Bundled service
1126
+ * - `baggage_fee` - Baggage fee
1127
+ * - `change_fee` - Change fee
1128
+ * - `cargo` - Cargo
1129
+ * - `carbon_offset` - Carbon offset
1130
+ * - `frequent_flyer` - Frequent flyer
1131
+ * - `gift_card` - Gift card
1132
+ * - `ground_transport` - Ground transport
1133
+ * - `in_flight_entertainment` - In-flight entertainment
1134
+ * - `lounge` - Lounge
1135
+ * - `medical` - Medical
1136
+ * - `meal_beverage` - Meal beverage
1137
+ * - `other` - Other
1138
+ * - `passenger_assist_fee` - Passenger assist fee
1139
+ * - `pets` - Pets
1140
+ * - `seat_fees` - Seat fees
1141
+ * - `standby` - Standby
1142
+ * - `service_fee` - Service fee
1143
+ * - `store` - Store
1144
+ * - `travel_service` - Travel service
1145
+ * - `unaccompanied_travel` - Unaccompanied travel
1146
+ * - `upgrades` - Upgrades
1147
+ * - `wifi` - Wi-fi
1148
+ */
1149
+ category:
1150
+ | 'none'
1151
+ | 'bundled_service'
1152
+ | 'baggage_fee'
1153
+ | 'change_fee'
1154
+ | 'cargo'
1155
+ | 'carbon_offset'
1156
+ | 'frequent_flyer'
1157
+ | 'gift_card'
1158
+ | 'ground_transport'
1159
+ | 'in_flight_entertainment'
1160
+ | 'lounge'
1161
+ | 'medical'
1162
+ | 'meal_beverage'
1163
+ | 'other'
1164
+ | 'passenger_assist_fee'
1165
+ | 'pets'
1166
+ | 'seat_fees'
1167
+ | 'standby'
1168
+ | 'service_fee'
1169
+ | 'store'
1170
+ | 'travel_service'
1171
+ | 'unaccompanied_travel'
1172
+ | 'upgrades'
1173
+ | 'wifi'
1174
+ | null;
1175
+ /**
1176
+ * Sub-category of the ancillary service, free-form.
1177
+ */
1178
+ sub_category: string | null;
1179
+ }
1180
+ }
1181
+ interface TripLeg {
1182
+ /**
1183
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
1184
+ */
1185
+ carrier_code: string | null;
1186
+ /**
1187
+ * Code for the destination city or airport.
1188
+ */
1189
+ destination_city_airport_code: string | null;
1190
+ /**
1191
+ * Fare basis code.
1192
+ */
1193
+ fare_basis_code: string | null;
1194
+ /**
1195
+ * Flight number.
1196
+ */
1197
+ flight_number: string | null;
1198
+ /**
1199
+ * Service class (e.g., first class, business class, etc.).
1200
+ */
1201
+ service_class: string | null;
1202
+ /**
1203
+ * Indicates whether a stopover is allowed on this ticket.
1204
+ *
1205
+ * - `none` - None
1206
+ * - `stop_over_allowed` - Stop over allowed
1207
+ * - `stop_over_not_allowed` - Stop over not allowed
1208
+ */
1209
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
1210
+ }
1211
+ }
1212
+ }
1213
+ }
755
1214
  /**
756
1215
  * A Card Revenue Payment object. This field will be present in the JSON response
757
1216
  * if and only if `category` is equal to `card_revenue_payment`.
@@ -856,6 +1315,11 @@ export declare namespace InterestPaymentSimulationResult {
856
1315
  * transaction's presentment currency.
857
1316
  */
858
1317
  presentment_currency: string;
1318
+ /**
1319
+ * Additional details about the card purchase, such as tax and industry-specific
1320
+ * fields.
1321
+ */
1322
+ purchase_details: CardSettlement.PurchaseDetails | null;
859
1323
  /**
860
1324
  * The identifier of the Transaction associated with this Transaction.
861
1325
  */
@@ -866,6 +1330,468 @@ export declare namespace InterestPaymentSimulationResult {
866
1330
  */
867
1331
  type: 'card_settlement';
868
1332
  }
1333
+ namespace CardSettlement {
1334
+ /**
1335
+ * Additional details about the card purchase, such as tax and industry-specific
1336
+ * fields.
1337
+ */
1338
+ interface PurchaseDetails {
1339
+ /**
1340
+ * Fields specific to car rentals.
1341
+ */
1342
+ car_rental: PurchaseDetails.CarRental | null;
1343
+ /**
1344
+ * An identifier from the merchant for the customer or consumer.
1345
+ */
1346
+ customer_reference_identifier: string | null;
1347
+ /**
1348
+ * The state or provincial tax amount in minor units.
1349
+ */
1350
+ local_tax_amount: number | null;
1351
+ /**
1352
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1353
+ * assessed.
1354
+ */
1355
+ local_tax_currency: string | null;
1356
+ /**
1357
+ * Fields specific to lodging.
1358
+ */
1359
+ lodging: PurchaseDetails.Lodging | null;
1360
+ /**
1361
+ * The national tax amount in minor units.
1362
+ */
1363
+ national_tax_amount: number | null;
1364
+ /**
1365
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1366
+ * assessed.
1367
+ */
1368
+ national_tax_currency: string | null;
1369
+ /**
1370
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
1371
+ */
1372
+ purchase_identifier: string | null;
1373
+ /**
1374
+ * The format of the purchase identifier.
1375
+ *
1376
+ * - `free_text` - Free text
1377
+ * - `order_number` - Order number
1378
+ * - `rental_agreement_number` - Rental agreement number
1379
+ * - `hotel_folio_number` - Hotel folio number
1380
+ * - `invoice_number` - Invoice number
1381
+ */
1382
+ purchase_identifier_format:
1383
+ | 'free_text'
1384
+ | 'order_number'
1385
+ | 'rental_agreement_number'
1386
+ | 'hotel_folio_number'
1387
+ | 'invoice_number'
1388
+ | null;
1389
+ /**
1390
+ * Fields specific to travel.
1391
+ */
1392
+ travel: PurchaseDetails.Travel | null;
1393
+ }
1394
+ namespace PurchaseDetails {
1395
+ /**
1396
+ * Fields specific to car rentals.
1397
+ */
1398
+ interface CarRental {
1399
+ /**
1400
+ * Code indicating the vehicle's class.
1401
+ */
1402
+ car_class_code: string | null;
1403
+ /**
1404
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
1405
+ * transaction, the scheduled pick up date.
1406
+ */
1407
+ checkout_date: string | null;
1408
+ /**
1409
+ * Daily rate being charged for the vehicle.
1410
+ */
1411
+ daily_rental_rate_amount: number | null;
1412
+ /**
1413
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
1414
+ * rate.
1415
+ */
1416
+ daily_rental_rate_currency: string | null;
1417
+ /**
1418
+ * Number of days the vehicle was rented.
1419
+ */
1420
+ days_rented: number | null;
1421
+ /**
1422
+ * Additional charges (gas, late fee, etc.) being billed.
1423
+ *
1424
+ * - `no_extra_charge` - No extra charge
1425
+ * - `gas` - Gas
1426
+ * - `extra_mileage` - Extra mileage
1427
+ * - `late_return` - Late return
1428
+ * - `one_way_service_fee` - One way service fee
1429
+ * - `parking_violation` - Parking violation
1430
+ */
1431
+ extra_charges:
1432
+ | 'no_extra_charge'
1433
+ | 'gas'
1434
+ | 'extra_mileage'
1435
+ | 'late_return'
1436
+ | 'one_way_service_fee'
1437
+ | 'parking_violation'
1438
+ | null;
1439
+ /**
1440
+ * Fuel charges for the vehicle.
1441
+ */
1442
+ fuel_charges_amount: number | null;
1443
+ /**
1444
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
1445
+ * assessed.
1446
+ */
1447
+ fuel_charges_currency: string | null;
1448
+ /**
1449
+ * Any insurance being charged for the vehicle.
1450
+ */
1451
+ insurance_charges_amount: number | null;
1452
+ /**
1453
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
1454
+ * charges assessed.
1455
+ */
1456
+ insurance_charges_currency: string | null;
1457
+ /**
1458
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
1459
+ * not actually rented (that is, a "no-show" charge).
1460
+ *
1461
+ * - `not_applicable` - Not applicable
1462
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
1463
+ */
1464
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
1465
+ /**
1466
+ * Charges for returning the vehicle at a different location than where it was
1467
+ * picked up.
1468
+ */
1469
+ one_way_drop_off_charges_amount: number | null;
1470
+ /**
1471
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
1472
+ * drop-off charges assessed.
1473
+ */
1474
+ one_way_drop_off_charges_currency: string | null;
1475
+ /**
1476
+ * Name of the person renting the vehicle.
1477
+ */
1478
+ renter_name: string | null;
1479
+ /**
1480
+ * Weekly rate being charged for the vehicle.
1481
+ */
1482
+ weekly_rental_rate_amount: number | null;
1483
+ /**
1484
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
1485
+ * rental rate.
1486
+ */
1487
+ weekly_rental_rate_currency: string | null;
1488
+ }
1489
+ /**
1490
+ * Fields specific to lodging.
1491
+ */
1492
+ interface Lodging {
1493
+ /**
1494
+ * Date the customer checked in.
1495
+ */
1496
+ check_in_date: string | null;
1497
+ /**
1498
+ * Daily rate being charged for the room.
1499
+ */
1500
+ daily_room_rate_amount: number | null;
1501
+ /**
1502
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
1503
+ * rate.
1504
+ */
1505
+ daily_room_rate_currency: string | null;
1506
+ /**
1507
+ * Additional charges (phone, late check-out, etc.) being billed.
1508
+ *
1509
+ * - `no_extra_charge` - No extra charge
1510
+ * - `restaurant` - Restaurant
1511
+ * - `gift_shop` - Gift shop
1512
+ * - `mini_bar` - Mini bar
1513
+ * - `telephone` - Telephone
1514
+ * - `other` - Other
1515
+ * - `laundry` - Laundry
1516
+ */
1517
+ extra_charges:
1518
+ | 'no_extra_charge'
1519
+ | 'restaurant'
1520
+ | 'gift_shop'
1521
+ | 'mini_bar'
1522
+ | 'telephone'
1523
+ | 'other'
1524
+ | 'laundry'
1525
+ | null;
1526
+ /**
1527
+ * Folio cash advances for the room.
1528
+ */
1529
+ folio_cash_advances_amount: number | null;
1530
+ /**
1531
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
1532
+ * advances.
1533
+ */
1534
+ folio_cash_advances_currency: string | null;
1535
+ /**
1536
+ * Food and beverage charges for the room.
1537
+ */
1538
+ food_beverage_charges_amount: number | null;
1539
+ /**
1540
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
1541
+ * beverage charges.
1542
+ */
1543
+ food_beverage_charges_currency: string | null;
1544
+ /**
1545
+ * Indicator that the cardholder is being billed for a reserved room that was not
1546
+ * actually used.
1547
+ *
1548
+ * - `not_applicable` - Not applicable
1549
+ * - `no_show` - No show
1550
+ */
1551
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
1552
+ /**
1553
+ * Prepaid expenses being charged for the room.
1554
+ */
1555
+ prepaid_expenses_amount: number | null;
1556
+ /**
1557
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
1558
+ * expenses.
1559
+ */
1560
+ prepaid_expenses_currency: string | null;
1561
+ /**
1562
+ * Number of nights the room was rented.
1563
+ */
1564
+ room_nights: number | null;
1565
+ /**
1566
+ * Total room tax being charged.
1567
+ */
1568
+ total_room_tax_amount: number | null;
1569
+ /**
1570
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
1571
+ * tax.
1572
+ */
1573
+ total_room_tax_currency: string | null;
1574
+ /**
1575
+ * Total tax being charged for the room.
1576
+ */
1577
+ total_tax_amount: number | null;
1578
+ /**
1579
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
1580
+ * assessed.
1581
+ */
1582
+ total_tax_currency: string | null;
1583
+ }
1584
+ /**
1585
+ * Fields specific to travel.
1586
+ */
1587
+ interface Travel {
1588
+ /**
1589
+ * Ancillary purchases in addition to the airfare.
1590
+ */
1591
+ ancillary: Travel.Ancillary | null;
1592
+ /**
1593
+ * Indicates the computerized reservation system used to book the ticket.
1594
+ */
1595
+ computerized_reservation_system: string | null;
1596
+ /**
1597
+ * Indicates the reason for a credit to the cardholder.
1598
+ *
1599
+ * - `no_credit` - No credit
1600
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1601
+ * ancillary purchase cancellation
1602
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1603
+ * Airline ticket and passenger transport ancillary purchase cancellation
1604
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
1605
+ * - `other` - Other
1606
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
1607
+ */
1608
+ credit_reason_indicator:
1609
+ | 'no_credit'
1610
+ | 'passenger_transport_ancillary_purchase_cancellation'
1611
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1612
+ | 'airline_ticket_cancellation'
1613
+ | 'other'
1614
+ | 'partial_refund_of_airline_ticket'
1615
+ | null;
1616
+ /**
1617
+ * Date of departure.
1618
+ */
1619
+ departure_date: string | null;
1620
+ /**
1621
+ * Code for the originating city or airport.
1622
+ */
1623
+ origination_city_airport_code: string | null;
1624
+ /**
1625
+ * Name of the passenger.
1626
+ */
1627
+ passenger_name: string | null;
1628
+ /**
1629
+ * Indicates whether this ticket is non-refundable.
1630
+ *
1631
+ * - `no_restrictions` - No restrictions
1632
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
1633
+ */
1634
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
1635
+ /**
1636
+ * Indicates why a ticket was changed.
1637
+ *
1638
+ * - `none` - None
1639
+ * - `change_to_existing_ticket` - Change to existing ticket
1640
+ * - `new_ticket` - New ticket
1641
+ */
1642
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
1643
+ /**
1644
+ * Ticket number.
1645
+ */
1646
+ ticket_number: string | null;
1647
+ /**
1648
+ * Code for the travel agency if the ticket was issued by a travel agency.
1649
+ */
1650
+ travel_agency_code: string | null;
1651
+ /**
1652
+ * Name of the travel agency if the ticket was issued by a travel agency.
1653
+ */
1654
+ travel_agency_name: string | null;
1655
+ /**
1656
+ * Fields specific to each leg of the journey.
1657
+ */
1658
+ trip_legs: Array<Travel.TripLeg> | null;
1659
+ }
1660
+ namespace Travel {
1661
+ /**
1662
+ * Ancillary purchases in addition to the airfare.
1663
+ */
1664
+ interface Ancillary {
1665
+ /**
1666
+ * If this purchase has a connection or relationship to another purchase, such as a
1667
+ * baggage fee for a passenger transport ticket, this field should contain the
1668
+ * ticket document number for the other purchase.
1669
+ */
1670
+ connected_ticket_document_number: string | null;
1671
+ /**
1672
+ * Indicates the reason for a credit to the cardholder.
1673
+ *
1674
+ * - `no_credit` - No credit
1675
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1676
+ * ancillary purchase cancellation
1677
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1678
+ * Airline ticket and passenger transport ancillary purchase cancellation
1679
+ * - `other` - Other
1680
+ */
1681
+ credit_reason_indicator:
1682
+ | 'no_credit'
1683
+ | 'passenger_transport_ancillary_purchase_cancellation'
1684
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1685
+ | 'other'
1686
+ | null;
1687
+ /**
1688
+ * Name of the passenger or description of the ancillary purchase.
1689
+ */
1690
+ passenger_name_or_description: string | null;
1691
+ /**
1692
+ * Additional travel charges, such as baggage fees.
1693
+ */
1694
+ services: Array<Ancillary.Service>;
1695
+ /**
1696
+ * Ticket document number.
1697
+ */
1698
+ ticket_document_number: string | null;
1699
+ }
1700
+ namespace Ancillary {
1701
+ interface Service {
1702
+ /**
1703
+ * Category of the ancillary service.
1704
+ *
1705
+ * - `none` - None
1706
+ * - `bundled_service` - Bundled service
1707
+ * - `baggage_fee` - Baggage fee
1708
+ * - `change_fee` - Change fee
1709
+ * - `cargo` - Cargo
1710
+ * - `carbon_offset` - Carbon offset
1711
+ * - `frequent_flyer` - Frequent flyer
1712
+ * - `gift_card` - Gift card
1713
+ * - `ground_transport` - Ground transport
1714
+ * - `in_flight_entertainment` - In-flight entertainment
1715
+ * - `lounge` - Lounge
1716
+ * - `medical` - Medical
1717
+ * - `meal_beverage` - Meal beverage
1718
+ * - `other` - Other
1719
+ * - `passenger_assist_fee` - Passenger assist fee
1720
+ * - `pets` - Pets
1721
+ * - `seat_fees` - Seat fees
1722
+ * - `standby` - Standby
1723
+ * - `service_fee` - Service fee
1724
+ * - `store` - Store
1725
+ * - `travel_service` - Travel service
1726
+ * - `unaccompanied_travel` - Unaccompanied travel
1727
+ * - `upgrades` - Upgrades
1728
+ * - `wifi` - Wi-fi
1729
+ */
1730
+ category:
1731
+ | 'none'
1732
+ | 'bundled_service'
1733
+ | 'baggage_fee'
1734
+ | 'change_fee'
1735
+ | 'cargo'
1736
+ | 'carbon_offset'
1737
+ | 'frequent_flyer'
1738
+ | 'gift_card'
1739
+ | 'ground_transport'
1740
+ | 'in_flight_entertainment'
1741
+ | 'lounge'
1742
+ | 'medical'
1743
+ | 'meal_beverage'
1744
+ | 'other'
1745
+ | 'passenger_assist_fee'
1746
+ | 'pets'
1747
+ | 'seat_fees'
1748
+ | 'standby'
1749
+ | 'service_fee'
1750
+ | 'store'
1751
+ | 'travel_service'
1752
+ | 'unaccompanied_travel'
1753
+ | 'upgrades'
1754
+ | 'wifi'
1755
+ | null;
1756
+ /**
1757
+ * Sub-category of the ancillary service, free-form.
1758
+ */
1759
+ sub_category: string | null;
1760
+ }
1761
+ }
1762
+ interface TripLeg {
1763
+ /**
1764
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
1765
+ */
1766
+ carrier_code: string | null;
1767
+ /**
1768
+ * Code for the destination city or airport.
1769
+ */
1770
+ destination_city_airport_code: string | null;
1771
+ /**
1772
+ * Fare basis code.
1773
+ */
1774
+ fare_basis_code: string | null;
1775
+ /**
1776
+ * Flight number.
1777
+ */
1778
+ flight_number: string | null;
1779
+ /**
1780
+ * Service class (e.g., first class, business class, etc.).
1781
+ */
1782
+ service_class: string | null;
1783
+ /**
1784
+ * Indicates whether a stopover is allowed on this ticket.
1785
+ *
1786
+ * - `none` - None
1787
+ * - `stop_over_allowed` - Stop over allowed
1788
+ * - `stop_over_not_allowed` - Stop over not allowed
1789
+ */
1790
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
1791
+ }
1792
+ }
1793
+ }
1794
+ }
869
1795
  /**
870
1796
  * A Check Deposit Acceptance object. This field will be present in the JSON
871
1797
  * response if and only if `category` is equal to `check_deposit_acceptance`.
@@ -1054,16 +1980,6 @@ export declare namespace InterestPaymentSimulationResult {
1054
1980
  */
1055
1981
  transfer_id: string;
1056
1982
  }
1057
- /**
1058
- * A Check Transfer Rejection object. This field will be present in the JSON
1059
- * response if and only if `category` is equal to `check_transfer_rejection`.
1060
- */
1061
- interface CheckTransferRejection {
1062
- /**
1063
- * The identifier of the Check Transfer that led to this Transaction.
1064
- */
1065
- transfer_id: string;
1066
- }
1067
1983
  /**
1068
1984
  * A Check Transfer Stop Payment Request object. This field will be present in the
1069
1985
  * JSON response if and only if `category` is equal to
@@ -1074,9 +1990,11 @@ export declare namespace InterestPaymentSimulationResult {
1074
1990
  * The reason why this transfer was stopped.
1075
1991
  *
1076
1992
  * - `mail_delivery_failed` - The check could not be delivered.
1993
+ * - `rejected_by_increase` - The check was cancelled by an Increase operator who
1994
+ * will provide details out-of-band.
1077
1995
  * - `unknown` - The check was stopped for another reason.
1078
1996
  */
1079
- reason: 'mail_delivery_failed' | 'unknown';
1997
+ reason: 'mail_delivery_failed' | 'rejected_by_increase' | 'unknown';
1080
1998
  /**
1081
1999
  * The time the stop-payment was requested.
1082
2000
  */
@@ -1484,6 +2402,7 @@ export declare namespace InterestPaymentSimulationResult {
1484
2402
  * - `account_closure` - Account closure
1485
2403
  * - `bank_migration` - Bank migration
1486
2404
  * - `cashback` - Cashback
2405
+ * - `check_adjustment` - Check adjustment
1487
2406
  * - `collection_receivable` - Collection receivable
1488
2407
  * - `empyreal_adjustment` - Empyreal adjustment
1489
2408
  * - `error` - Error
@@ -1498,6 +2417,7 @@ export declare namespace InterestPaymentSimulationResult {
1498
2417
  | 'account_closure'
1499
2418
  | 'bank_migration'
1500
2419
  | 'cashback'
2420
+ | 'check_adjustment'
1501
2421
  | 'collection_receivable'
1502
2422
  | 'empyreal_adjustment'
1503
2423
  | 'error'
@@ -1587,6 +2507,14 @@ export interface InterestPaymentCreateParams {
1587
2507
  * The interest amount in cents. Must be positive.
1588
2508
  */
1589
2509
  amount: number;
2510
+ /**
2511
+ * The end of the interest period. If not provided, defaults to the current time.
2512
+ */
2513
+ period_end?: string;
2514
+ /**
2515
+ * The start of the interest period. If not provided, defaults to the current time.
2516
+ */
2517
+ period_start?: string;
1590
2518
  }
1591
2519
  export declare namespace InterestPayments {
1592
2520
  export import InterestPaymentSimulationResult = API.InterestPaymentSimulationResult;