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