increase 0.7.1 → 0.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (231) hide show
  1. package/CHANGELOG.md +71 -0
  2. package/README.md +8 -4
  3. package/_shims/ReadableStream.d.ts +38 -0
  4. package/_shims/ReadableStream.js +5 -0
  5. package/_shims/ReadableStream.mjs +7 -0
  6. package/_shims/ReadableStream.node.d.ts +6 -0
  7. package/_shims/ReadableStream.node.d.ts.map +1 -0
  8. package/_shims/ReadableStream.node.js +14 -0
  9. package/_shims/ReadableStream.node.js.map +1 -0
  10. package/_shims/ReadableStream.node.mjs +3 -0
  11. package/_shims/ReadableStream.node.mjs.map +1 -0
  12. package/_shims/fetch.js +1 -1
  13. package/core.d.ts +11 -10
  14. package/core.d.ts.map +1 -1
  15. package/core.js +123 -60
  16. package/core.js.map +1 -1
  17. package/core.mjs +113 -20
  18. package/core.mjs.map +1 -1
  19. package/error.d.ts +1 -0
  20. package/error.d.ts.map +1 -1
  21. package/error.js +12 -3
  22. package/error.js.map +1 -1
  23. package/error.mjs +12 -3
  24. package/error.mjs.map +1 -1
  25. package/index.d.mts +9 -5
  26. package/index.d.ts +9 -5
  27. package/index.d.ts.map +1 -1
  28. package/index.js +15 -11
  29. package/index.js.map +1 -1
  30. package/index.mjs +15 -11
  31. package/index.mjs.map +1 -1
  32. package/package.json +4 -4
  33. package/resources/account-numbers.d.ts.map +1 -1
  34. package/resources/account-statements.d.ts.map +1 -1
  35. package/resources/account-transfers.d.ts.map +1 -1
  36. package/resources/accounts.d.ts.map +1 -1
  37. package/resources/ach-prenotifications.d.ts.map +1 -1
  38. package/resources/ach-transfers.d.ts.map +1 -1
  39. package/resources/balance-lookups.d.ts.map +1 -1
  40. package/resources/bookkeeping-accounts.d.ts.map +1 -1
  41. package/resources/bookkeeping-entries.d.ts.map +1 -1
  42. package/resources/bookkeeping-entry-sets.d.ts.map +1 -1
  43. package/resources/card-disputes.d.ts.map +1 -1
  44. package/resources/card-profiles.d.ts +17 -4
  45. package/resources/card-profiles.d.ts.map +1 -1
  46. package/resources/card-profiles.js.map +1 -1
  47. package/resources/card-profiles.mjs.map +1 -1
  48. package/resources/card-purchase-supplements.d.ts +270 -0
  49. package/resources/card-purchase-supplements.d.ts.map +1 -0
  50. package/resources/card-purchase-supplements.js +28 -0
  51. package/resources/card-purchase-supplements.js.map +1 -0
  52. package/resources/card-purchase-supplements.mjs +21 -0
  53. package/resources/card-purchase-supplements.mjs.map +1 -0
  54. package/resources/cards.d.ts.map +1 -1
  55. package/resources/check-deposits.d.ts.map +1 -1
  56. package/resources/check-transfers.d.ts +184 -98
  57. package/resources/check-transfers.d.ts.map +1 -1
  58. package/resources/check-transfers.js.map +1 -1
  59. package/resources/check-transfers.mjs.map +1 -1
  60. package/resources/declined-transactions.d.ts +9 -7
  61. package/resources/declined-transactions.d.ts.map +1 -1
  62. package/resources/declined-transactions.js.map +1 -1
  63. package/resources/declined-transactions.mjs.map +1 -1
  64. package/resources/digital-wallet-tokens.d.ts.map +1 -1
  65. package/resources/documents.d.ts.map +1 -1
  66. package/resources/entities/beneficial-owners.d.ts +219 -0
  67. package/resources/entities/beneficial-owners.d.ts.map +1 -0
  68. package/resources/entities/beneficial-owners.js +18 -0
  69. package/resources/entities/beneficial-owners.js.map +1 -0
  70. package/resources/entities/beneficial-owners.mjs +12 -0
  71. package/resources/entities/beneficial-owners.mjs.map +1 -0
  72. package/resources/entities/entities.d.ts +4 -0
  73. package/resources/entities/entities.d.ts.map +1 -1
  74. package/resources/entities/entities.js +3 -0
  75. package/resources/entities/entities.js.map +1 -1
  76. package/resources/entities/entities.mjs +3 -0
  77. package/resources/entities/entities.mjs.map +1 -1
  78. package/resources/entities/index.d.ts +1 -0
  79. package/resources/entities/index.d.ts.map +1 -1
  80. package/resources/entities/index.js +8 -0
  81. package/resources/entities/index.js.map +1 -1
  82. package/resources/entities/index.mjs +1 -0
  83. package/resources/entities/index.mjs.map +1 -1
  84. package/resources/entities/supplemental-documents.d.ts.map +1 -1
  85. package/resources/event-subscriptions.d.ts.map +1 -1
  86. package/resources/events.d.ts.map +1 -1
  87. package/resources/exports.d.ts.map +1 -1
  88. package/resources/external-accounts.d.ts.map +1 -1
  89. package/resources/files.d.ts.map +1 -1
  90. package/resources/groups.d.ts.map +1 -1
  91. package/resources/inbound-ach-transfer-returns.d.ts.map +1 -1
  92. package/resources/inbound-wire-drawdown-requests.d.ts.map +1 -1
  93. package/resources/index.d.ts +6 -0
  94. package/resources/index.d.ts.map +1 -1
  95. package/resources/index.js +18 -3
  96. package/resources/index.js.map +1 -1
  97. package/resources/index.mjs +1 -0
  98. package/resources/index.mjs.map +1 -1
  99. package/resources/limits.d.ts +2 -2
  100. package/resources/limits.d.ts.map +1 -1
  101. package/resources/oauth-connections.d.ts.map +1 -1
  102. package/resources/pending-transactions.d.ts +11 -7
  103. package/resources/pending-transactions.d.ts.map +1 -1
  104. package/resources/pending-transactions.js.map +1 -1
  105. package/resources/pending-transactions.mjs.map +1 -1
  106. package/resources/programs.d.ts.map +1 -1
  107. package/resources/real-time-decisions.d.ts +49 -7
  108. package/resources/real-time-decisions.d.ts.map +1 -1
  109. package/resources/real-time-decisions.js.map +1 -1
  110. package/resources/real-time-decisions.mjs.map +1 -1
  111. package/resources/real-time-payments-transfers.d.ts.map +1 -1
  112. package/resources/routing-numbers.d.ts.map +1 -1
  113. package/resources/shared.d.ts +2 -0
  114. package/resources/shared.d.ts.map +1 -1
  115. package/resources/simulations/account-statements.d.ts.map +1 -1
  116. package/resources/simulations/ach-transfers.d.ts +952 -26
  117. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  118. package/resources/simulations/ach-transfers.js.map +1 -1
  119. package/resources/simulations/ach-transfers.mjs.map +1 -1
  120. package/resources/simulations/card-disputes.d.ts.map +1 -1
  121. package/resources/simulations/card-refunds.d.ts.map +1 -1
  122. package/resources/simulations/cards.d.ts +20 -14
  123. package/resources/simulations/cards.d.ts.map +1 -1
  124. package/resources/simulations/cards.js.map +1 -1
  125. package/resources/simulations/cards.mjs.map +1 -1
  126. package/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -1
  127. package/resources/simulations/documents.d.ts.map +1 -1
  128. package/resources/simulations/inbound-funds-holds.d.ts +4 -0
  129. package/resources/simulations/inbound-funds-holds.d.ts.map +1 -1
  130. package/resources/simulations/inbound-funds-holds.js.map +1 -1
  131. package/resources/simulations/inbound-funds-holds.mjs.map +1 -1
  132. package/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -1
  133. package/resources/simulations/interest-payments.d.ts +951 -19
  134. package/resources/simulations/interest-payments.d.ts.map +1 -1
  135. package/resources/simulations/interest-payments.js.map +1 -1
  136. package/resources/simulations/interest-payments.mjs.map +1 -1
  137. package/resources/simulations/programs.d.ts.map +1 -1
  138. package/resources/simulations/real-time-payments-transfers.d.ts +952 -26
  139. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  140. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  141. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  142. package/resources/simulations/simulations.d.ts.map +1 -1
  143. package/resources/simulations/simulations.js.map +1 -1
  144. package/resources/simulations/wire-transfers.d.ts +943 -19
  145. package/resources/simulations/wire-transfers.d.ts.map +1 -1
  146. package/resources/simulations/wire-transfers.js.map +1 -1
  147. package/resources/simulations/wire-transfers.mjs.map +1 -1
  148. package/resources/transactions.d.ts +943 -20
  149. package/resources/transactions.d.ts.map +1 -1
  150. package/resources/transactions.js.map +1 -1
  151. package/resources/transactions.mjs.map +1 -1
  152. package/resources/wire-drawdown-requests.d.ts.map +1 -1
  153. package/resources/wire-transfers.d.ts.map +1 -1
  154. package/src/_shims/ReadableStream.d.ts +38 -0
  155. package/src/_shims/ReadableStream.js +5 -0
  156. package/src/_shims/ReadableStream.mjs +7 -0
  157. package/src/_shims/ReadableStream.node.ts +6 -0
  158. package/src/_shims/fetch.deno.ts +23 -0
  159. package/src/_shims/fetch.js +1 -1
  160. package/src/_shims/formdata.deno.ts +16 -0
  161. package/src/core.ts +130 -21
  162. package/src/error.ts +11 -1
  163. package/src/index.ts +23 -16
  164. package/src/resources/account-numbers.ts +1 -1
  165. package/src/resources/account-statements.ts +1 -1
  166. package/src/resources/account-transfers.ts +1 -1
  167. package/src/resources/accounts.ts +1 -1
  168. package/src/resources/ach-prenotifications.ts +1 -1
  169. package/src/resources/ach-transfers.ts +1 -1
  170. package/src/resources/balance-lookups.ts +1 -1
  171. package/src/resources/bookkeeping-accounts.ts +1 -1
  172. package/src/resources/bookkeeping-entries.ts +1 -1
  173. package/src/resources/bookkeeping-entry-sets.ts +1 -1
  174. package/src/resources/card-disputes.ts +1 -1
  175. package/src/resources/card-profiles.ts +19 -5
  176. package/src/resources/card-purchase-supplements.ts +331 -0
  177. package/src/resources/cards.ts +1 -1
  178. package/src/resources/check-deposits.ts +1 -1
  179. package/src/resources/check-transfers.ts +208 -113
  180. package/src/resources/declined-transactions.ts +11 -9
  181. package/src/resources/digital-wallet-tokens.ts +1 -1
  182. package/src/resources/documents.ts +1 -1
  183. package/src/resources/entities/beneficial-owners.ts +255 -0
  184. package/src/resources/entities/entities.ts +6 -1
  185. package/src/resources/entities/index.ts +1 -0
  186. package/src/resources/entities/supplemental-documents.ts +1 -1
  187. package/src/resources/event-subscriptions.ts +1 -1
  188. package/src/resources/events.ts +1 -1
  189. package/src/resources/exports.ts +1 -1
  190. package/src/resources/external-accounts.ts +1 -1
  191. package/src/resources/files.ts +1 -1
  192. package/src/resources/groups.ts +1 -1
  193. package/src/resources/inbound-ach-transfer-returns.ts +1 -1
  194. package/src/resources/inbound-wire-drawdown-requests.ts +1 -1
  195. package/src/resources/index.ts +6 -0
  196. package/src/resources/limits.ts +3 -3
  197. package/src/resources/oauth-connections.ts +1 -1
  198. package/src/resources/pending-transactions.ts +14 -9
  199. package/src/resources/programs.ts +1 -1
  200. package/src/resources/real-time-decisions.ts +57 -9
  201. package/src/resources/real-time-payments-transfers.ts +1 -1
  202. package/src/resources/routing-numbers.ts +1 -1
  203. package/src/resources/shared.ts +2 -0
  204. package/src/resources/simulations/account-statements.ts +1 -1
  205. package/src/resources/simulations/ach-transfers.ts +1091 -30
  206. package/src/resources/simulations/card-disputes.ts +1 -1
  207. package/src/resources/simulations/card-refunds.ts +1 -1
  208. package/src/resources/simulations/cards.ts +24 -17
  209. package/src/resources/simulations/digital-wallet-token-requests.ts +1 -1
  210. package/src/resources/simulations/documents.ts +1 -1
  211. package/src/resources/simulations/inbound-funds-holds.ts +6 -1
  212. package/src/resources/simulations/inbound-wire-drawdown-requests.ts +1 -1
  213. package/src/resources/simulations/interest-payments.ts +1091 -22
  214. package/src/resources/simulations/programs.ts +1 -1
  215. package/src/resources/simulations/real-time-payments-transfers.ts +1091 -30
  216. package/src/resources/simulations/simulations.ts +1 -1
  217. package/src/resources/simulations/wire-transfers.ts +1081 -22
  218. package/src/resources/transactions.ts +1081 -23
  219. package/src/resources/wire-drawdown-requests.ts +1 -1
  220. package/src/resources/wire-transfers.ts +1 -1
  221. package/src/uploads.ts +7 -6
  222. package/src/version.ts +1 -1
  223. package/uploads.d.ts +5 -4
  224. package/uploads.d.ts.map +1 -1
  225. package/uploads.js +2 -2
  226. package/uploads.js.map +1 -1
  227. package/uploads.mjs +2 -2
  228. package/uploads.mjs.map +1 -1
  229. package/version.d.ts +1 -1
  230. package/version.js +1 -1
  231. package/version.mjs +1 -1
