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