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
@@ -2,7 +2,7 @@
2
2
 
3
3
  import * as Core from '../../core';
4
4
  import { APIResource } from '../../resource';
5
- import * as API from '.';
5
+ import * as API from './index';
6
6
 
7
7
  export class InterestPayments extends APIResource {
8
8
  /**
@@ -199,8 +199,6 @@ export namespace InterestPaymentSimulationResult {
199
199
  * Deposit object. Details will be under the `check_transfer_deposit` object.
200
200
  * - `check_transfer_intention` - The Transaction was created by a Check Transfer
201
201
  * Intention object. Details will be under the `check_transfer_intention` object.
202
- * - `check_transfer_rejection` - The Transaction was created by a Check Transfer
203
- * Rejection object. Details will be under the `check_transfer_rejection` object.
204
202
  * - `check_transfer_stop_payment_request` - The Transaction was created by a Check
205
203
  * Transfer Stop Payment Request object. Details will be under the
206
204
  * `check_transfer_stop_payment_request` object.
@@ -257,7 +255,6 @@ export namespace InterestPaymentSimulationResult {
257
255
  | 'check_deposit_return'
258
256
  | 'check_transfer_deposit'
259
257
  | 'check_transfer_intention'
260
- | 'check_transfer_rejection'
261
258
  | 'check_transfer_stop_payment_request'
262
259
  | 'fee_payment'
263
260
  | 'inbound_ach_transfer'
@@ -301,12 +298,6 @@ export namespace InterestPaymentSimulationResult {
301
298
  */
302
299
  check_transfer_intention: Source.CheckTransferIntention | null;
303
300
 
304
- /**
305
- * A Check Transfer Rejection object. This field will be present in the JSON
306
- * response if and only if `category` is equal to `check_transfer_rejection`.
307
- */
308
- check_transfer_rejection: Source.CheckTransferRejection | null;
309
-
310
301
  /**
311
302
  * A Check Transfer Stop Payment Request object. This field will be present in the
312
303
  * JSON response if and only if `category` is equal to
@@ -819,6 +810,12 @@ export namespace InterestPaymentSimulationResult {
819
810
  */
820
811
  merchant_state: string | null;
821
812
 
813
+ /**
814
+ * Additional details about the card purchase, such as tax and industry-specific
815
+ * fields.
816
+ */
817
+ purchase_details: CardRefund.PurchaseDetails | null;
818
+
822
819
  /**
823
820
  * The identifier of the Transaction associated with this Transaction.
824
821
  */
@@ -831,6 +828,535 @@ export namespace InterestPaymentSimulationResult {
831
828
  type: 'card_refund';
832
829
  }
833
830
 
831
+ export namespace CardRefund {
832
+ /**
833
+ * Additional details about the card purchase, such as tax and industry-specific
834
+ * fields.
835
+ */
836
+ export interface PurchaseDetails {
837
+ /**
838
+ * Fields specific to car rentals.
839
+ */
840
+ car_rental: PurchaseDetails.CarRental | null;
841
+
842
+ /**
843
+ * An identifier from the merchant for the customer or consumer.
844
+ */
845
+ customer_reference_identifier: string | null;
846
+
847
+ /**
848
+ * The state or provincial tax amount in minor units.
849
+ */
850
+ local_tax_amount: number | null;
851
+
852
+ /**
853
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
854
+ * assessed.
855
+ */
856
+ local_tax_currency: string | null;
857
+
858
+ /**
859
+ * Fields specific to lodging.
860
+ */
861
+ lodging: PurchaseDetails.Lodging | null;
862
+
863
+ /**
864
+ * The national tax amount in minor units.
865
+ */
866
+ national_tax_amount: number | null;
867
+
868
+ /**
869
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
870
+ * assessed.
871
+ */
872
+ national_tax_currency: string | null;
873
+
874
+ /**
875
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
876
+ */
877
+ purchase_identifier: string | null;
878
+
879
+ /**
880
+ * The format of the purchase identifier.
881
+ *
882
+ * - `free_text` - Free text
883
+ * - `order_number` - Order number
884
+ * - `rental_agreement_number` - Rental agreement number
885
+ * - `hotel_folio_number` - Hotel folio number
886
+ * - `invoice_number` - Invoice number
887
+ */
888
+ purchase_identifier_format:
889
+ | 'free_text'
890
+ | 'order_number'
891
+ | 'rental_agreement_number'
892
+ | 'hotel_folio_number'
893
+ | 'invoice_number'
894
+ | null;
895
+
896
+ /**
897
+ * Fields specific to travel.
898
+ */
899
+ travel: PurchaseDetails.Travel | null;
900
+ }
901
+
902
+ export namespace PurchaseDetails {
903
+ /**
904
+ * Fields specific to car rentals.
905
+ */
906
+ export interface CarRental {
907
+ /**
908
+ * Code indicating the vehicle's class.
909
+ */
910
+ car_class_code: string | null;
911
+
912
+ /**
913
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
914
+ * transaction, the scheduled pick up date.
915
+ */
916
+ checkout_date: string | null;
917
+
918
+ /**
919
+ * Daily rate being charged for the vehicle.
920
+ */
921
+ daily_rental_rate_amount: number | null;
922
+
923
+ /**
924
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
925
+ * rate.
926
+ */
927
+ daily_rental_rate_currency: string | null;
928
+
929
+ /**
930
+ * Number of days the vehicle was rented.
931
+ */
932
+ days_rented: number | null;
933
+
934
+ /**
935
+ * Additional charges (gas, late fee, etc.) being billed.
936
+ *
937
+ * - `no_extra_charge` - No extra charge
938
+ * - `gas` - Gas
939
+ * - `extra_mileage` - Extra mileage
940
+ * - `late_return` - Late return
941
+ * - `one_way_service_fee` - One way service fee
942
+ * - `parking_violation` - Parking violation
943
+ */
944
+ extra_charges:
945
+ | 'no_extra_charge'
946
+ | 'gas'
947
+ | 'extra_mileage'
948
+ | 'late_return'
949
+ | 'one_way_service_fee'
950
+ | 'parking_violation'
951
+ | null;
952
+
953
+ /**
954
+ * Fuel charges for the vehicle.
955
+ */
956
+ fuel_charges_amount: number | null;
957
+
958
+ /**
959
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
960
+ * assessed.
961
+ */
962
+ fuel_charges_currency: string | null;
963
+
964
+ /**
965
+ * Any insurance being charged for the vehicle.
966
+ */
967
+ insurance_charges_amount: number | null;
968
+
969
+ /**
970
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
971
+ * charges assessed.
972
+ */
973
+ insurance_charges_currency: string | null;
974
+
975
+ /**
976
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
977
+ * not actually rented (that is, a "no-show" charge).
978
+ *
979
+ * - `not_applicable` - Not applicable
980
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
981
+ */
982
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
983
+
984
+ /**
985
+ * Charges for returning the vehicle at a different location than where it was
986
+ * picked up.
987
+ */
988
+ one_way_drop_off_charges_amount: number | null;
989
+
990
+ /**
991
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
992
+ * drop-off charges assessed.
993
+ */
994
+ one_way_drop_off_charges_currency: string | null;
995
+
996
+ /**
997
+ * Name of the person renting the vehicle.
998
+ */
999
+ renter_name: string | null;
1000
+
1001
+ /**
1002
+ * Weekly rate being charged for the vehicle.
1003
+ */
1004
+ weekly_rental_rate_amount: number | null;
1005
+
1006
+ /**
1007
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
1008
+ * rental rate.
1009
+ */
1010
+ weekly_rental_rate_currency: string | null;
1011
+ }
1012
+
1013
+ /**
1014
+ * Fields specific to lodging.
1015
+ */
1016
+ export interface Lodging {
1017
+ /**
1018
+ * Date the customer checked in.
1019
+ */
1020
+ check_in_date: string | null;
1021
+
1022
+ /**
1023
+ * Daily rate being charged for the room.
1024
+ */
1025
+ daily_room_rate_amount: number | null;
1026
+
1027
+ /**
1028
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
1029
+ * rate.
1030
+ */
1031
+ daily_room_rate_currency: string | null;
1032
+
1033
+ /**
1034
+ * Additional charges (phone, late check-out, etc.) being billed.
1035
+ *
1036
+ * - `no_extra_charge` - No extra charge
1037
+ * - `restaurant` - Restaurant
1038
+ * - `gift_shop` - Gift shop
1039
+ * - `mini_bar` - Mini bar
1040
+ * - `telephone` - Telephone
1041
+ * - `other` - Other
1042
+ * - `laundry` - Laundry
1043
+ */
1044
+ extra_charges:
1045
+ | 'no_extra_charge'
1046
+ | 'restaurant'
1047
+ | 'gift_shop'
1048
+ | 'mini_bar'
1049
+ | 'telephone'
1050
+ | 'other'
1051
+ | 'laundry'
1052
+ | null;
1053
+
1054
+ /**
1055
+ * Folio cash advances for the room.
1056
+ */
1057
+ folio_cash_advances_amount: number | null;
1058
+
1059
+ /**
1060
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
1061
+ * advances.
1062
+ */
1063
+ folio_cash_advances_currency: string | null;
1064
+
1065
+ /**
1066
+ * Food and beverage charges for the room.
1067
+ */
1068
+ food_beverage_charges_amount: number | null;
1069
+
1070
+ /**
1071
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
1072
+ * beverage charges.
1073
+ */
1074
+ food_beverage_charges_currency: string | null;
1075
+
1076
+ /**
1077
+ * Indicator that the cardholder is being billed for a reserved room that was not
1078
+ * actually used.
1079
+ *
1080
+ * - `not_applicable` - Not applicable
1081
+ * - `no_show` - No show
1082
+ */
1083
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
1084
+
1085
+ /**
1086
+ * Prepaid expenses being charged for the room.
1087
+ */
1088
+ prepaid_expenses_amount: number | null;
1089
+
1090
+ /**
1091
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
1092
+ * expenses.
1093
+ */
1094
+ prepaid_expenses_currency: string | null;
1095
+
1096
+ /**
1097
+ * Number of nights the room was rented.
1098
+ */
1099
+ room_nights: number | null;
1100
+
1101
+ /**
1102
+ * Total room tax being charged.
1103
+ */
1104
+ total_room_tax_amount: number | null;
1105
+
1106
+ /**
1107
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
1108
+ * tax.
1109
+ */
1110
+ total_room_tax_currency: string | null;
1111
+
1112
+ /**
1113
+ * Total tax being charged for the room.
1114
+ */
1115
+ total_tax_amount: number | null;
1116
+
1117
+ /**
1118
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
1119
+ * assessed.
1120
+ */
1121
+ total_tax_currency: string | null;
1122
+ }
1123
+
1124
+ /**
1125
+ * Fields specific to travel.
1126
+ */
1127
+ export interface Travel {
1128
+ /**
1129
+ * Ancillary purchases in addition to the airfare.
1130
+ */
1131
+ ancillary: Travel.Ancillary | null;
1132
+
1133
+ /**
1134
+ * Indicates the computerized reservation system used to book the ticket.
1135
+ */
1136
+ computerized_reservation_system: string | null;
1137
+
1138
+ /**
1139
+ * Indicates the reason for a credit to the cardholder.
1140
+ *
1141
+ * - `no_credit` - No credit
1142
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1143
+ * ancillary purchase cancellation
1144
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1145
+ * Airline ticket and passenger transport ancillary purchase cancellation
1146
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
1147
+ * - `other` - Other
1148
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
1149
+ */
1150
+ credit_reason_indicator:
1151
+ | 'no_credit'
1152
+ | 'passenger_transport_ancillary_purchase_cancellation'
1153
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1154
+ | 'airline_ticket_cancellation'
1155
+ | 'other'
1156
+ | 'partial_refund_of_airline_ticket'
1157
+ | null;
1158
+
1159
+ /**
1160
+ * Date of departure.
1161
+ */
1162
+ departure_date: string | null;
1163
+
1164
+ /**
1165
+ * Code for the originating city or airport.
1166
+ */
1167
+ origination_city_airport_code: string | null;
1168
+
1169
+ /**
1170
+ * Name of the passenger.
1171
+ */
1172
+ passenger_name: string | null;
1173
+
1174
+ /**
1175
+ * Indicates whether this ticket is non-refundable.
1176
+ *
1177
+ * - `no_restrictions` - No restrictions
1178
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
1179
+ */
1180
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
1181
+
1182
+ /**
1183
+ * Indicates why a ticket was changed.
1184
+ *
1185
+ * - `none` - None
1186
+ * - `change_to_existing_ticket` - Change to existing ticket
1187
+ * - `new_ticket` - New ticket
1188
+ */
1189
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
1190
+
1191
+ /**
1192
+ * Ticket number.
1193
+ */
1194
+ ticket_number: string | null;
1195
+
1196
+ /**
1197
+ * Code for the travel agency if the ticket was issued by a travel agency.
1198
+ */
1199
+ travel_agency_code: string | null;
1200
+
1201
+ /**
1202
+ * Name of the travel agency if the ticket was issued by a travel agency.
1203
+ */
1204
+ travel_agency_name: string | null;
1205
+
1206
+ /**
1207
+ * Fields specific to each leg of the journey.
1208
+ */
1209
+ trip_legs: Array<Travel.TripLeg> | null;
1210
+ }
1211
+
1212
+ export namespace Travel {
1213
+ /**
1214
+ * Ancillary purchases in addition to the airfare.
1215
+ */
1216
+ export interface Ancillary {
1217
+ /**
1218
+ * If this purchase has a connection or relationship to another purchase, such as a
1219
+ * baggage fee for a passenger transport ticket, this field should contain the
1220
+ * ticket document number for the other purchase.
1221
+ */
1222
+ connected_ticket_document_number: string | null;
1223
+
1224
+ /**
1225
+ * Indicates the reason for a credit to the cardholder.
1226
+ *
1227
+ * - `no_credit` - No credit
1228
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1229
+ * ancillary purchase cancellation
1230
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1231
+ * Airline ticket and passenger transport ancillary purchase cancellation
1232
+ * - `other` - Other
1233
+ */
1234
+ credit_reason_indicator:
1235
+ | 'no_credit'
1236
+ | 'passenger_transport_ancillary_purchase_cancellation'
1237
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1238
+ | 'other'
1239
+ | null;
1240
+
1241
+ /**
1242
+ * Name of the passenger or description of the ancillary purchase.
1243
+ */
1244
+ passenger_name_or_description: string | null;
1245
+
1246
+ /**
1247
+ * Additional travel charges, such as baggage fees.
1248
+ */
1249
+ services: Array<Ancillary.Service>;
1250
+
1251
+ /**
1252
+ * Ticket document number.
1253
+ */
1254
+ ticket_document_number: string | null;
1255
+ }
1256
+
1257
+ export namespace Ancillary {
1258
+ export interface Service {
1259
+ /**
1260
+ * Category of the ancillary service.
1261
+ *
1262
+ * - `none` - None
1263
+ * - `bundled_service` - Bundled service
1264
+ * - `baggage_fee` - Baggage fee
1265
+ * - `change_fee` - Change fee
1266
+ * - `cargo` - Cargo
1267
+ * - `carbon_offset` - Carbon offset
1268
+ * - `frequent_flyer` - Frequent flyer
1269
+ * - `gift_card` - Gift card
1270
+ * - `ground_transport` - Ground transport
1271
+ * - `in_flight_entertainment` - In-flight entertainment
1272
+ * - `lounge` - Lounge
1273
+ * - `medical` - Medical
1274
+ * - `meal_beverage` - Meal beverage
1275
+ * - `other` - Other
1276
+ * - `passenger_assist_fee` - Passenger assist fee
1277
+ * - `pets` - Pets
1278
+ * - `seat_fees` - Seat fees
1279
+ * - `standby` - Standby
1280
+ * - `service_fee` - Service fee
1281
+ * - `store` - Store
1282
+ * - `travel_service` - Travel service
1283
+ * - `unaccompanied_travel` - Unaccompanied travel
1284
+ * - `upgrades` - Upgrades
1285
+ * - `wifi` - Wi-fi
1286
+ */
1287
+ category:
1288
+ | 'none'
1289
+ | 'bundled_service'
1290
+ | 'baggage_fee'
1291
+ | 'change_fee'
1292
+ | 'cargo'
1293
+ | 'carbon_offset'
1294
+ | 'frequent_flyer'
1295
+ | 'gift_card'
1296
+ | 'ground_transport'
1297
+ | 'in_flight_entertainment'
1298
+ | 'lounge'
1299
+ | 'medical'
1300
+ | 'meal_beverage'
1301
+ | 'other'
1302
+ | 'passenger_assist_fee'
1303
+ | 'pets'
1304
+ | 'seat_fees'
1305
+ | 'standby'
1306
+ | 'service_fee'
1307
+ | 'store'
1308
+ | 'travel_service'
1309
+ | 'unaccompanied_travel'
1310
+ | 'upgrades'
1311
+ | 'wifi'
1312
+ | null;
1313
+
1314
+ /**
1315
+ * Sub-category of the ancillary service, free-form.
1316
+ */
1317
+ sub_category: string | null;
1318
+ }
1319
+ }
1320
+
1321
+ export interface TripLeg {
1322
+ /**
1323
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
1324
+ */
1325
+ carrier_code: string | null;
1326
+
1327
+ /**
1328
+ * Code for the destination city or airport.
1329
+ */
1330
+ destination_city_airport_code: string | null;
1331
+
1332
+ /**
1333
+ * Fare basis code.
1334
+ */
1335
+ fare_basis_code: string | null;
1336
+
1337
+ /**
1338
+ * Flight number.
1339
+ */
1340
+ flight_number: string | null;
1341
+
1342
+ /**
1343
+ * Service class (e.g., first class, business class, etc.).
1344
+ */
1345
+ service_class: string | null;
1346
+
1347
+ /**
1348
+ * Indicates whether a stopover is allowed on this ticket.
1349
+ *
1350
+ * - `none` - None
1351
+ * - `stop_over_allowed` - Stop over allowed
1352
+ * - `stop_over_not_allowed` - Stop over not allowed
1353
+ */
1354
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
1355
+ }
1356
+ }
1357
+ }
1358
+ }
1359
+
834
1360
  /**
835
1361
  * A Card Revenue Payment object. This field will be present in the JSON response
836
1362
  * if and only if `category` is equal to `card_revenue_payment`.
@@ -953,6 +1479,12 @@ export namespace InterestPaymentSimulationResult {
953
1479
  */
954
1480
  presentment_currency: string;
955
1481
 
1482
+ /**
1483
+ * Additional details about the card purchase, such as tax and industry-specific
1484
+ * fields.
1485
+ */
1486
+ purchase_details: CardSettlement.PurchaseDetails | null;
1487
+
956
1488
  /**
957
1489
  * The identifier of the Transaction associated with this Transaction.
958
1490
  */
@@ -965,6 +1497,535 @@ export namespace InterestPaymentSimulationResult {
965
1497
  type: 'card_settlement';
966
1498
  }
967
1499
 
1500
+ export namespace CardSettlement {
1501
+ /**
1502
+ * Additional details about the card purchase, such as tax and industry-specific
1503
+ * fields.
1504
+ */
1505
+ export interface PurchaseDetails {
1506
+ /**
1507
+ * Fields specific to car rentals.
1508
+ */
1509
+ car_rental: PurchaseDetails.CarRental | null;
1510
+
1511
+ /**
1512
+ * An identifier from the merchant for the customer or consumer.
1513
+ */
1514
+ customer_reference_identifier: string | null;
1515
+
1516
+ /**
1517
+ * The state or provincial tax amount in minor units.
1518
+ */
1519
+ local_tax_amount: number | null;
1520
+
1521
+ /**
1522
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1523
+ * assessed.
1524
+ */
1525
+ local_tax_currency: string | null;
1526
+
1527
+ /**
1528
+ * Fields specific to lodging.
1529
+ */
1530
+ lodging: PurchaseDetails.Lodging | null;
1531
+
1532
+ /**
1533
+ * The national tax amount in minor units.
1534
+ */
1535
+ national_tax_amount: number | null;
1536
+
1537
+ /**
1538
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1539
+ * assessed.
1540
+ */
1541
+ national_tax_currency: string | null;
1542
+
1543
+ /**
1544
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
1545
+ */
1546
+ purchase_identifier: string | null;
1547
+
1548
+ /**
1549
+ * The format of the purchase identifier.
1550
+ *
1551
+ * - `free_text` - Free text
1552
+ * - `order_number` - Order number
1553
+ * - `rental_agreement_number` - Rental agreement number
1554
+ * - `hotel_folio_number` - Hotel folio number
1555
+ * - `invoice_number` - Invoice number
1556
+ */
1557
+ purchase_identifier_format:
1558
+ | 'free_text'
1559
+ | 'order_number'
1560
+ | 'rental_agreement_number'
1561
+ | 'hotel_folio_number'
1562
+ | 'invoice_number'
1563
+ | null;
1564
+
1565
+ /**
1566
+ * Fields specific to travel.
1567
+ */
1568
+ travel: PurchaseDetails.Travel | null;
1569
+ }
1570
+
1571
+ export namespace PurchaseDetails {
1572
+ /**
1573
+ * Fields specific to car rentals.
1574
+ */
1575
+ export interface CarRental {
1576
+ /**
1577
+ * Code indicating the vehicle's class.
1578
+ */
1579
+ car_class_code: string | null;
1580
+
1581
+ /**
1582
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
1583
+ * transaction, the scheduled pick up date.
1584
+ */
1585
+ checkout_date: string | null;
1586
+
1587
+ /**
1588
+ * Daily rate being charged for the vehicle.
1589
+ */
1590
+ daily_rental_rate_amount: number | null;
1591
+
1592
+ /**
1593
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
1594
+ * rate.
1595
+ */
1596
+ daily_rental_rate_currency: string | null;
1597
+
1598
+ /**
1599
+ * Number of days the vehicle was rented.
1600
+ */
1601
+ days_rented: number | null;
1602
+
1603
+ /**
1604
+ * Additional charges (gas, late fee, etc.) being billed.
1605
+ *
1606
+ * - `no_extra_charge` - No extra charge
1607
+ * - `gas` - Gas
1608
+ * - `extra_mileage` - Extra mileage
1609
+ * - `late_return` - Late return
1610
+ * - `one_way_service_fee` - One way service fee
1611
+ * - `parking_violation` - Parking violation
1612
+ */
1613
+ extra_charges:
1614
+ | 'no_extra_charge'
1615
+ | 'gas'
1616
+ | 'extra_mileage'
1617
+ | 'late_return'
1618
+ | 'one_way_service_fee'
1619
+ | 'parking_violation'
1620
+ | null;
1621
+
1622
+ /**
1623
+ * Fuel charges for the vehicle.
1624
+ */
1625
+ fuel_charges_amount: number | null;
1626
+
1627
+ /**
1628
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
1629
+ * assessed.
1630
+ */
1631
+ fuel_charges_currency: string | null;
1632
+
1633
+ /**
1634
+ * Any insurance being charged for the vehicle.
1635
+ */
1636
+ insurance_charges_amount: number | null;
1637
+
1638
+ /**
1639
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
1640
+ * charges assessed.
1641
+ */
1642
+ insurance_charges_currency: string | null;
1643
+
1644
+ /**
1645
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
1646
+ * not actually rented (that is, a "no-show" charge).
1647
+ *
1648
+ * - `not_applicable` - Not applicable
1649
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
1650
+ */
1651
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
1652
+
1653
+ /**
1654
+ * Charges for returning the vehicle at a different location than where it was
1655
+ * picked up.
1656
+ */
1657
+ one_way_drop_off_charges_amount: number | null;
1658
+
1659
+ /**
1660
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
1661
+ * drop-off charges assessed.
1662
+ */
1663
+ one_way_drop_off_charges_currency: string | null;
1664
+
1665
+ /**
1666
+ * Name of the person renting the vehicle.
1667
+ */
1668
+ renter_name: string | null;
1669
+
1670
+ /**
1671
+ * Weekly rate being charged for the vehicle.
1672
+ */
1673
+ weekly_rental_rate_amount: number | null;
1674
+
1675
+ /**
1676
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
1677
+ * rental rate.
1678
+ */
1679
+ weekly_rental_rate_currency: string | null;
1680
+ }
1681
+
1682
+ /**
1683
+ * Fields specific to lodging.
1684
+ */
1685
+ export interface Lodging {
1686
+ /**
1687
+ * Date the customer checked in.
1688
+ */
1689
+ check_in_date: string | null;
1690
+
1691
+ /**
1692
+ * Daily rate being charged for the room.
1693
+ */
1694
+ daily_room_rate_amount: number | null;
1695
+
1696
+ /**
1697
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
1698
+ * rate.
1699
+ */
1700
+ daily_room_rate_currency: string | null;
1701
+
1702
+ /**
1703
+ * Additional charges (phone, late check-out, etc.) being billed.
1704
+ *
1705
+ * - `no_extra_charge` - No extra charge
1706
+ * - `restaurant` - Restaurant
1707
+ * - `gift_shop` - Gift shop
1708
+ * - `mini_bar` - Mini bar
1709
+ * - `telephone` - Telephone
1710
+ * - `other` - Other
1711
+ * - `laundry` - Laundry
1712
+ */
1713
+ extra_charges:
1714
+ | 'no_extra_charge'
1715
+ | 'restaurant'
1716
+ | 'gift_shop'
1717
+ | 'mini_bar'
1718
+ | 'telephone'
1719
+ | 'other'
1720
+ | 'laundry'
1721
+ | null;
1722
+
1723
+ /**
1724
+ * Folio cash advances for the room.
1725
+ */
1726
+ folio_cash_advances_amount: number | null;
1727
+
1728
+ /**
1729
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
1730
+ * advances.
1731
+ */
1732
+ folio_cash_advances_currency: string | null;
1733
+
1734
+ /**
1735
+ * Food and beverage charges for the room.
1736
+ */
1737
+ food_beverage_charges_amount: number | null;
1738
+
1739
+ /**
1740
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
1741
+ * beverage charges.
1742
+ */
1743
+ food_beverage_charges_currency: string | null;
1744
+
1745
+ /**
1746
+ * Indicator that the cardholder is being billed for a reserved room that was not
1747
+ * actually used.
1748
+ *
1749
+ * - `not_applicable` - Not applicable
1750
+ * - `no_show` - No show
1751
+ */
1752
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
1753
+
1754
+ /**
1755
+ * Prepaid expenses being charged for the room.
1756
+ */
1757
+ prepaid_expenses_amount: number | null;
1758
+
1759
+ /**
1760
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
1761
+ * expenses.
1762
+ */
1763
+ prepaid_expenses_currency: string | null;
1764
+
1765
+ /**
1766
+ * Number of nights the room was rented.
1767
+ */
1768
+ room_nights: number | null;
1769
+
1770
+ /**
1771
+ * Total room tax being charged.
1772
+ */
1773
+ total_room_tax_amount: number | null;
1774
+
1775
+ /**
1776
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
1777
+ * tax.
1778
+ */
1779
+ total_room_tax_currency: string | null;
1780
+
1781
+ /**
1782
+ * Total tax being charged for the room.
1783
+ */
1784
+ total_tax_amount: number | null;
1785
+
1786
+ /**
1787
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
1788
+ * assessed.
1789
+ */
1790
+ total_tax_currency: string | null;
1791
+ }
1792
+
1793
+ /**
1794
+ * Fields specific to travel.
1795
+ */
1796
+ export interface Travel {
1797
+ /**
1798
+ * Ancillary purchases in addition to the airfare.
1799
+ */
1800
+ ancillary: Travel.Ancillary | null;
1801
+
1802
+ /**
1803
+ * Indicates the computerized reservation system used to book the ticket.
1804
+ */
1805
+ computerized_reservation_system: string | null;
1806
+
1807
+ /**
1808
+ * Indicates the reason for a credit to the cardholder.
1809
+ *
1810
+ * - `no_credit` - No credit
1811
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1812
+ * ancillary purchase cancellation
1813
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1814
+ * Airline ticket and passenger transport ancillary purchase cancellation
1815
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
1816
+ * - `other` - Other
1817
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
1818
+ */
1819
+ credit_reason_indicator:
1820
+ | 'no_credit'
1821
+ | 'passenger_transport_ancillary_purchase_cancellation'
1822
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1823
+ | 'airline_ticket_cancellation'
1824
+ | 'other'
1825
+ | 'partial_refund_of_airline_ticket'
1826
+ | null;
1827
+
1828
+ /**
1829
+ * Date of departure.
1830
+ */
1831
+ departure_date: string | null;
1832
+
1833
+ /**
1834
+ * Code for the originating city or airport.
1835
+ */
1836
+ origination_city_airport_code: string | null;
1837
+
1838
+ /**
1839
+ * Name of the passenger.
1840
+ */
1841
+ passenger_name: string | null;
1842
+
1843
+ /**
1844
+ * Indicates whether this ticket is non-refundable.
1845
+ *
1846
+ * - `no_restrictions` - No restrictions
1847
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
1848
+ */
1849
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
1850
+
1851
+ /**
1852
+ * Indicates why a ticket was changed.
1853
+ *
1854
+ * - `none` - None
1855
+ * - `change_to_existing_ticket` - Change to existing ticket
1856
+ * - `new_ticket` - New ticket
1857
+ */
1858
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
1859
+
1860
+ /**
1861
+ * Ticket number.
1862
+ */
1863
+ ticket_number: string | null;
1864
+
1865
+ /**
1866
+ * Code for the travel agency if the ticket was issued by a travel agency.
1867
+ */
1868
+ travel_agency_code: string | null;
1869
+
1870
+ /**
1871
+ * Name of the travel agency if the ticket was issued by a travel agency.
1872
+ */
1873
+ travel_agency_name: string | null;
1874
+
1875
+ /**
1876
+ * Fields specific to each leg of the journey.
1877
+ */
1878
+ trip_legs: Array<Travel.TripLeg> | null;
1879
+ }
1880
+
1881
+ export namespace Travel {
1882
+ /**
1883
+ * Ancillary purchases in addition to the airfare.
1884
+ */
1885
+ export interface Ancillary {
1886
+ /**
1887
+ * If this purchase has a connection or relationship to another purchase, such as a
1888
+ * baggage fee for a passenger transport ticket, this field should contain the
1889
+ * ticket document number for the other purchase.
1890
+ */
1891
+ connected_ticket_document_number: string | null;
1892
+
1893
+ /**
1894
+ * Indicates the reason for a credit to the cardholder.
1895
+ *
1896
+ * - `no_credit` - No credit
1897
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1898
+ * ancillary purchase cancellation
1899
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1900
+ * Airline ticket and passenger transport ancillary purchase cancellation
1901
+ * - `other` - Other
1902
+ */
1903
+ credit_reason_indicator:
1904
+ | 'no_credit'
1905
+ | 'passenger_transport_ancillary_purchase_cancellation'
1906
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1907
+ | 'other'
1908
+ | null;
1909
+
1910
+ /**
1911
+ * Name of the passenger or description of the ancillary purchase.
1912
+ */
1913
+ passenger_name_or_description: string | null;
1914
+
1915
+ /**
1916
+ * Additional travel charges, such as baggage fees.
1917
+ */
1918
+ services: Array<Ancillary.Service>;
1919
+
1920
+ /**
1921
+ * Ticket document number.
1922
+ */
1923
+ ticket_document_number: string | null;
1924
+ }
1925
+
1926
+ export namespace Ancillary {
1927
+ export interface Service {
1928
+ /**
1929
+ * Category of the ancillary service.
1930
+ *
1931
+ * - `none` - None
1932
+ * - `bundled_service` - Bundled service
1933
+ * - `baggage_fee` - Baggage fee
1934
+ * - `change_fee` - Change fee
1935
+ * - `cargo` - Cargo
1936
+ * - `carbon_offset` - Carbon offset
1937
+ * - `frequent_flyer` - Frequent flyer
1938
+ * - `gift_card` - Gift card
1939
+ * - `ground_transport` - Ground transport
1940
+ * - `in_flight_entertainment` - In-flight entertainment
1941
+ * - `lounge` - Lounge
1942
+ * - `medical` - Medical
1943
+ * - `meal_beverage` - Meal beverage
1944
+ * - `other` - Other
1945
+ * - `passenger_assist_fee` - Passenger assist fee
1946
+ * - `pets` - Pets
1947
+ * - `seat_fees` - Seat fees
1948
+ * - `standby` - Standby
1949
+ * - `service_fee` - Service fee
1950
+ * - `store` - Store
1951
+ * - `travel_service` - Travel service
1952
+ * - `unaccompanied_travel` - Unaccompanied travel
1953
+ * - `upgrades` - Upgrades
1954
+ * - `wifi` - Wi-fi
1955
+ */
1956
+ category:
1957
+ | 'none'
1958
+ | 'bundled_service'
1959
+ | 'baggage_fee'
1960
+ | 'change_fee'
1961
+ | 'cargo'
1962
+ | 'carbon_offset'
1963
+ | 'frequent_flyer'
1964
+ | 'gift_card'
1965
+ | 'ground_transport'
1966
+ | 'in_flight_entertainment'
1967
+ | 'lounge'
1968
+ | 'medical'
1969
+ | 'meal_beverage'
1970
+ | 'other'
1971
+ | 'passenger_assist_fee'
1972
+ | 'pets'
1973
+ | 'seat_fees'
1974
+ | 'standby'
1975
+ | 'service_fee'
1976
+ | 'store'
1977
+ | 'travel_service'
1978
+ | 'unaccompanied_travel'
1979
+ | 'upgrades'
1980
+ | 'wifi'
1981
+ | null;
1982
+
1983
+ /**
1984
+ * Sub-category of the ancillary service, free-form.
1985
+ */
1986
+ sub_category: string | null;
1987
+ }
1988
+ }
1989
+
1990
+ export interface TripLeg {
1991
+ /**
1992
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
1993
+ */
1994
+ carrier_code: string | null;
1995
+
1996
+ /**
1997
+ * Code for the destination city or airport.
1998
+ */
1999
+ destination_city_airport_code: string | null;
2000
+
2001
+ /**
2002
+ * Fare basis code.
2003
+ */
2004
+ fare_basis_code: string | null;
2005
+
2006
+ /**
2007
+ * Flight number.
2008
+ */
2009
+ flight_number: string | null;
2010
+
2011
+ /**
2012
+ * Service class (e.g., first class, business class, etc.).
2013
+ */
2014
+ service_class: string | null;
2015
+
2016
+ /**
2017
+ * Indicates whether a stopover is allowed on this ticket.
2018
+ *
2019
+ * - `none` - None
2020
+ * - `stop_over_allowed` - Stop over allowed
2021
+ * - `stop_over_not_allowed` - Stop over not allowed
2022
+ */
2023
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
2024
+ }
2025
+ }
2026
+ }
2027
+ }
2028
+
968
2029
  /**
969
2030
  * A Check Deposit Acceptance object. This field will be present in the JSON
970
2031
  * response if and only if `category` is equal to `check_deposit_acceptance`.
@@ -1180,17 +2241,6 @@ export namespace InterestPaymentSimulationResult {
1180
2241
  transfer_id: string;
1181
2242
  }
1182
2243
 
1183
- /**
1184
- * A Check Transfer Rejection object. This field will be present in the JSON
1185
- * response if and only if `category` is equal to `check_transfer_rejection`.
1186
- */
1187
- export interface CheckTransferRejection {
1188
- /**
1189
- * The identifier of the Check Transfer that led to this Transaction.
1190
- */
1191
- transfer_id: string;
1192
- }
1193
-
1194
2244
  /**
1195
2245
  * A Check Transfer Stop Payment Request object. This field will be present in the
1196
2246
  * JSON response if and only if `category` is equal to
@@ -1201,9 +2251,11 @@ export namespace InterestPaymentSimulationResult {
1201
2251
  * The reason why this transfer was stopped.
1202
2252
  *
1203
2253
  * - `mail_delivery_failed` - The check could not be delivered.
2254
+ * - `rejected_by_increase` - The check was cancelled by an Increase operator who
2255
+ * will provide details out-of-band.
1204
2256
  * - `unknown` - The check was stopped for another reason.
1205
2257
  */
1206
- reason: 'mail_delivery_failed' | 'unknown';
2258
+ reason: 'mail_delivery_failed' | 'rejected_by_increase' | 'unknown';
1207
2259
 
1208
2260
  /**
1209
2261
  * The time the stop-payment was requested.
@@ -1738,6 +2790,7 @@ export namespace InterestPaymentSimulationResult {
1738
2790
  * - `account_closure` - Account closure
1739
2791
  * - `bank_migration` - Bank migration
1740
2792
  * - `cashback` - Cashback
2793
+ * - `check_adjustment` - Check adjustment
1741
2794
  * - `collection_receivable` - Collection receivable
1742
2795
  * - `empyreal_adjustment` - Empyreal adjustment
1743
2796
  * - `error` - Error
@@ -1752,6 +2805,7 @@ export namespace InterestPaymentSimulationResult {
1752
2805
  | 'account_closure'
1753
2806
  | 'bank_migration'
1754
2807
  | 'cashback'
2808
+ | 'check_adjustment'
1755
2809
  | 'collection_receivable'
1756
2810
  | 'empyreal_adjustment'
1757
2811
  | 'error'
@@ -1855,6 +2909,16 @@ export interface InterestPaymentCreateParams {
1855
2909
  * The interest amount in cents. Must be positive.
1856
2910
  */
1857
2911
  amount: number;
2912
+
2913
+ /**
2914
+ * The end of the interest period. If not provided, defaults to the current time.
2915
+ */
2916
+ period_end?: string;
2917
+
2918
+ /**
2919
+ * The start of the interest period. If not provided, defaults to the current time.
2920
+ */
2921
+ period_start?: string;
1858
2922
  }
1859
2923
 
1860
2924
  export namespace InterestPayments {