@@ -174,8 +174,6 @@ export declare namespace WireTransferSimulation {
174
174
  * Deposit object. Details will be under the `check_transfer_deposit` object.
175
175
  * - `check_transfer_intention` - The Transaction was created by a Check Transfer
176
176
  * Intention object. Details will be under the `check_transfer_intention` object.
177
- * - `check_transfer_rejection` - The Transaction was created by a Check Transfer
178
- * Rejection object. Details will be under the `check_transfer_rejection` object.
179
177
  * - `check_transfer_stop_payment_request` - The Transaction was created by a Check
180
178
  * Transfer Stop Payment Request object. Details will be under the
181
179
  * `check_transfer_stop_payment_request` object.
@@ -232,7 +230,6 @@ export declare namespace WireTransferSimulation {
232
230
  | 'check_deposit_return'
233
231
  | 'check_transfer_deposit'
234
232
  | 'check_transfer_intention'
235
- | 'check_transfer_rejection'
236
233
  | 'check_transfer_stop_payment_request'
237
234
  | 'fee_payment'
238
235
  | 'inbound_ach_transfer'
@@ -271,11 +268,6 @@ export declare namespace WireTransferSimulation {
271
268
  * response if and only if `category` is equal to `check_transfer_intention`.
272
269
  */
273
270
  check_transfer_intention: Source.CheckTransferIntention | null;
274
- /**
275
- * A Check Transfer Rejection object. This field will be present in the JSON
276
- * response if and only if `category` is equal to `check_transfer_rejection`.
277
- */
278
- check_transfer_rejection: Source.CheckTransferRejection | null;
279
271
  /**
280
272
  * A Check Transfer Stop Payment Request object. This field will be present in the
281
273
  * JSON response if and only if `category` is equal to
@@ -743,6 +735,11 @@ export declare namespace WireTransferSimulation {
743
735
  * The state the merchant resides in.
744
736
  */
745
737
  merchant_state: string | null;
738
+ /**
739
+ * Additional details about the card purchase, such as tax and industry-specific
740
+ * fields.
741
+ */
742
+ purchase_details: CardRefund.PurchaseDetails | null;
746
743
  /**
747
744
  * The identifier of the Transaction associated with this Transaction.
748
745
  */
@@ -753,6 +750,468 @@ export declare namespace WireTransferSimulation {
753
750
  */
754
751
  type: 'card_refund';
755
752
  }
753
+ namespace CardRefund {
754
+ /**
755
+ * Additional details about the card purchase, such as tax and industry-specific
756
+ * fields.
757
+ */
758
+ interface PurchaseDetails {
759
+ /**
760
+ * Fields specific to car rentals.
761
+ */
762
+ car_rental: PurchaseDetails.CarRental | null;
763
+ /**
764
+ * An identifier from the merchant for the customer or consumer.
765
+ */
766
+ customer_reference_identifier: string | null;
767
+ /**
768
+ * The state or provincial tax amount in minor units.
769
+ */
770
+ local_tax_amount: number | null;
771
+ /**
772
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
773
+ * assessed.
774
+ */
775
+ local_tax_currency: string | null;
776
+ /**
777
+ * Fields specific to lodging.
778
+ */
779
+ lodging: PurchaseDetails.Lodging | null;
780
+ /**
781
+ * The national tax amount in minor units.
782
+ */
783
+ national_tax_amount: number | null;
784
+ /**
785
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
786
+ * assessed.
787
+ */
788
+ national_tax_currency: string | null;
789
+ /**
790
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
791
+ */
792
+ purchase_identifier: string | null;
793
+ /**
794
+ * The format of the purchase identifier.
795
+ *
796
+ * - `free_text` - Free text
797
+ * - `order_number` - Order number
798
+ * - `rental_agreement_number` - Rental agreement number
799
+ * - `hotel_folio_number` - Hotel folio number
800
+ * - `invoice_number` - Invoice number
801
+ */
802
+ purchase_identifier_format:
803
+ | 'free_text'
804
+ | 'order_number'
805
+ | 'rental_agreement_number'
806
+ | 'hotel_folio_number'
807
+ | 'invoice_number'
808
+ | null;
809
+ /**
810
+ * Fields specific to travel.
811
+ */
812
+ travel: PurchaseDetails.Travel | null;
813
+ }
814
+ namespace PurchaseDetails {
815
+ /**
816
+ * Fields specific to car rentals.
817
+ */
818
+ interface CarRental {
819
+ /**
820
+ * Code indicating the vehicle's class.
821
+ */
822
+ car_class_code: string | null;
823
+ /**
824
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
825
+ * transaction, the scheduled pick up date.
826
+ */
827
+ checkout_date: string | null;
828
+ /**
829
+ * Daily rate being charged for the vehicle.
830
+ */
831
+ daily_rental_rate_amount: number | null;
832
+ /**
833
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
834
+ * rate.
835
+ */
836
+ daily_rental_rate_currency: string | null;
837
+ /**
838
+ * Number of days the vehicle was rented.
839
+ */
840
+ days_rented: number | null;
841
+ /**
842
+ * Additional charges (gas, late fee, etc.) being billed.
843
+ *
844
+ * - `no_extra_charge` - No extra charge
845
+ * - `gas` - Gas
846
+ * - `extra_mileage` - Extra mileage
847
+ * - `late_return` - Late return
848
+ * - `one_way_service_fee` - One way service fee
849
+ * - `parking_violation` - Parking violation
850
+ */
851
+ extra_charges:
852
+ | 'no_extra_charge'
853
+ | 'gas'
854
+ | 'extra_mileage'
855
+ | 'late_return'
856
+ | 'one_way_service_fee'
857
+ | 'parking_violation'
858
+ | null;
859
+ /**
860
+ * Fuel charges for the vehicle.
861
+ */
862
+ fuel_charges_amount: number | null;
863
+ /**
864
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
865
+ * assessed.
866
+ */
867
+ fuel_charges_currency: string | null;
868
+ /**
869
+ * Any insurance being charged for the vehicle.
870
+ */
871
+ insurance_charges_amount: number | null;
872
+ /**
873
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
874
+ * charges assessed.
875
+ */
876
+ insurance_charges_currency: string | null;
877
+ /**
878
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
879
+ * not actually rented (that is, a "no-show" charge).
880
+ *
881
+ * - `not_applicable` - Not applicable
882
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
883
+ */
884
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
885
+ /**
886
+ * Charges for returning the vehicle at a different location than where it was
887
+ * picked up.
888
+ */
889
+ one_way_drop_off_charges_amount: number | null;
890
+ /**
891
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
892
+ * drop-off charges assessed.
893
+ */
894
+ one_way_drop_off_charges_currency: string | null;
895
+ /**
896
+ * Name of the person renting the vehicle.
897
+ */
898
+ renter_name: string | null;
899
+ /**
900
+ * Weekly rate being charged for the vehicle.
901
+ */
902
+ weekly_rental_rate_amount: number | null;
903
+ /**
904
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
905
+ * rental rate.
906
+ */
907
+ weekly_rental_rate_currency: string | null;
908
+ }
909
+ /**
910
+ * Fields specific to lodging.
911
+ */
912
+ interface Lodging {
913
+ /**
914
+ * Date the customer checked in.
915
+ */
916
+ check_in_date: string | null;
917
+ /**
918
+ * Daily rate being charged for the room.
919
+ */
920
+ daily_room_rate_amount: number | null;
921
+ /**
922
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
923
+ * rate.
924
+ */
925
+ daily_room_rate_currency: string | null;
926
+ /**
927
+ * Additional charges (phone, late check-out, etc.) being billed.
928
+ *
929
+ * - `no_extra_charge` - No extra charge
930
+ * - `restaurant` - Restaurant
931
+ * - `gift_shop` - Gift shop
932
+ * - `mini_bar` - Mini bar
933
+ * - `telephone` - Telephone
934
+ * - `other` - Other
935
+ * - `laundry` - Laundry
936
+ */
937
+ extra_charges:
938
+ | 'no_extra_charge'
939
+ | 'restaurant'
940
+ | 'gift_shop'
941
+ | 'mini_bar'
942
+ | 'telephone'
943
+ | 'other'
944
+ | 'laundry'
945
+ | null;
946
+ /**
947
+ * Folio cash advances for the room.
948
+ */
949
+ folio_cash_advances_amount: number | null;
950
+ /**
951
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
952
+ * advances.
953
+ */
954
+ folio_cash_advances_currency: string | null;
955
+ /**
956
+ * Food and beverage charges for the room.
957
+ */
958
+ food_beverage_charges_amount: number | null;
959
+ /**
960
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
961
+ * beverage charges.
962
+ */
963
+ food_beverage_charges_currency: string | null;
964
+ /**
965
+ * Indicator that the cardholder is being billed for a reserved room that was not
966
+ * actually used.
967
+ *
968
+ * - `not_applicable` - Not applicable
969
+ * - `no_show` - No show
970
+ */
971
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
972
+ /**
973
+ * Prepaid expenses being charged for the room.
974
+ */
975
+ prepaid_expenses_amount: number | null;
976
+ /**
977
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
978
+ * expenses.
979
+ */
980
+ prepaid_expenses_currency: string | null;
981
+ /**
982
+ * Number of nights the room was rented.
983
+ */
984
+ room_nights: number | null;
985
+ /**
986
+ * Total room tax being charged.
987
+ */
988
+ total_room_tax_amount: number | null;
989
+ /**
990
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
991
+ * tax.
992
+ */
993
+ total_room_tax_currency: string | null;
994
+ /**
995
+ * Total tax being charged for the room.
996
+ */
997
+ total_tax_amount: number | null;
998
+ /**
999
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
1000
+ * assessed.
1001
+ */
1002
+ total_tax_currency: string | null;
1003
+ }
1004
+ /**
1005
+ * Fields specific to travel.
1006
+ */
1007
+ interface Travel {
1008
+ /**
1009
+ * Ancillary purchases in addition to the airfare.
1010
+ */
1011
+ ancillary: Travel.Ancillary | null;
1012
+ /**
1013
+ * Indicates the computerized reservation system used to book the ticket.
1014
+ */
1015
+ computerized_reservation_system: string | null;
1016
+ /**
1017
+ * Indicates the reason for a credit to the cardholder.
1018
+ *
1019
+ * - `no_credit` - No credit
1020
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1021
+ * ancillary purchase cancellation
1022
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1023
+ * Airline ticket and passenger transport ancillary purchase cancellation
1024
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
1025
+ * - `other` - Other
1026
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
1027
+ */
1028
+ credit_reason_indicator:
1029
+ | 'no_credit'
1030
+ | 'passenger_transport_ancillary_purchase_cancellation'
1031
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1032
+ | 'airline_ticket_cancellation'
1033
+ | 'other'
1034
+ | 'partial_refund_of_airline_ticket'
1035
+ | null;
1036
+ /**
1037
+ * Date of departure.
1038
+ */
1039
+ departure_date: string | null;
1040
+ /**
1041
+ * Code for the originating city or airport.
1042
+ */
1043
+ origination_city_airport_code: string | null;
1044
+ /**
1045
+ * Name of the passenger.
1046
+ */
1047
+ passenger_name: string | null;
1048
+ /**
1049
+ * Indicates whether this ticket is non-refundable.
1050
+ *
1051
+ * - `no_restrictions` - No restrictions
1052
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
1053
+ */
1054
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
1055
+ /**
1056
+ * Indicates why a ticket was changed.
1057
+ *
1058
+ * - `none` - None
1059
+ * - `change_to_existing_ticket` - Change to existing ticket
1060
+ * - `new_ticket` - New ticket
1061
+ */
1062
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
1063
+ /**
1064
+ * Ticket number.
1065
+ */
1066
+ ticket_number: string | null;
1067
+ /**
1068
+ * Code for the travel agency if the ticket was issued by a travel agency.
1069
+ */
1070
+ travel_agency_code: string | null;
1071
+ /**
1072
+ * Name of the travel agency if the ticket was issued by a travel agency.
1073
+ */
1074
+ travel_agency_name: string | null;
1075
+ /**
1076
+ * Fields specific to each leg of the journey.
1077
+ */
1078
+ trip_legs: Array<Travel.TripLeg> | null;
1079
+ }
1080
+ namespace Travel {
1081
+ /**
1082
+ * Ancillary purchases in addition to the airfare.
1083
+ */
1084
+ interface Ancillary {
1085
+ /**
1086
+ * If this purchase has a connection or relationship to another purchase, such as a
1087
+ * baggage fee for a passenger transport ticket, this field should contain the
1088
+ * ticket document number for the other purchase.
1089
+ */
1090
+ connected_ticket_document_number: string | null;
1091
+ /**
1092
+ * Indicates the reason for a credit to the cardholder.
1093
+ *
1094
+ * - `no_credit` - No credit
1095
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1096
+ * ancillary purchase cancellation
1097
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1098
+ * Airline ticket and passenger transport ancillary purchase cancellation
1099
+ * - `other` - Other
1100
+ */
1101
+ credit_reason_indicator:
1102
+ | 'no_credit'
1103
+ | 'passenger_transport_ancillary_purchase_cancellation'
1104
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1105
+ | 'other'
1106
+ | null;
1107
+ /**
1108
+ * Name of the passenger or description of the ancillary purchase.
1109
+ */
1110
+ passenger_name_or_description: string | null;
1111
+ /**
1112
+ * Additional travel charges, such as baggage fees.
1113
+ */
1114
+ services: Array<Ancillary.Service>;
1115
+ /**
1116
+ * Ticket document number.
1117
+ */
1118
+ ticket_document_number: string | null;
1119
+ }
1120
+ namespace Ancillary {
1121
+ interface Service {
1122
+ /**
1123
+ * Category of the ancillary service.
1124
+ *
1125
+ * - `none` - None
1126
+ * - `bundled_service` - Bundled service
1127
+ * - `baggage_fee` - Baggage fee
1128
+ * - `change_fee` - Change fee
1129
+ * - `cargo` - Cargo
1130
+ * - `carbon_offset` - Carbon offset
1131
+ * - `frequent_flyer` - Frequent flyer
1132
+ * - `gift_card` - Gift card
1133
+ * - `ground_transport` - Ground transport
1134
+ * - `in_flight_entertainment` - In-flight entertainment
1135
+ * - `lounge` - Lounge
1136
+ * - `medical` - Medical
1137
+ * - `meal_beverage` - Meal beverage
1138
+ * - `other` - Other
1139
+ * - `passenger_assist_fee` - Passenger assist fee
1140
+ * - `pets` - Pets
1141
+ * - `seat_fees` - Seat fees
1142
+ * - `standby` - Standby
1143
+ * - `service_fee` - Service fee
1144
+ * - `store` - Store
1145
+ * - `travel_service` - Travel service
1146
+ * - `unaccompanied_travel` - Unaccompanied travel
1147
+ * - `upgrades` - Upgrades
1148
+ * - `wifi` - Wi-fi
1149
+ */
1150
+ category:
1151
+ | 'none'
1152
+ | 'bundled_service'
1153
+ | 'baggage_fee'
1154
+ | 'change_fee'
1155
+ | 'cargo'
1156
+ | 'carbon_offset'
1157
+ | 'frequent_flyer'
1158
+ | 'gift_card'
1159
+ | 'ground_transport'
1160
+ | 'in_flight_entertainment'
1161
+ | 'lounge'
1162
+ | 'medical'
1163
+ | 'meal_beverage'
1164
+ | 'other'
1165
+ | 'passenger_assist_fee'
1166
+ | 'pets'
1167
+ | 'seat_fees'
1168
+ | 'standby'
1169
+ | 'service_fee'
1170
+ | 'store'
1171
+ | 'travel_service'
1172
+ | 'unaccompanied_travel'
1173
+ | 'upgrades'
1174
+ | 'wifi'
1175
+ | null;
1176
+ /**
1177
+ * Sub-category of the ancillary service, free-form.
1178
+ */
1179
+ sub_category: string | null;
1180
+ }
1181
+ }
1182
+ interface TripLeg {
1183
+ /**
1184
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
1185
+ */
1186
+ carrier_code: string | null;
1187
+ /**
1188
+ * Code for the destination city or airport.
1189
+ */
1190
+ destination_city_airport_code: string | null;
1191
+ /**
1192
+ * Fare basis code.
1193
+ */
1194
+ fare_basis_code: string | null;
1195
+ /**
1196
+ * Flight number.
1197
+ */
1198
+ flight_number: string | null;
1199
+ /**
1200
+ * Service class (e.g., first class, business class, etc.).
1201
+ */
1202
+ service_class: string | null;
1203
+ /**
1204
+ * Indicates whether a stopover is allowed on this ticket.
1205
+ *
1206
+ * - `none` - None
1207
+ * - `stop_over_allowed` - Stop over allowed
1208
+ * - `stop_over_not_allowed` - Stop over not allowed
1209
+ */
1210
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
1211
+ }
1212
+ }
1213
+ }
1214
+ }
756
1215
  /**
757
1216
  * A Card Revenue Payment object. This field will be present in the JSON response
758
1217
  * if and only if `category` is equal to `card_revenue_payment`.
@@ -857,6 +1316,11 @@ export declare namespace WireTransferSimulation {
857
1316
  * transaction's presentment currency.
858
1317
  */
859
1318
  presentment_currency: string;
1319
+ /**
1320
+ * Additional details about the card purchase, such as tax and industry-specific
1321
+ * fields.
1322
+ */
1323
+ purchase_details: CardSettlement.PurchaseDetails | null;
860
1324
  /**
861
1325
  * The identifier of the Transaction associated with this Transaction.
862
1326
  */
@@ -867,6 +1331,468 @@ export declare namespace WireTransferSimulation {
867
1331
  */
868
1332
  type: 'card_settlement';
869
1333
  }
1334
+ namespace CardSettlement {
1335
+ /**
1336
+ * Additional details about the card purchase, such as tax and industry-specific
1337
+ * fields.
1338
+ */
1339
+ interface PurchaseDetails {
1340
+ /**
1341
+ * Fields specific to car rentals.
1342
+ */
1343
+ car_rental: PurchaseDetails.CarRental | null;
1344
+ /**
1345
+ * An identifier from the merchant for the customer or consumer.
1346
+ */
1347
+ customer_reference_identifier: string | null;
1348
+ /**
1349
+ * The state or provincial tax amount in minor units.
1350
+ */
1351
+ local_tax_amount: number | null;
1352
+ /**
1353
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1354
+ * assessed.
1355
+ */
1356
+ local_tax_currency: string | null;
1357
+ /**
1358
+ * Fields specific to lodging.
1359
+ */
1360
+ lodging: PurchaseDetails.Lodging | null;
1361
+ /**
1362
+ * The national tax amount in minor units.
1363
+ */
1364
+ national_tax_amount: number | null;
1365
+ /**
1366
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1367
+ * assessed.
1368
+ */
1369
+ national_tax_currency: string | null;
1370
+ /**
1371
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
1372
+ */
1373
+ purchase_identifier: string | null;
1374
+ /**
1375
+ * The format of the purchase identifier.
1376
+ *
1377
+ * - `free_text` - Free text
1378
+ * - `order_number` - Order number
1379
+ * - `rental_agreement_number` - Rental agreement number
1380
+ * - `hotel_folio_number` - Hotel folio number
1381
+ * - `invoice_number` - Invoice number
1382
+ */
1383
+ purchase_identifier_format:
1384
+ | 'free_text'
1385
+ | 'order_number'
1386
+ | 'rental_agreement_number'
1387
+ | 'hotel_folio_number'
1388
+ | 'invoice_number'
1389
+ | null;
1390
+ /**
1391
+ * Fields specific to travel.
1392
+ */
1393
+ travel: PurchaseDetails.Travel | null;
1394
+ }
1395
+ namespace PurchaseDetails {
1396
+ /**
1397
+ * Fields specific to car rentals.
1398
+ */
1399
+ interface CarRental {
1400
+ /**
1401
+ * Code indicating the vehicle's class.
1402
+ */
1403
+ car_class_code: string | null;
1404
+ /**
1405
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
1406
+ * transaction, the scheduled pick up date.
1407
+ */
1408
+ checkout_date: string | null;
1409
+ /**
1410
+ * Daily rate being charged for the vehicle.
1411
+ */
1412
+ daily_rental_rate_amount: number | null;
1413
+ /**
1414
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
1415
+ * rate.
1416
+ */
1417
+ daily_rental_rate_currency: string | null;
1418
+ /**
1419
+ * Number of days the vehicle was rented.
1420
+ */
1421
+ days_rented: number | null;
1422
+ /**
1423
+ * Additional charges (gas, late fee, etc.) being billed.
1424
+ *
1425
+ * - `no_extra_charge` - No extra charge
1426
+ * - `gas` - Gas
1427
+ * - `extra_mileage` - Extra mileage
1428
+ * - `late_return` - Late return
1429
+ * - `one_way_service_fee` - One way service fee
1430
+ * - `parking_violation` - Parking violation
1431
+ */
1432
+ extra_charges:
1433
+ | 'no_extra_charge'
1434
+ | 'gas'
1435
+ | 'extra_mileage'
1436
+ | 'late_return'
1437
+ | 'one_way_service_fee'
1438
+ | 'parking_violation'
1439
+ | null;
1440
+ /**
1441
+ * Fuel charges for the vehicle.
1442
+ */
1443
+ fuel_charges_amount: number | null;
1444
+ /**
1445
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
1446
+ * assessed.
1447
+ */
1448
+ fuel_charges_currency: string | null;
1449
+ /**
1450
+ * Any insurance being charged for the vehicle.
1451
+ */
1452
+ insurance_charges_amount: number | null;
1453
+ /**
1454
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
1455
+ * charges assessed.
1456
+ */
1457
+ insurance_charges_currency: string | null;
1458
+ /**
1459
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
1460
+ * not actually rented (that is, a "no-show" charge).
1461
+ *
1462
+ * - `not_applicable` - Not applicable
1463
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
1464
+ */
1465
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
1466
+ /**
1467
+ * Charges for returning the vehicle at a different location than where it was
1468
+ * picked up.
1469
+ */
1470
+ one_way_drop_off_charges_amount: number | null;
1471
+ /**
1472
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
1473
+ * drop-off charges assessed.
1474
+ */
1475
+ one_way_drop_off_charges_currency: string | null;
1476
+ /**
1477
+ * Name of the person renting the vehicle.
1478
+ */
1479
+ renter_name: string | null;
1480
+ /**
1481
+ * Weekly rate being charged for the vehicle.
1482
+ */
1483
+ weekly_rental_rate_amount: number | null;
1484
+ /**
1485
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
1486
+ * rental rate.
1487
+ */
1488
+ weekly_rental_rate_currency: string | null;
1489
+ }
1490
+ /**
1491
+ * Fields specific to lodging.
1492
+ */
1493
+ interface Lodging {
1494
+ /**
1495
+ * Date the customer checked in.
1496
+ */
1497
+ check_in_date: string | null;
1498
+ /**
1499
+ * Daily rate being charged for the room.
1500
+ */
1501
+ daily_room_rate_amount: number | null;
1502
+ /**
1503
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
1504
+ * rate.
1505
+ */
1506
+ daily_room_rate_currency: string | null;
1507
+ /**
1508
+ * Additional charges (phone, late check-out, etc.) being billed.
1509
+ *
1510
+ * - `no_extra_charge` - No extra charge
1511
+ * - `restaurant` - Restaurant
1512
+ * - `gift_shop` - Gift shop
1513
+ * - `mini_bar` - Mini bar
1514
+ * - `telephone` - Telephone
1515
+ * - `other` - Other
1516
+ * - `laundry` - Laundry
1517
+ */
1518
+ extra_charges:
1519
+ | 'no_extra_charge'
1520
+ | 'restaurant'
1521
+ | 'gift_shop'
1522
+ | 'mini_bar'
1523
+ | 'telephone'
1524
+ | 'other'
1525
+ | 'laundry'
1526
+ | null;
1527
+ /**
1528
+ * Folio cash advances for the room.
1529
+ */
1530
+ folio_cash_advances_amount: number | null;
1531
+ /**
1532
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
1533
+ * advances.
1534
+ */
1535
+ folio_cash_advances_currency: string | null;
1536
+ /**
1537
+ * Food and beverage charges for the room.
1538
+ */
1539
+ food_beverage_charges_amount: number | null;
1540
+ /**
1541
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
1542
+ * beverage charges.
1543
+ */
1544
+ food_beverage_charges_currency: string | null;
1545
+ /**
1546
+ * Indicator that the cardholder is being billed for a reserved room that was not
1547
+ * actually used.
1548
+ *
1549
+ * - `not_applicable` - Not applicable
1550
+ * - `no_show` - No show
1551
+ */
1552
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
1553
+ /**
1554
+ * Prepaid expenses being charged for the room.
1555
+ */
1556
+ prepaid_expenses_amount: number | null;
1557
+ /**
1558
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
1559
+ * expenses.
1560
+ */
1561
+ prepaid_expenses_currency: string | null;
1562
+ /**
1563
+ * Number of nights the room was rented.
1564
+ */
1565
+ room_nights: number | null;
1566
+ /**
1567
+ * Total room tax being charged.
1568
+ */
1569
+ total_room_tax_amount: number | null;
1570
+ /**
1571
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
1572
+ * tax.
1573
+ */
1574
+ total_room_tax_currency: string | null;
1575
+ /**
1576
+ * Total tax being charged for the room.
1577
+ */
1578
+ total_tax_amount: number | null;
1579
+ /**
1580
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
1581
+ * assessed.
1582
+ */
1583
+ total_tax_currency: string | null;
1584
+ }
1585
+ /**
1586
+ * Fields specific to travel.
1587
+ */
1588
+ interface Travel {
1589
+ /**
1590
+ * Ancillary purchases in addition to the airfare.
1591
+ */
1592
+ ancillary: Travel.Ancillary | null;
1593
+ /**
1594
+ * Indicates the computerized reservation system used to book the ticket.
1595
+ */
1596
+ computerized_reservation_system: string | null;
1597
+ /**
1598
+ * Indicates the reason for a credit to the cardholder.
1599
+ *
1600
+ * - `no_credit` - No credit
1601
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1602
+ * ancillary purchase cancellation
1603
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1604
+ * Airline ticket and passenger transport ancillary purchase cancellation
1605
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
1606
+ * - `other` - Other
1607
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
1608
+ */
1609
+ credit_reason_indicator:
1610
+ | 'no_credit'
1611
+ | 'passenger_transport_ancillary_purchase_cancellation'
1612
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1613
+ | 'airline_ticket_cancellation'
1614
+ | 'other'
1615
+ | 'partial_refund_of_airline_ticket'
1616
+ | null;
1617
+ /**
1618
+ * Date of departure.
1619
+ */
1620
+ departure_date: string | null;
1621
+ /**
1622
+ * Code for the originating city or airport.
1623
+ */
1624
+ origination_city_airport_code: string | null;
1625
+ /**
1626
+ * Name of the passenger.
1627
+ */
1628
+ passenger_name: string | null;
1629
+ /**
1630
+ * Indicates whether this ticket is non-refundable.
1631
+ *
1632
+ * - `no_restrictions` - No restrictions
1633
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
1634
+ */
1635
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
1636
+ /**
1637
+ * Indicates why a ticket was changed.
1638
+ *
1639
+ * - `none` - None
1640
+ * - `change_to_existing_ticket` - Change to existing ticket
1641
+ * - `new_ticket` - New ticket
1642
+ */
1643
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
1644
+ /**
1645
+ * Ticket number.
1646
+ */
1647
+ ticket_number: string | null;
1648
+ /**
1649
+ * Code for the travel agency if the ticket was issued by a travel agency.
1650
+ */
1651
+ travel_agency_code: string | null;
1652
+ /**
1653
+ * Name of the travel agency if the ticket was issued by a travel agency.
1654
+ */
1655
+ travel_agency_name: string | null;
1656
+ /**
1657
+ * Fields specific to each leg of the journey.
1658
+ */
1659
+ trip_legs: Array<Travel.TripLeg> | null;
1660
+ }
1661
+ namespace Travel {
1662
+ /**
1663
+ * Ancillary purchases in addition to the airfare.
1664
+ */
1665
+ interface Ancillary {
1666
+ /**
1667
+ * If this purchase has a connection or relationship to another purchase, such as a
1668
+ * baggage fee for a passenger transport ticket, this field should contain the
1669
+ * ticket document number for the other purchase.
1670
+ */
1671
+ connected_ticket_document_number: string | null;
1672
+ /**
1673
+ * Indicates the reason for a credit to the cardholder.
1674
+ *
1675
+ * - `no_credit` - No credit
1676
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1677
+ * ancillary purchase cancellation
1678
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1679
+ * Airline ticket and passenger transport ancillary purchase cancellation
1680
+ * - `other` - Other
1681
+ */
1682
+ credit_reason_indicator:
1683
+ | 'no_credit'
1684
+ | 'passenger_transport_ancillary_purchase_cancellation'
1685
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1686
+ | 'other'
1687
+ | null;
1688
+ /**
1689
+ * Name of the passenger or description of the ancillary purchase.
1690
+ */
1691
+ passenger_name_or_description: string | null;
1692
+ /**
1693
+ * Additional travel charges, such as baggage fees.
1694
+ */
1695
+ services: Array<Ancillary.Service>;
1696
+ /**
1697
+ * Ticket document number.
1698
+ */
1699
+ ticket_document_number: string | null;
1700
+ }
1701
+ namespace Ancillary {
1702
+ interface Service {
1703
+ /**
1704
+ * Category of the ancillary service.
1705
+ *
1706
+ * - `none` - None
1707
+ * - `bundled_service` - Bundled service
1708
+ * - `baggage_fee` - Baggage fee
1709
+ * - `change_fee` - Change fee
1710
+ * - `cargo` - Cargo
1711
+ * - `carbon_offset` - Carbon offset
1712
+ * - `frequent_flyer` - Frequent flyer
1713
+ * - `gift_card` - Gift card
1714
+ * - `ground_transport` - Ground transport
1715
+ * - `in_flight_entertainment` - In-flight entertainment
1716
+ * - `lounge` - Lounge
1717
+ * - `medical` - Medical
1718
+ * - `meal_beverage` - Meal beverage
1719
+ * - `other` - Other
1720
+ * - `passenger_assist_fee` - Passenger assist fee
1721
+ * - `pets` - Pets
1722
+ * - `seat_fees` - Seat fees
1723
+ * - `standby` - Standby
1724
+ * - `service_fee` - Service fee
1725
+ * - `store` - Store
1726
+ * - `travel_service` - Travel service
1727
+ * - `unaccompanied_travel` - Unaccompanied travel
1728
+ * - `upgrades` - Upgrades
1729
+ * - `wifi` - Wi-fi
1730
+ */
1731
+ category:
1732
+ | 'none'
1733
+ | 'bundled_service'
1734
+ | 'baggage_fee'
1735
+ | 'change_fee'
1736
+ | 'cargo'
1737
+ | 'carbon_offset'
1738
+ | 'frequent_flyer'
1739
+ | 'gift_card'
1740
+ | 'ground_transport'
1741
+ | 'in_flight_entertainment'
1742
+ | 'lounge'
1743
+ | 'medical'
1744
+ | 'meal_beverage'
1745
+ | 'other'
1746
+ | 'passenger_assist_fee'
1747
+ | 'pets'
1748
+ | 'seat_fees'
1749
+ | 'standby'
1750
+ | 'service_fee'
1751
+ | 'store'
1752
+ | 'travel_service'
1753
+ | 'unaccompanied_travel'
1754
+ | 'upgrades'
1755
+ | 'wifi'
1756
+ | null;
1757
+ /**
1758
+ * Sub-category of the ancillary service, free-form.
1759
+ */
1760
+ sub_category: string | null;
1761
+ }
1762
+ }
1763
+ interface TripLeg {
1764
+ /**
1765
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
1766
+ */
1767
+ carrier_code: string | null;
1768
+ /**
1769
+ * Code for the destination city or airport.
1770
+ */
1771
+ destination_city_airport_code: string | null;
1772
+ /**
1773
+ * Fare basis code.
1774
+ */
1775
+ fare_basis_code: string | null;
1776
+ /**
1777
+ * Flight number.
1778
+ */
1779
+ flight_number: string | null;
1780
+ /**
1781
+ * Service class (e.g., first class, business class, etc.).
1782
+ */
1783
+ service_class: string | null;
1784
+ /**
1785
+ * Indicates whether a stopover is allowed on this ticket.
1786
+ *
1787
+ * - `none` - None
1788
+ * - `stop_over_allowed` - Stop over allowed
1789
+ * - `stop_over_not_allowed` - Stop over not allowed
1790
+ */
1791
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
1792
+ }
1793
+ }
1794
+ }
1795
+ }
870
1796
  /**
871
1797
  * A Check Deposit Acceptance object. This field will be present in the JSON
872
1798
  * response if and only if `category` is equal to `check_deposit_acceptance`.
@@ -1055,16 +1981,6 @@ export declare namespace WireTransferSimulation {
1055
1981
  */
1056
1982
  transfer_id: string;
1057
1983
  }
1058
- /**
1059
- * A Check Transfer Rejection object. This field will be present in the JSON
1060
- * response if and only if `category` is equal to `check_transfer_rejection`.
1061
- */
1062
- interface CheckTransferRejection {
1063
- /**
1064
- * The identifier of the Check Transfer that led to this Transaction.
1065
- */
1066
- transfer_id: string;
1067
- }
1068
1984
  /**
1069
1985
  * A Check Transfer Stop Payment Request object. This field will be present in the
1070
1986
  * JSON response if and only if `category` is equal to
@@ -1075,9 +1991,11 @@ export declare namespace WireTransferSimulation {
1075
1991
  * The reason why this transfer was stopped.
1076
1992
  *
1077
1993
  * - `mail_delivery_failed` - The check could not be delivered.
1994
+ * - `rejected_by_increase` - The check was cancelled by an Increase operator who
1995
+ * will provide details out-of-band.
1078
1996
  * - `unknown` - The check was stopped for another reason.
1079
1997
  */
1080
- reason: 'mail_delivery_failed' | 'unknown';
1998
+ reason: 'mail_delivery_failed' | 'rejected_by_increase' | 'unknown';
1081
1999
  /**
1082
2000
  * The time the stop-payment was requested.
1083
2001
  */
@@ -1114,6 +2032,10 @@ export declare namespace WireTransferSimulation {
1114
2032
  * - `USD` - US Dollar (USD)
1115
2033
  */
1116
2034
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
2035
+ /**
2036
+ * The start of this payment's fee period, usually the first day of a month.
2037
+ */
2038
+ fee_period_start: string;
1117
2039
  }
1118
2040
  /**
1119
2041
  * A Inbound ACH Transfer object. This field will be present in the JSON response
@@ -1481,6 +2403,7 @@ export declare namespace WireTransferSimulation {
1481
2403
  * - `account_closure` - Account closure
1482
2404
  * - `bank_migration` - Bank migration
1483
2405
  * - `cashback` - Cashback
2406
+ * - `check_adjustment` - Check adjustment
1484
2407
  * - `collection_receivable` - Collection receivable
1485
2408
  * - `empyreal_adjustment` - Empyreal adjustment
1486
2409
  * - `error` - Error
@@ -1495,6 +2418,7 @@ export declare namespace WireTransferSimulation {
1495
2418
  | 'account_closure'
1496
2419
  | 'bank_migration'
1497
2420
  | 'cashback'
2421
+ | 'check_adjustment'
1498
2422
  | 'collection_receivable'
1499
2423
  | 'empyreal_adjustment'
1500
2424
  | 'error'