increase 0.8.0 → 0.9.0

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 (336) hide show
  1. package/CHANGELOG.md +63 -0
  2. package/README.md +37 -13
  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.d.ts +8 -1
  13. package/_shims/fetch.node.d.ts +11 -1
  14. package/core.d.ts +85 -27
  15. package/core.d.ts.map +1 -1
  16. package/core.js +208 -51
  17. package/core.js.map +1 -1
  18. package/core.mjs +194 -51
  19. package/core.mjs.map +1 -1
  20. package/error.d.ts +1 -0
  21. package/error.d.ts.map +1 -1
  22. package/error.js +12 -3
  23. package/error.js.map +1 -1
  24. package/error.mjs +12 -3
  25. package/error.mjs.map +1 -1
  26. package/index.d.mts +6 -1
  27. package/index.d.ts +6 -1
  28. package/index.d.ts.map +1 -1
  29. package/index.js +11 -8
  30. package/index.js.map +1 -1
  31. package/index.mjs +11 -8
  32. package/index.mjs.map +1 -1
  33. package/package.json +1 -1
  34. package/pagination.d.ts +2 -2
  35. package/pagination.d.ts.map +1 -1
  36. package/pagination.js +4 -4
  37. package/pagination.js.map +1 -1
  38. package/pagination.mjs +4 -4
  39. package/pagination.mjs.map +1 -1
  40. package/resources/account-numbers.d.ts +8 -8
  41. package/resources/account-numbers.d.ts.map +1 -1
  42. package/resources/account-numbers.js.map +1 -1
  43. package/resources/account-numbers.mjs.map +1 -1
  44. package/resources/account-statements.d.ts +3 -6
  45. package/resources/account-statements.d.ts.map +1 -1
  46. package/resources/account-statements.js.map +1 -1
  47. package/resources/account-statements.mjs.map +1 -1
  48. package/resources/account-transfers.d.ts +6 -18
  49. package/resources/account-transfers.d.ts.map +1 -1
  50. package/resources/account-transfers.js.map +1 -1
  51. package/resources/account-transfers.mjs.map +1 -1
  52. package/resources/accounts.d.ts +6 -6
  53. package/resources/accounts.d.ts.map +1 -1
  54. package/resources/ach-prenotifications.d.ts +51 -7
  55. package/resources/ach-prenotifications.d.ts.map +1 -1
  56. package/resources/ach-prenotifications.js.map +1 -1
  57. package/resources/ach-prenotifications.mjs.map +1 -1
  58. package/resources/ach-transfers.d.ts +16 -9
  59. package/resources/ach-transfers.d.ts.map +1 -1
  60. package/resources/ach-transfers.js.map +1 -1
  61. package/resources/ach-transfers.mjs.map +1 -1
  62. package/resources/balance-lookups.d.ts +1 -1
  63. package/resources/balance-lookups.d.ts.map +1 -1
  64. package/resources/bookkeeping-accounts.d.ts +3 -3
  65. package/resources/bookkeeping-accounts.d.ts.map +1 -1
  66. package/resources/bookkeeping-entries.d.ts +2 -2
  67. package/resources/bookkeeping-entries.d.ts.map +1 -1
  68. package/resources/bookkeeping-entry-sets.d.ts +1 -1
  69. package/resources/bookkeeping-entry-sets.d.ts.map +1 -1
  70. package/resources/card-disputes.d.ts +7 -7
  71. package/resources/card-disputes.d.ts.map +1 -1
  72. package/resources/card-disputes.js.map +1 -1
  73. package/resources/card-disputes.mjs.map +1 -1
  74. package/resources/card-profiles.d.ts +32 -11
  75. package/resources/card-profiles.d.ts.map +1 -1
  76. package/resources/card-profiles.js +6 -0
  77. package/resources/card-profiles.js.map +1 -1
  78. package/resources/card-profiles.mjs +6 -0
  79. package/resources/card-profiles.mjs.map +1 -1
  80. package/resources/card-purchase-supplements.d.ts +270 -0
  81. package/resources/card-purchase-supplements.d.ts.map +1 -0
  82. package/resources/card-purchase-supplements.js +28 -0
  83. package/resources/card-purchase-supplements.js.map +1 -0
  84. package/resources/card-purchase-supplements.mjs +21 -0
  85. package/resources/card-purchase-supplements.mjs.map +1 -0
  86. package/resources/cards.d.ts +6 -13
  87. package/resources/cards.d.ts.map +1 -1
  88. package/resources/cards.js.map +1 -1
  89. package/resources/cards.mjs.map +1 -1
  90. package/resources/check-deposits.d.ts +7 -7
  91. package/resources/check-deposits.d.ts.map +1 -1
  92. package/resources/check-deposits.js.map +1 -1
  93. package/resources/check-deposits.mjs.map +1 -1
  94. package/resources/check-transfers.d.ts +18 -11
  95. package/resources/check-transfers.d.ts.map +1 -1
  96. package/resources/check-transfers.js.map +1 -1
  97. package/resources/check-transfers.mjs.map +1 -1
  98. package/resources/declined-transactions.d.ts +25 -28
  99. package/resources/declined-transactions.d.ts.map +1 -1
  100. package/resources/declined-transactions.js.map +1 -1
  101. package/resources/declined-transactions.mjs.map +1 -1
  102. package/resources/digital-wallet-tokens.d.ts +3 -6
  103. package/resources/digital-wallet-tokens.d.ts.map +1 -1
  104. package/resources/digital-wallet-tokens.js.map +1 -1
  105. package/resources/digital-wallet-tokens.mjs.map +1 -1
  106. package/resources/documents.d.ts +3 -3
  107. package/resources/documents.d.ts.map +1 -1
  108. package/resources/entities/beneficial-owners.d.ts +215 -0
  109. package/resources/entities/beneficial-owners.d.ts.map +1 -0
  110. package/resources/entities/beneficial-owners.js +18 -0
  111. package/resources/entities/beneficial-owners.js.map +1 -0
  112. package/resources/entities/beneficial-owners.mjs +12 -0
  113. package/resources/entities/beneficial-owners.mjs.map +1 -0
  114. package/resources/entities/entities.d.ts +15 -11
  115. package/resources/entities/entities.d.ts.map +1 -1
  116. package/resources/entities/entities.js +9 -0
  117. package/resources/entities/entities.js.map +1 -1
  118. package/resources/entities/entities.mjs +9 -0
  119. package/resources/entities/entities.mjs.map +1 -1
  120. package/resources/entities/index.d.ts +1 -0
  121. package/resources/entities/index.d.ts.map +1 -1
  122. package/resources/entities/index.js +8 -0
  123. package/resources/entities/index.js.map +1 -1
  124. package/resources/entities/index.mjs +1 -0
  125. package/resources/entities/index.mjs.map +1 -1
  126. package/resources/entities/supplemental-documents.d.ts +2 -2
  127. package/resources/entities/supplemental-documents.d.ts.map +1 -1
  128. package/resources/event-subscriptions.d.ts +5 -8
  129. package/resources/event-subscriptions.d.ts.map +1 -1
  130. package/resources/event-subscriptions.js.map +1 -1
  131. package/resources/event-subscriptions.mjs.map +1 -1
  132. package/resources/events.d.ts +7 -5
  133. package/resources/events.d.ts.map +1 -1
  134. package/resources/events.js.map +1 -1
  135. package/resources/events.mjs.map +1 -1
  136. package/resources/exports.d.ts +4 -4
  137. package/resources/exports.d.ts.map +1 -1
  138. package/resources/external-accounts.d.ts +5 -11
  139. package/resources/external-accounts.d.ts.map +1 -1
  140. package/resources/external-accounts.js.map +1 -1
  141. package/resources/external-accounts.mjs.map +1 -1
  142. package/resources/files.d.ts +9 -4
  143. package/resources/files.d.ts.map +1 -1
  144. package/resources/files.js +2 -2
  145. package/resources/files.js.map +1 -1
  146. package/resources/files.mjs +2 -2
  147. package/resources/files.mjs.map +1 -1
  148. package/resources/groups.d.ts +1 -1
  149. package/resources/groups.d.ts.map +1 -1
  150. package/resources/inbound-ach-transfer-returns.d.ts +6 -4
  151. package/resources/inbound-ach-transfer-returns.d.ts.map +1 -1
  152. package/resources/inbound-ach-transfer-returns.js.map +1 -1
  153. package/resources/inbound-ach-transfer-returns.mjs.map +1 -1
  154. package/resources/inbound-wire-drawdown-requests.d.ts +5 -3
  155. package/resources/inbound-wire-drawdown-requests.d.ts.map +1 -1
  156. package/resources/inbound-wire-drawdown-requests.js.map +1 -1
  157. package/resources/inbound-wire-drawdown-requests.mjs.map +1 -1
  158. package/resources/index.d.ts +6 -0
  159. package/resources/index.d.ts.map +1 -1
  160. package/resources/index.js +18 -3
  161. package/resources/index.js.map +1 -1
  162. package/resources/index.mjs +1 -0
  163. package/resources/index.mjs.map +1 -1
  164. package/resources/limits.d.ts +5 -9
  165. package/resources/limits.d.ts.map +1 -1
  166. package/resources/limits.js.map +1 -1
  167. package/resources/limits.mjs.map +1 -1
  168. package/resources/oauth-connections.d.ts +3 -6
  169. package/resources/oauth-connections.d.ts.map +1 -1
  170. package/resources/oauth-connections.js.map +1 -1
  171. package/resources/oauth-connections.mjs.map +1 -1
  172. package/resources/pending-transactions.d.ts +32 -37
  173. package/resources/pending-transactions.d.ts.map +1 -1
  174. package/resources/pending-transactions.js.map +1 -1
  175. package/resources/pending-transactions.mjs.map +1 -1
  176. package/resources/programs.d.ts +3 -3
  177. package/resources/programs.d.ts.map +1 -1
  178. package/resources/real-time-decisions.d.ts +2 -5
  179. package/resources/real-time-decisions.d.ts.map +1 -1
  180. package/resources/real-time-decisions.js.map +1 -1
  181. package/resources/real-time-decisions.mjs.map +1 -1
  182. package/resources/real-time-payments-transfers.d.ts +6 -4
  183. package/resources/real-time-payments-transfers.d.ts.map +1 -1
  184. package/resources/real-time-payments-transfers.js.map +1 -1
  185. package/resources/real-time-payments-transfers.mjs.map +1 -1
  186. package/resources/routing-numbers.d.ts +4 -1
  187. package/resources/routing-numbers.d.ts.map +1 -1
  188. package/resources/routing-numbers.js.map +1 -1
  189. package/resources/routing-numbers.mjs.map +1 -1
  190. package/resources/simulations/account-statements.d.ts +1 -1
  191. package/resources/simulations/account-statements.d.ts.map +1 -1
  192. package/resources/simulations/account-transfers.d.ts +1 -1
  193. package/resources/simulations/account-transfers.d.ts.map +1 -1
  194. package/resources/simulations/ach-transfers.d.ts +1063 -157
  195. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  196. package/resources/simulations/ach-transfers.js.map +1 -1
  197. package/resources/simulations/ach-transfers.mjs.map +1 -1
  198. package/resources/simulations/card-disputes.d.ts +1 -1
  199. package/resources/simulations/card-disputes.d.ts.map +1 -1
  200. package/resources/simulations/card-profiles.d.ts +1 -4
  201. package/resources/simulations/card-profiles.d.ts.map +1 -1
  202. package/resources/simulations/card-profiles.js.map +1 -1
  203. package/resources/simulations/card-profiles.mjs.map +1 -1
  204. package/resources/simulations/card-refunds.d.ts +1 -1
  205. package/resources/simulations/card-refunds.d.ts.map +1 -1
  206. package/resources/simulations/cards.d.ts +53 -58
  207. package/resources/simulations/cards.d.ts.map +1 -1
  208. package/resources/simulations/cards.js.map +1 -1
  209. package/resources/simulations/cards.mjs.map +1 -1
  210. package/resources/simulations/check-deposits.d.ts +3 -12
  211. package/resources/simulations/check-deposits.d.ts.map +1 -1
  212. package/resources/simulations/check-transfers.d.ts +2 -2
  213. package/resources/simulations/check-transfers.d.ts.map +1 -1
  214. package/resources/simulations/digital-wallet-token-requests.d.ts +1 -1
  215. package/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -1
  216. package/resources/simulations/documents.d.ts +1 -4
  217. package/resources/simulations/documents.d.ts.map +1 -1
  218. package/resources/simulations/documents.js.map +1 -1
  219. package/resources/simulations/documents.mjs.map +1 -1
  220. package/resources/simulations/inbound-funds-holds.d.ts +5 -1
  221. package/resources/simulations/inbound-funds-holds.d.ts.map +1 -1
  222. package/resources/simulations/inbound-funds-holds.js.map +1 -1
  223. package/resources/simulations/inbound-funds-holds.mjs.map +1 -1
  224. package/resources/simulations/inbound-wire-drawdown-requests.d.ts +1 -1
  225. package/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -1
  226. package/resources/simulations/interest-payments.d.ts +1047 -127
  227. package/resources/simulations/interest-payments.d.ts.map +1 -1
  228. package/resources/simulations/interest-payments.js.map +1 -1
  229. package/resources/simulations/interest-payments.mjs.map +1 -1
  230. package/resources/simulations/programs.d.ts +1 -4
  231. package/resources/simulations/programs.d.ts.map +1 -1
  232. package/resources/simulations/programs.js.map +1 -1
  233. package/resources/simulations/programs.mjs.map +1 -1
  234. package/resources/simulations/real-time-payments-transfers.d.ts +1062 -153
  235. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  236. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  237. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  238. package/resources/simulations/simulations.d.ts.map +1 -1
  239. package/resources/simulations/simulations.js.map +1 -1
  240. package/resources/simulations/wire-transfers.d.ts +1039 -127
  241. package/resources/simulations/wire-transfers.d.ts.map +1 -1
  242. package/resources/simulations/wire-transfers.js.map +1 -1
  243. package/resources/simulations/wire-transfers.mjs.map +1 -1
  244. package/resources/transactions.d.ts +1044 -130
  245. package/resources/transactions.d.ts.map +1 -1
  246. package/resources/transactions.js.map +1 -1
  247. package/resources/transactions.mjs.map +1 -1
  248. package/resources/wire-drawdown-requests.d.ts +4 -4
  249. package/resources/wire-drawdown-requests.d.ts.map +1 -1
  250. package/resources/wire-transfers.d.ts +11 -11
  251. package/resources/wire-transfers.d.ts.map +1 -1
  252. package/resources/wire-transfers.js.map +1 -1
  253. package/resources/wire-transfers.mjs.map +1 -1
  254. package/src/_shims/ReadableStream.d.ts +38 -0
  255. package/src/_shims/ReadableStream.js +5 -0
  256. package/src/_shims/ReadableStream.mjs +7 -0
  257. package/src/_shims/ReadableStream.node.ts +6 -0
  258. package/src/_shims/fetch.d.ts +8 -1
  259. package/src/_shims/fetch.deno.ts +23 -0
  260. package/src/_shims/fetch.node.d.ts +11 -1
  261. package/src/_shims/formdata.deno.ts +16 -0
  262. package/src/core.ts +270 -74
  263. package/src/error.ts +11 -1
  264. package/src/index.ts +16 -9
  265. package/src/pagination.ts +5 -5
  266. package/src/resources/account-numbers.ts +10 -10
  267. package/src/resources/account-statements.ts +5 -8
  268. package/src/resources/account-transfers.ts +8 -20
  269. package/src/resources/accounts.ts +8 -8
  270. package/src/resources/ach-prenotifications.ts +57 -9
  271. package/src/resources/ach-transfers.ts +19 -11
  272. package/src/resources/balance-lookups.ts +2 -2
  273. package/src/resources/bookkeeping-accounts.ts +5 -5
  274. package/src/resources/bookkeeping-entries.ts +4 -4
  275. package/src/resources/bookkeeping-entry-sets.ts +2 -2
  276. package/src/resources/card-disputes.ts +9 -9
  277. package/src/resources/card-profiles.ts +39 -13
  278. package/src/resources/card-purchase-supplements.ts +331 -0
  279. package/src/resources/cards.ts +8 -15
  280. package/src/resources/check-deposits.ts +9 -9
  281. package/src/resources/check-transfers.ts +21 -13
  282. package/src/resources/declined-transactions.ts +27 -30
  283. package/src/resources/digital-wallet-tokens.ts +5 -8
  284. package/src/resources/documents.ts +5 -5
  285. package/src/resources/entities/beneficial-owners.ts +251 -0
  286. package/src/resources/entities/entities.ts +21 -13
  287. package/src/resources/entities/index.ts +1 -0
  288. package/src/resources/entities/supplemental-documents.ts +3 -3
  289. package/src/resources/event-subscriptions.ts +7 -10
  290. package/src/resources/events.ts +9 -7
  291. package/src/resources/exports.ts +6 -6
  292. package/src/resources/external-accounts.ts +7 -13
  293. package/src/resources/files.ts +12 -7
  294. package/src/resources/groups.ts +2 -2
  295. package/src/resources/inbound-ach-transfer-returns.ts +8 -6
  296. package/src/resources/inbound-wire-drawdown-requests.ts +7 -5
  297. package/src/resources/index.ts +6 -0
  298. package/src/resources/limits.ts +7 -11
  299. package/src/resources/oauth-connections.ts +5 -8
  300. package/src/resources/pending-transactions.ts +35 -39
  301. package/src/resources/programs.ts +5 -5
  302. package/src/resources/real-time-decisions.ts +3 -6
  303. package/src/resources/real-time-payments-transfers.ts +8 -6
  304. package/src/resources/routing-numbers.ts +5 -2
  305. package/src/resources/simulations/account-statements.ts +2 -2
  306. package/src/resources/simulations/account-transfers.ts +1 -1
  307. package/src/resources/simulations/ach-transfers.ts +1200 -160
  308. package/src/resources/simulations/card-disputes.ts +2 -2
  309. package/src/resources/simulations/card-profiles.ts +1 -4
  310. package/src/resources/simulations/card-refunds.ts +2 -2
  311. package/src/resources/simulations/cards.ts +55 -59
  312. package/src/resources/simulations/check-deposits.ts +3 -3
  313. package/src/resources/simulations/check-transfers.ts +2 -2
  314. package/src/resources/simulations/digital-wallet-token-requests.ts +2 -2
  315. package/src/resources/simulations/documents.ts +2 -5
  316. package/src/resources/simulations/inbound-funds-holds.ts +7 -2
  317. package/src/resources/simulations/inbound-wire-drawdown-requests.ts +2 -2
  318. package/src/resources/simulations/interest-payments.ts +1186 -130
  319. package/src/resources/simulations/programs.ts +2 -5
  320. package/src/resources/simulations/real-time-payments-transfers.ts +1199 -156
  321. package/src/resources/simulations/simulations.ts +1 -1
  322. package/src/resources/simulations/wire-transfers.ts +1176 -130
  323. package/src/resources/transactions.ts +1182 -134
  324. package/src/resources/wire-drawdown-requests.ts +6 -6
  325. package/src/resources/wire-transfers.ts +13 -13
  326. package/src/uploads.ts +7 -6
  327. package/src/version.ts +1 -1
  328. package/uploads.d.ts +5 -4
  329. package/uploads.d.ts.map +1 -1
  330. package/uploads.js +2 -2
  331. package/uploads.js.map +1 -1
  332. package/uploads.mjs +2 -2
  333. package/uploads.mjs.map +1 -1
  334. package/version.d.ts +1 -1
  335. package/version.js +1 -1
  336. package/version.mjs +1 -1
@@ -15,7 +15,7 @@ export declare class ACHTransfers extends APIResource {
15
15
  createInbound(
16
16
  body: ACHTransferCreateInboundParams,
17
17
  options?: Core.RequestOptions,
18
- ): Promise<Core.APIResponse<ACHTransferSimulation>>;
18
+ ): Core.APIPromise<ACHTransferSimulation>;
19
19
  /**
20
20
  * Simulates the return of an [ACH Transfer](#ach-transfers) by the Federal Reserve
21
21
  * due to an error condition. This will also create a Transaction to account for
@@ -25,7 +25,7 @@ export declare class ACHTransfers extends APIResource {
25
25
  achTransferId: string,
26
26
  body: ACHTransferReturnParams,
27
27
  options?: Core.RequestOptions,
28
- ): Promise<Core.APIResponse<ACHTransfers_.ACHTransfer>>;
28
+ ): Core.APIPromise<ACHTransfers_.ACHTransfer>;
29
29
  /**
30
30
  * Simulates the submission of an [ACH Transfer](#ach-transfers) to the Federal
31
31
  * Reserve. This transfer must first have a `status` of `pending_approval` or
@@ -34,10 +34,7 @@ export declare class ACHTransfers extends APIResource {
34
34
  * not submitted to the Federal Reserve, this endpoint allows you to skip that
35
35
  * delay and transition the ACH Transfer to a status of `submitted`.
36
36
  */
37
- submit(
38
- achTransferId: string,
39
- options?: Core.RequestOptions,
40
- ): Promise<Core.APIResponse<ACHTransfers_.ACHTransfer>>;
37
+ submit(achTransferId: string, options?: Core.RequestOptions): Core.APIPromise<ACHTransfers_.ACHTransfer>;
41
38
  }
42
39
  /**
43
40
  * The results of an inbound ACH Transfer simulation.
@@ -139,7 +136,7 @@ export declare namespace ACHTransferSimulation {
139
136
  */
140
137
  interface Source {
141
138
  /**
142
- * A ACH Decline object. This field will be present in the JSON response if and
139
+ * An ACH Decline object. This field will be present in the JSON response if and
143
140
  * only if `category` is equal to `ach_decline`.
144
141
  */
145
142
  ach_decline: Source.ACHDecline | null;
@@ -149,24 +146,21 @@ export declare namespace ACHTransferSimulation {
149
146
  */
150
147
  card_decline: Source.CardDecline | null;
151
148
  /**
152
- * The type of decline that took place. We may add additional possible values for
153
- * this enum over time; your application should be able to handle such additions
154
- * gracefully.
149
+ * The type of the resource. We may add additional possible values for this enum
150
+ * over time; your application should be able to handle such additions gracefully.
155
151
  *
156
- * - `ach_decline` - The Declined Transaction was created by a ACH Decline object.
157
- * Details will be under the `ach_decline` object.
158
- * - `card_decline` - The Declined Transaction was created by a Card Decline
159
- * object. Details will be under the `card_decline` object.
160
- * - `check_decline` - The Declined Transaction was created by a Check Decline
161
- * object. Details will be under the `check_decline` object.
162
- * - `inbound_real_time_payments_transfer_decline` - The Declined Transaction was
163
- * created by a Inbound Real Time Payments Transfer Decline object. Details will
164
- * be under the `inbound_real_time_payments_transfer_decline` object.
165
- * - `international_ach_decline` - The Declined Transaction was created by a
166
- * International ACH Decline object. Details will be under the
167
- * `international_ach_decline` object.
168
- * - `wire_decline` - The Declined Transaction was created by a Wire Decline
169
- * object. Details will be under the `wire_decline` object.
152
+ * - `ach_decline` - ACH Decline: details will be under the `ach_decline` object.
153
+ * - `card_decline` - Card Decline: details will be under the `card_decline`
154
+ * object.
155
+ * - `check_decline` - Check Decline: details will be under the `check_decline`
156
+ * object.
157
+ * - `inbound_real_time_payments_transfer_decline` - Inbound Real Time Payments
158
+ * Transfer Decline: details will be under the
159
+ * `inbound_real_time_payments_transfer_decline` object.
160
+ * - `international_ach_decline` - International ACH Decline: details will be under
161
+ * the `international_ach_decline` object.
162
+ * - `wire_decline` - Wire Decline: details will be under the `wire_decline`
163
+ * object.
170
164
  * - `other` - The Declined Transaction was made for an undocumented or deprecated
171
165
  * reason.
172
166
  */
@@ -184,13 +178,13 @@ export declare namespace ACHTransferSimulation {
184
178
  */
185
179
  check_decline: Source.CheckDecline | null;
186
180
  /**
187
- * A Inbound Real Time Payments Transfer Decline object. This field will be present
188
- * in the JSON response if and only if `category` is equal to
181
+ * An Inbound Real Time Payments Transfer Decline object. This field will be
182
+ * present in the JSON response if and only if `category` is equal to
189
183
  * `inbound_real_time_payments_transfer_decline`.
190
184
  */
191
185
  inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
192
186
  /**
193
- * A International ACH Decline object. This field will be present in the JSON
187
+ * An International ACH Decline object. This field will be present in the JSON
194
188
  * response if and only if `category` is equal to `international_ach_decline`.
195
189
  */
196
190
  international_ach_decline: Source.InternationalACHDecline | null;
@@ -202,7 +196,7 @@ export declare namespace ACHTransferSimulation {
202
196
  }
203
197
  namespace Source {
204
198
  /**
205
- * A ACH Decline object. This field will be present in the JSON response if and
199
+ * An ACH Decline object. This field will be present in the JSON response if and
206
200
  * only if `category` is equal to `ach_decline`.
207
201
  */
208
202
  interface ACHDecline {
@@ -478,8 +472,8 @@ export declare namespace ACHTransferSimulation {
478
472
  | 'altered_or_fictitious';
479
473
  }
480
474
  /**
481
- * A Inbound Real Time Payments Transfer Decline object. This field will be present
482
- * in the JSON response if and only if `category` is equal to
475
+ * An Inbound Real Time Payments Transfer Decline object. This field will be
476
+ * present in the JSON response if and only if `category` is equal to
483
477
  * `inbound_real_time_payments_transfer_decline`.
484
478
  */
485
479
  interface InboundRealTimePaymentsTransferDecline {
@@ -545,7 +539,7 @@ export declare namespace ACHTransferSimulation {
545
539
  transaction_identification: string;
546
540
  }
547
541
  /**
548
- * A International ACH Decline object. This field will be present in the JSON
542
+ * An International ACH Decline object. This field will be present in the JSON
549
543
  * response if and only if `category` is equal to `international_ach_decline`.
550
544
  */
551
545
  interface InternationalACHDecline {
@@ -713,23 +707,23 @@ export declare namespace ACHTransferSimulation {
713
707
  */
714
708
  interface Source {
715
709
  /**
716
- * A Account Transfer Intention object. This field will be present in the JSON
710
+ * An Account Transfer Intention object. This field will be present in the JSON
717
711
  * response if and only if `category` is equal to `account_transfer_intention`.
718
712
  */
719
713
  account_transfer_intention: Source.AccountTransferIntention | null;
720
714
  /**
721
- * A ACH Transfer Intention object. This field will be present in the JSON response
722
- * if and only if `category` is equal to `ach_transfer_intention`.
715
+ * An ACH Transfer Intention object. This field will be present in the JSON
716
+ * response if and only if `category` is equal to `ach_transfer_intention`.
723
717
  */
724
718
  ach_transfer_intention: Source.ACHTransferIntention | null;
725
719
  /**
726
- * A ACH Transfer Rejection object. This field will be present in the JSON response
727
- * if and only if `category` is equal to `ach_transfer_rejection`.
720
+ * An ACH Transfer Rejection object. This field will be present in the JSON
721
+ * response if and only if `category` is equal to `ach_transfer_rejection`.
728
722
  */
729
723
  ach_transfer_rejection: Source.ACHTransferRejection | null;
730
724
  /**
731
- * A ACH Transfer Return object. This field will be present in the JSON response if
732
- * and only if `category` is equal to `ach_transfer_return`.
725
+ * An ACH Transfer Return object. This field will be present in the JSON response
726
+ * if and only if `category` is equal to `ach_transfer_return`.
733
727
  */
734
728
  ach_transfer_return: Source.ACHTransferReturn | null;
735
729
  /**
@@ -753,79 +747,69 @@ export declare namespace ACHTransferSimulation {
753
747
  */
754
748
  card_settlement: Source.CardSettlement | null;
755
749
  /**
756
- * The type of transaction that took place. We may add additional possible values
757
- * for this enum over time; your application should be able to handle such
758
- * additions gracefully.
750
+ * The type of the resource. We may add additional possible values for this enum
751
+ * over time; your application should be able to handle such additions gracefully.
759
752
  *
760
- * - `account_transfer_intention` - The Transaction was created by a Account
761
- * Transfer Intention object. Details will be under the
762
- * `account_transfer_intention` object.
763
- * - `ach_transfer_intention` - The Transaction was created by a ACH Transfer
764
- * Intention object. Details will be under the `ach_transfer_intention` object.
765
- * - `ach_transfer_rejection` - The Transaction was created by a ACH Transfer
766
- * Rejection object. Details will be under the `ach_transfer_rejection` object.
767
- * - `ach_transfer_return` - The Transaction was created by a ACH Transfer Return
768
- * object. Details will be under the `ach_transfer_return` object.
769
- * - `card_dispute_acceptance` - The Transaction was created by a Card Dispute
770
- * Acceptance object. Details will be under the `card_dispute_acceptance` object.
771
- * - `card_refund` - The Transaction was created by a Card Refund object. Details
772
- * will be under the `card_refund` object.
773
- * - `card_revenue_payment` - The Transaction was created by a Card Revenue Payment
774
- * object. Details will be under the `card_revenue_payment` object.
775
- * - `card_settlement` - The Transaction was created by a Card Settlement object.
776
- * Details will be under the `card_settlement` object.
777
- * - `check_deposit_acceptance` - The Transaction was created by a Check Deposit
778
- * Acceptance object. Details will be under the `check_deposit_acceptance`
753
+ * - `account_transfer_intention` - Account Transfer Intention: details will be
754
+ * under the `account_transfer_intention` object.
755
+ * - `ach_transfer_intention` - ACH Transfer Intention: details will be under the
756
+ * `ach_transfer_intention` object.
757
+ * - `ach_transfer_rejection` - ACH Transfer Rejection: details will be under the
758
+ * `ach_transfer_rejection` object.
759
+ * - `ach_transfer_return` - ACH Transfer Return: details will be under the
760
+ * `ach_transfer_return` object.
761
+ * - `card_dispute_acceptance` - Card Dispute Acceptance: details will be under the
762
+ * `card_dispute_acceptance` object.
763
+ * - `card_refund` - Card Refund: details will be under the `card_refund` object.
764
+ * - `card_revenue_payment` - Card Revenue Payment: details will be under the
765
+ * `card_revenue_payment` object.
766
+ * - `card_settlement` - Card Settlement: details will be under the
767
+ * `card_settlement` object.
768
+ * - `check_deposit_acceptance` - Check Deposit Acceptance: details will be under
769
+ * the `check_deposit_acceptance` object.
770
+ * - `check_deposit_return` - Check Deposit Return: details will be under the
771
+ * `check_deposit_return` object.
772
+ * - `check_transfer_deposit` - Check Transfer Deposit: details will be under the
773
+ * `check_transfer_deposit` object.
774
+ * - `check_transfer_intention` - Check Transfer Intention: details will be under
775
+ * the `check_transfer_intention` object.
776
+ * - `check_transfer_stop_payment_request` - Check Transfer Stop Payment Request:
777
+ * details will be under the `check_transfer_stop_payment_request` object.
778
+ * - `fee_payment` - Fee Payment: details will be under the `fee_payment` object.
779
+ * - `inbound_ach_transfer` - Inbound ACH Transfer Intention: details will be under
780
+ * the `inbound_ach_transfer` object.
781
+ * - `inbound_ach_transfer_return_intention` - Inbound ACH Transfer Return
782
+ * Intention: details will be under the `inbound_ach_transfer_return_intention`
783
+ * object.
784
+ * - `inbound_check` - Inbound Check: details will be under the `inbound_check`
779
785
  * object.
780
- * - `check_deposit_return` - The Transaction was created by a Check Deposit Return
781
- * object. Details will be under the `check_deposit_return` object.
782
- * - `check_transfer_deposit` - The Transaction was created by a Check Transfer
783
- * Deposit object. Details will be under the `check_transfer_deposit` object.
784
- * - `check_transfer_intention` - The Transaction was created by a Check Transfer
785
- * Intention object. Details will be under the `check_transfer_intention` object.
786
- * - `check_transfer_rejection` - The Transaction was created by a Check Transfer
787
- * Rejection object. Details will be under the `check_transfer_rejection` object.
788
- * - `check_transfer_stop_payment_request` - The Transaction was created by a Check
789
- * Transfer Stop Payment Request object. Details will be under the
790
- * `check_transfer_stop_payment_request` object.
791
- * - `fee_payment` - The Transaction was created by a Fee Payment object. Details
792
- * will be under the `fee_payment` object.
793
- * - `inbound_ach_transfer` - The Transaction was created by a Inbound ACH Transfer
794
- * object. Details will be under the `inbound_ach_transfer` object.
795
- * - `inbound_ach_transfer_return_intention` - The Transaction was created by a
796
- * Inbound ACH Transfer Return Intention object. Details will be under the
797
- * `inbound_ach_transfer_return_intention` object.
798
- * - `inbound_check` - The Transaction was created by a Inbound Check object.
799
- * Details will be under the `inbound_check` object.
800
- * - `inbound_international_ach_transfer` - The Transaction was created by a
801
- * Inbound International ACH Transfer object. Details will be under the
802
- * `inbound_international_ach_transfer` object.
803
- * - `inbound_real_time_payments_transfer_confirmation` - The Transaction was
804
- * created by a Inbound Real Time Payments Transfer Confirmation object. Details
805
- * will be under the `inbound_real_time_payments_transfer_confirmation` object.
806
- * - `inbound_wire_drawdown_payment` - The Transaction was created by a Inbound
807
- * Wire Drawdown Payment object. Details will be under the
808
- * `inbound_wire_drawdown_payment` object.
809
- * - `inbound_wire_drawdown_payment_reversal` - The Transaction was created by a
810
- * Inbound Wire Drawdown Payment Reversal object. Details will be under the
811
- * `inbound_wire_drawdown_payment_reversal` object.
812
- * - `inbound_wire_reversal` - The Transaction was created by a Inbound Wire
813
- * Reversal object. Details will be under the `inbound_wire_reversal` object.
814
- * - `inbound_wire_transfer` - The Transaction was created by a Inbound Wire
815
- * Transfer object. Details will be under the `inbound_wire_transfer` object.
816
- * - `interest_payment` - The Transaction was created by a Interest Payment object.
817
- * Details will be under the `interest_payment` object.
818
- * - `internal_source` - The Transaction was created by a Internal Source object.
819
- * Details will be under the `internal_source` object.
820
- * - `real_time_payments_transfer_acknowledgement` - The Transaction was created by
821
- * a Real Time Payments Transfer Acknowledgement object. Details will be under
822
- * the `real_time_payments_transfer_acknowledgement` object.
823
- * - `sample_funds` - The Transaction was created by a Sample Funds object. Details
824
- * will be under the `sample_funds` object.
825
- * - `wire_transfer_intention` - The Transaction was created by a Wire Transfer
826
- * Intention object. Details will be under the `wire_transfer_intention` object.
827
- * - `wire_transfer_rejection` - The Transaction was created by a Wire Transfer
828
- * Rejection object. Details will be under the `wire_transfer_rejection` object.
786
+ * - `inbound_international_ach_transfer` - Inbound International ACH Transfer:
787
+ * details will be under the `inbound_international_ach_transfer` object.
788
+ * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real Time
789
+ * Payments Transfer Confirmation: details will be under the
790
+ * `inbound_real_time_payments_transfer_confirmation` object.
791
+ * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
792
+ * be under the `inbound_wire_drawdown_payment` object.
793
+ * - `inbound_wire_drawdown_payment_reversal` - Inbound Wire Drawdown Payment
794
+ * Reversal: details will be under the `inbound_wire_drawdown_payment_reversal`
795
+ * object.
796
+ * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
797
+ * `inbound_wire_reversal` object.
798
+ * - `inbound_wire_transfer` - Inbound Wire Transfer: details will be under the
799
+ * `inbound_wire_transfer` object.
800
+ * - `interest_payment` - Interest Payment: details will be under the
801
+ * `interest_payment` object.
802
+ * - `internal_source` - Internal Source: details will be under the
803
+ * `internal_source` object.
804
+ * - `real_time_payments_transfer_acknowledgement` - Real Time Payments Transfer
805
+ * Acknowledgement: details will be under the
806
+ * `real_time_payments_transfer_acknowledgement` object.
807
+ * - `sample_funds` - Sample Funds: details will be under the `sample_funds`
808
+ * object.
809
+ * - `wire_transfer_intention` - Wire Transfer Intention: details will be under the
810
+ * `wire_transfer_intention` object.
811
+ * - `wire_transfer_rejection` - Wire Transfer Rejection: details will be under the
812
+ * `wire_transfer_rejection` object.
829
813
  * - `other` - The Transaction was made for an undocumented or deprecated reason.
830
814
  */
831
815
  category:
@@ -841,7 +825,6 @@ export declare namespace ACHTransferSimulation {
841
825
  | 'check_deposit_return'
842
826
  | 'check_transfer_deposit'
843
827
  | 'check_transfer_intention'
844
- | 'check_transfer_rejection'
845
828
  | 'check_transfer_stop_payment_request'
846
829
  | 'fee_payment'
847
830
  | 'inbound_ach_transfer'
@@ -880,11 +863,6 @@ export declare namespace ACHTransferSimulation {
880
863
  * response if and only if `category` is equal to `check_transfer_intention`.
881
864
  */
882
865
  check_transfer_intention: Source.CheckTransferIntention | null;
883
- /**
884
- * A Check Transfer Rejection object. This field will be present in the JSON
885
- * response if and only if `category` is equal to `check_transfer_rejection`.
886
- */
887
- check_transfer_rejection: Source.CheckTransferRejection | null;
888
866
  /**
889
867
  * A Check Transfer Stop Payment Request object. This field will be present in the
890
868
  * JSON response if and only if `category` is equal to
@@ -897,56 +875,56 @@ export declare namespace ACHTransferSimulation {
897
875
  */
898
876
  fee_payment: Source.FeePayment | null;
899
877
  /**
900
- * A Inbound ACH Transfer object. This field will be present in the JSON response
901
- * if and only if `category` is equal to `inbound_ach_transfer`.
878
+ * An Inbound ACH Transfer Intention object. This field will be present in the JSON
879
+ * response if and only if `category` is equal to `inbound_ach_transfer`.
902
880
  */
903
881
  inbound_ach_transfer: Source.InboundACHTransfer | null;
904
882
  /**
905
- * A Inbound Check object. This field will be present in the JSON response if and
883
+ * An Inbound Check object. This field will be present in the JSON response if and
906
884
  * only if `category` is equal to `inbound_check`.
907
885
  */
908
886
  inbound_check: Source.InboundCheck | null;
909
887
  /**
910
- * A Inbound International ACH Transfer object. This field will be present in the
888
+ * An Inbound International ACH Transfer object. This field will be present in the
911
889
  * JSON response if and only if `category` is equal to
912
890
  * `inbound_international_ach_transfer`.
913
891
  */
914
892
  inbound_international_ach_transfer: Source.InboundInternationalACHTransfer | null;
915
893
  /**
916
- * A Inbound Real Time Payments Transfer Confirmation object. This field will be
894
+ * An Inbound Real Time Payments Transfer Confirmation object. This field will be
917
895
  * present in the JSON response if and only if `category` is equal to
918
896
  * `inbound_real_time_payments_transfer_confirmation`.
919
897
  */
920
898
  inbound_real_time_payments_transfer_confirmation: Source.InboundRealTimePaymentsTransferConfirmation | null;
921
899
  /**
922
- * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
900
+ * An Inbound Wire Drawdown Payment object. This field will be present in the JSON
923
901
  * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
924
902
  */
925
903
  inbound_wire_drawdown_payment: Source.InboundWireDrawdownPayment | null;
926
904
  /**
927
- * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
905
+ * An Inbound Wire Drawdown Payment Reversal object. This field will be present in
928
906
  * the JSON response if and only if `category` is equal to
929
907
  * `inbound_wire_drawdown_payment_reversal`.
930
908
  */
931
909
  inbound_wire_drawdown_payment_reversal: Source.InboundWireDrawdownPaymentReversal | null;
932
910
  /**
933
- * A Inbound Wire Reversal object. This field will be present in the JSON response
911
+ * An Inbound Wire Reversal object. This field will be present in the JSON response
934
912
  * if and only if `category` is equal to `inbound_wire_reversal`.
935
913
  */
936
914
  inbound_wire_reversal: Source.InboundWireReversal | null;
937
915
  /**
938
- * A Inbound Wire Transfer object. This field will be present in the JSON response
916
+ * An Inbound Wire Transfer object. This field will be present in the JSON response
939
917
  * if and only if `category` is equal to `inbound_wire_transfer`.
940
918
  */
941
919
  inbound_wire_transfer: Source.InboundWireTransfer | null;
942
920
  /**
943
- * A Interest Payment object. This field will be present in the JSON response if
921
+ * An Interest Payment object. This field will be present in the JSON response if
944
922
  * and only if `category` is equal to `interest_payment`.
945
923
  */
946
924
  interest_payment: Source.InterestPayment | null;
947
925
  /**
948
- * A Internal Source object. This field will be present in the JSON response if and
949
- * only if `category` is equal to `internal_source`.
926
+ * An Internal Source object. This field will be present in the JSON response if
927
+ * and only if `category` is equal to `internal_source`.
950
928
  */
951
929
  internal_source: Source.InternalSource | null;
952
930
  /**
@@ -973,7 +951,7 @@ export declare namespace ACHTransferSimulation {
973
951
  }
974
952
  namespace Source {
975
953
  /**
976
- * A Account Transfer Intention object. This field will be present in the JSON
954
+ * An Account Transfer Intention object. This field will be present in the JSON
977
955
  * response if and only if `category` is equal to `account_transfer_intention`.
978
956
  */
979
957
  interface AccountTransferIntention {
@@ -1012,8 +990,8 @@ export declare namespace ACHTransferSimulation {
1012
990
  transfer_id: string;
1013
991
  }
1014
992
  /**
1015
- * A ACH Transfer Intention object. This field will be present in the JSON response
1016
- * if and only if `category` is equal to `ach_transfer_intention`.
993
+ * An ACH Transfer Intention object. This field will be present in the JSON
994
+ * response if and only if `category` is equal to `ach_transfer_intention`.
1017
995
  */
1018
996
  interface ACHTransferIntention {
1019
997
  account_number: string;
@@ -1030,8 +1008,8 @@ export declare namespace ACHTransferSimulation {
1030
1008
  transfer_id: string;
1031
1009
  }
1032
1010
  /**
1033
- * A ACH Transfer Rejection object. This field will be present in the JSON response
1034
- * if and only if `category` is equal to `ach_transfer_rejection`.
1011
+ * An ACH Transfer Rejection object. This field will be present in the JSON
1012
+ * response if and only if `category` is equal to `ach_transfer_rejection`.
1035
1013
  */
1036
1014
  interface ACHTransferRejection {
1037
1015
  /**
@@ -1040,8 +1018,8 @@ export declare namespace ACHTransferSimulation {
1040
1018
  transfer_id: string;
1041
1019
  }
1042
1020
  /**
1043
- * A ACH Transfer Return object. This field will be present in the JSON response if
1044
- * and only if `category` is equal to `ach_transfer_return`.
1021
+ * An ACH Transfer Return object. This field will be present in the JSON response
1022
+ * if and only if `category` is equal to `ach_transfer_return`.
1045
1023
  */
1046
1024
  interface ACHTransferReturn {
1047
1025
  /**
@@ -1352,6 +1330,11 @@ export declare namespace ACHTransferSimulation {
1352
1330
  * The state the merchant resides in.
1353
1331
  */
1354
1332
  merchant_state: string | null;
1333
+ /**
1334
+ * Additional details about the card purchase, such as tax and industry-specific
1335
+ * fields.
1336
+ */
1337
+ purchase_details: CardRefund.PurchaseDetails | null;
1355
1338
  /**
1356
1339
  * The identifier of the Transaction associated with this Transaction.
1357
1340
  */
@@ -1362,6 +1345,468 @@ export declare namespace ACHTransferSimulation {
1362
1345
  */
1363
1346
  type: 'card_refund';
1364
1347
  }
1348
+ namespace CardRefund {
1349
+ /**
1350
+ * Additional details about the card purchase, such as tax and industry-specific
1351
+ * fields.
1352
+ */
1353
+ interface PurchaseDetails {
1354
+ /**
1355
+ * Fields specific to car rentals.
1356
+ */
1357
+ car_rental: PurchaseDetails.CarRental | null;
1358
+ /**
1359
+ * An identifier from the merchant for the customer or consumer.
1360
+ */
1361
+ customer_reference_identifier: string | null;
1362
+ /**
1363
+ * The state or provincial tax amount in minor units.
1364
+ */
1365
+ local_tax_amount: number | null;
1366
+ /**
1367
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1368
+ * assessed.
1369
+ */
1370
+ local_tax_currency: string | null;
1371
+ /**
1372
+ * Fields specific to lodging.
1373
+ */
1374
+ lodging: PurchaseDetails.Lodging | null;
1375
+ /**
1376
+ * The national tax amount in minor units.
1377
+ */
1378
+ national_tax_amount: number | null;
1379
+ /**
1380
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1381
+ * assessed.
1382
+ */
1383
+ national_tax_currency: string | null;
1384
+ /**
1385
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
1386
+ */
1387
+ purchase_identifier: string | null;
1388
+ /**
1389
+ * The format of the purchase identifier.
1390
+ *
1391
+ * - `free_text` - Free text
1392
+ * - `order_number` - Order number
1393
+ * - `rental_agreement_number` - Rental agreement number
1394
+ * - `hotel_folio_number` - Hotel folio number
1395
+ * - `invoice_number` - Invoice number
1396
+ */
1397
+ purchase_identifier_format:
1398
+ | 'free_text'
1399
+ | 'order_number'
1400
+ | 'rental_agreement_number'
1401
+ | 'hotel_folio_number'
1402
+ | 'invoice_number'
1403
+ | null;
1404
+ /**
1405
+ * Fields specific to travel.
1406
+ */
1407
+ travel: PurchaseDetails.Travel | null;
1408
+ }
1409
+ namespace PurchaseDetails {
1410
+ /**
1411
+ * Fields specific to car rentals.
1412
+ */
1413
+ interface CarRental {
1414
+ /**
1415
+ * Code indicating the vehicle's class.
1416
+ */
1417
+ car_class_code: string | null;
1418
+ /**
1419
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
1420
+ * transaction, the scheduled pick up date.
1421
+ */
1422
+ checkout_date: string | null;
1423
+ /**
1424
+ * Daily rate being charged for the vehicle.
1425
+ */
1426
+ daily_rental_rate_amount: number | null;
1427
+ /**
1428
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
1429
+ * rate.
1430
+ */
1431
+ daily_rental_rate_currency: string | null;
1432
+ /**
1433
+ * Number of days the vehicle was rented.
1434
+ */
1435
+ days_rented: number | null;
1436
+ /**
1437
+ * Additional charges (gas, late fee, etc.) being billed.
1438
+ *
1439
+ * - `no_extra_charge` - No extra charge
1440
+ * - `gas` - Gas
1441
+ * - `extra_mileage` - Extra mileage
1442
+ * - `late_return` - Late return
1443
+ * - `one_way_service_fee` - One way service fee
1444
+ * - `parking_violation` - Parking violation
1445
+ */
1446
+ extra_charges:
1447
+ | 'no_extra_charge'
1448
+ | 'gas'
1449
+ | 'extra_mileage'
1450
+ | 'late_return'
1451
+ | 'one_way_service_fee'
1452
+ | 'parking_violation'
1453
+ | null;
1454
+ /**
1455
+ * Fuel charges for the vehicle.
1456
+ */
1457
+ fuel_charges_amount: number | null;
1458
+ /**
1459
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
1460
+ * assessed.
1461
+ */
1462
+ fuel_charges_currency: string | null;
1463
+ /**
1464
+ * Any insurance being charged for the vehicle.
1465
+ */
1466
+ insurance_charges_amount: number | null;
1467
+ /**
1468
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
1469
+ * charges assessed.
1470
+ */
1471
+ insurance_charges_currency: string | null;
1472
+ /**
1473
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
1474
+ * not actually rented (that is, a "no-show" charge).
1475
+ *
1476
+ * - `not_applicable` - Not applicable
1477
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
1478
+ */
1479
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
1480
+ /**
1481
+ * Charges for returning the vehicle at a different location than where it was
1482
+ * picked up.
1483
+ */
1484
+ one_way_drop_off_charges_amount: number | null;
1485
+ /**
1486
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
1487
+ * drop-off charges assessed.
1488
+ */
1489
+ one_way_drop_off_charges_currency: string | null;
1490
+ /**
1491
+ * Name of the person renting the vehicle.
1492
+ */
1493
+ renter_name: string | null;
1494
+ /**
1495
+ * Weekly rate being charged for the vehicle.
1496
+ */
1497
+ weekly_rental_rate_amount: number | null;
1498
+ /**
1499
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
1500
+ * rental rate.
1501
+ */
1502
+ weekly_rental_rate_currency: string | null;
1503
+ }
1504
+ /**
1505
+ * Fields specific to lodging.
1506
+ */
1507
+ interface Lodging {
1508
+ /**
1509
+ * Date the customer checked in.
1510
+ */
1511
+ check_in_date: string | null;
1512
+ /**
1513
+ * Daily rate being charged for the room.
1514
+ */
1515
+ daily_room_rate_amount: number | null;
1516
+ /**
1517
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
1518
+ * rate.
1519
+ */
1520
+ daily_room_rate_currency: string | null;
1521
+ /**
1522
+ * Additional charges (phone, late check-out, etc.) being billed.
1523
+ *
1524
+ * - `no_extra_charge` - No extra charge
1525
+ * - `restaurant` - Restaurant
1526
+ * - `gift_shop` - Gift shop
1527
+ * - `mini_bar` - Mini bar
1528
+ * - `telephone` - Telephone
1529
+ * - `other` - Other
1530
+ * - `laundry` - Laundry
1531
+ */
1532
+ extra_charges:
1533
+ | 'no_extra_charge'
1534
+ | 'restaurant'
1535
+ | 'gift_shop'
1536
+ | 'mini_bar'
1537
+ | 'telephone'
1538
+ | 'other'
1539
+ | 'laundry'
1540
+ | null;
1541
+ /**
1542
+ * Folio cash advances for the room.
1543
+ */
1544
+ folio_cash_advances_amount: number | null;
1545
+ /**
1546
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
1547
+ * advances.
1548
+ */
1549
+ folio_cash_advances_currency: string | null;
1550
+ /**
1551
+ * Food and beverage charges for the room.
1552
+ */
1553
+ food_beverage_charges_amount: number | null;
1554
+ /**
1555
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
1556
+ * beverage charges.
1557
+ */
1558
+ food_beverage_charges_currency: string | null;
1559
+ /**
1560
+ * Indicator that the cardholder is being billed for a reserved room that was not
1561
+ * actually used.
1562
+ *
1563
+ * - `not_applicable` - Not applicable
1564
+ * - `no_show` - No show
1565
+ */
1566
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
1567
+ /**
1568
+ * Prepaid expenses being charged for the room.
1569
+ */
1570
+ prepaid_expenses_amount: number | null;
1571
+ /**
1572
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
1573
+ * expenses.
1574
+ */
1575
+ prepaid_expenses_currency: string | null;
1576
+ /**
1577
+ * Number of nights the room was rented.
1578
+ */
1579
+ room_nights: number | null;
1580
+ /**
1581
+ * Total room tax being charged.
1582
+ */
1583
+ total_room_tax_amount: number | null;
1584
+ /**
1585
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
1586
+ * tax.
1587
+ */
1588
+ total_room_tax_currency: string | null;
1589
+ /**
1590
+ * Total tax being charged for the room.
1591
+ */
1592
+ total_tax_amount: number | null;
1593
+ /**
1594
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
1595
+ * assessed.
1596
+ */
1597
+ total_tax_currency: string | null;
1598
+ }
1599
+ /**
1600
+ * Fields specific to travel.
1601
+ */
1602
+ interface Travel {
1603
+ /**
1604
+ * Ancillary purchases in addition to the airfare.
1605
+ */
1606
+ ancillary: Travel.Ancillary | null;
1607
+ /**
1608
+ * Indicates the computerized reservation system used to book the ticket.
1609
+ */
1610
+ computerized_reservation_system: string | null;
1611
+ /**
1612
+ * Indicates the reason for a credit to the cardholder.
1613
+ *
1614
+ * - `no_credit` - No credit
1615
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1616
+ * ancillary purchase cancellation
1617
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1618
+ * Airline ticket and passenger transport ancillary purchase cancellation
1619
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
1620
+ * - `other` - Other
1621
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
1622
+ */
1623
+ credit_reason_indicator:
1624
+ | 'no_credit'
1625
+ | 'passenger_transport_ancillary_purchase_cancellation'
1626
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1627
+ | 'airline_ticket_cancellation'
1628
+ | 'other'
1629
+ | 'partial_refund_of_airline_ticket'
1630
+ | null;
1631
+ /**
1632
+ * Date of departure.
1633
+ */
1634
+ departure_date: string | null;
1635
+ /**
1636
+ * Code for the originating city or airport.
1637
+ */
1638
+ origination_city_airport_code: string | null;
1639
+ /**
1640
+ * Name of the passenger.
1641
+ */
1642
+ passenger_name: string | null;
1643
+ /**
1644
+ * Indicates whether this ticket is non-refundable.
1645
+ *
1646
+ * - `no_restrictions` - No restrictions
1647
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
1648
+ */
1649
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
1650
+ /**
1651
+ * Indicates why a ticket was changed.
1652
+ *
1653
+ * - `none` - None
1654
+ * - `change_to_existing_ticket` - Change to existing ticket
1655
+ * - `new_ticket` - New ticket
1656
+ */
1657
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
1658
+ /**
1659
+ * Ticket number.
1660
+ */
1661
+ ticket_number: string | null;
1662
+ /**
1663
+ * Code for the travel agency if the ticket was issued by a travel agency.
1664
+ */
1665
+ travel_agency_code: string | null;
1666
+ /**
1667
+ * Name of the travel agency if the ticket was issued by a travel agency.
1668
+ */
1669
+ travel_agency_name: string | null;
1670
+ /**
1671
+ * Fields specific to each leg of the journey.
1672
+ */
1673
+ trip_legs: Array<Travel.TripLeg> | null;
1674
+ }
1675
+ namespace Travel {
1676
+ /**
1677
+ * Ancillary purchases in addition to the airfare.
1678
+ */
1679
+ interface Ancillary {
1680
+ /**
1681
+ * If this purchase has a connection or relationship to another purchase, such as a
1682
+ * baggage fee for a passenger transport ticket, this field should contain the
1683
+ * ticket document number for the other purchase.
1684
+ */
1685
+ connected_ticket_document_number: string | null;
1686
+ /**
1687
+ * Indicates the reason for a credit to the cardholder.
1688
+ *
1689
+ * - `no_credit` - No credit
1690
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1691
+ * ancillary purchase cancellation
1692
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1693
+ * Airline ticket and passenger transport ancillary purchase cancellation
1694
+ * - `other` - Other
1695
+ */
1696
+ credit_reason_indicator:
1697
+ | 'no_credit'
1698
+ | 'passenger_transport_ancillary_purchase_cancellation'
1699
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1700
+ | 'other'
1701
+ | null;
1702
+ /**
1703
+ * Name of the passenger or description of the ancillary purchase.
1704
+ */
1705
+ passenger_name_or_description: string | null;
1706
+ /**
1707
+ * Additional travel charges, such as baggage fees.
1708
+ */
1709
+ services: Array<Ancillary.Service>;
1710
+ /**
1711
+ * Ticket document number.
1712
+ */
1713
+ ticket_document_number: string | null;
1714
+ }
1715
+ namespace Ancillary {
1716
+ interface Service {
1717
+ /**
1718
+ * Category of the ancillary service.
1719
+ *
1720
+ * - `none` - None
1721
+ * - `bundled_service` - Bundled service
1722
+ * - `baggage_fee` - Baggage fee
1723
+ * - `change_fee` - Change fee
1724
+ * - `cargo` - Cargo
1725
+ * - `carbon_offset` - Carbon offset
1726
+ * - `frequent_flyer` - Frequent flyer
1727
+ * - `gift_card` - Gift card
1728
+ * - `ground_transport` - Ground transport
1729
+ * - `in_flight_entertainment` - In-flight entertainment
1730
+ * - `lounge` - Lounge
1731
+ * - `medical` - Medical
1732
+ * - `meal_beverage` - Meal beverage
1733
+ * - `other` - Other
1734
+ * - `passenger_assist_fee` - Passenger assist fee
1735
+ * - `pets` - Pets
1736
+ * - `seat_fees` - Seat fees
1737
+ * - `standby` - Standby
1738
+ * - `service_fee` - Service fee
1739
+ * - `store` - Store
1740
+ * - `travel_service` - Travel service
1741
+ * - `unaccompanied_travel` - Unaccompanied travel
1742
+ * - `upgrades` - Upgrades
1743
+ * - `wifi` - Wi-fi
1744
+ */
1745
+ category:
1746
+ | 'none'
1747
+ | 'bundled_service'
1748
+ | 'baggage_fee'
1749
+ | 'change_fee'
1750
+ | 'cargo'
1751
+ | 'carbon_offset'
1752
+ | 'frequent_flyer'
1753
+ | 'gift_card'
1754
+ | 'ground_transport'
1755
+ | 'in_flight_entertainment'
1756
+ | 'lounge'
1757
+ | 'medical'
1758
+ | 'meal_beverage'
1759
+ | 'other'
1760
+ | 'passenger_assist_fee'
1761
+ | 'pets'
1762
+ | 'seat_fees'
1763
+ | 'standby'
1764
+ | 'service_fee'
1765
+ | 'store'
1766
+ | 'travel_service'
1767
+ | 'unaccompanied_travel'
1768
+ | 'upgrades'
1769
+ | 'wifi'
1770
+ | null;
1771
+ /**
1772
+ * Sub-category of the ancillary service, free-form.
1773
+ */
1774
+ sub_category: string | null;
1775
+ }
1776
+ }
1777
+ interface TripLeg {
1778
+ /**
1779
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
1780
+ */
1781
+ carrier_code: string | null;
1782
+ /**
1783
+ * Code for the destination city or airport.
1784
+ */
1785
+ destination_city_airport_code: string | null;
1786
+ /**
1787
+ * Fare basis code.
1788
+ */
1789
+ fare_basis_code: string | null;
1790
+ /**
1791
+ * Flight number.
1792
+ */
1793
+ flight_number: string | null;
1794
+ /**
1795
+ * Service class (e.g., first class, business class, etc.).
1796
+ */
1797
+ service_class: string | null;
1798
+ /**
1799
+ * Indicates whether a stopover is allowed on this ticket.
1800
+ *
1801
+ * - `none` - None
1802
+ * - `stop_over_allowed` - Stop over allowed
1803
+ * - `stop_over_not_allowed` - Stop over not allowed
1804
+ */
1805
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
1806
+ }
1807
+ }
1808
+ }
1809
+ }
1365
1810
  /**
1366
1811
  * A Card Revenue Payment object. This field will be present in the JSON response
1367
1812
  * if and only if `category` is equal to `card_revenue_payment`.
@@ -1466,6 +1911,11 @@ export declare namespace ACHTransferSimulation {
1466
1911
  * transaction's presentment currency.
1467
1912
  */
1468
1913
  presentment_currency: string;
1914
+ /**
1915
+ * Additional details about the card purchase, such as tax and industry-specific
1916
+ * fields.
1917
+ */
1918
+ purchase_details: CardSettlement.PurchaseDetails | null;
1469
1919
  /**
1470
1920
  * The identifier of the Transaction associated with this Transaction.
1471
1921
  */
@@ -1476,6 +1926,468 @@ export declare namespace ACHTransferSimulation {
1476
1926
  */
1477
1927
  type: 'card_settlement';
1478
1928
  }
1929
+ namespace CardSettlement {
1930
+ /**
1931
+ * Additional details about the card purchase, such as tax and industry-specific
1932
+ * fields.
1933
+ */
1934
+ interface PurchaseDetails {
1935
+ /**
1936
+ * Fields specific to car rentals.
1937
+ */
1938
+ car_rental: PurchaseDetails.CarRental | null;
1939
+ /**
1940
+ * An identifier from the merchant for the customer or consumer.
1941
+ */
1942
+ customer_reference_identifier: string | null;
1943
+ /**
1944
+ * The state or provincial tax amount in minor units.
1945
+ */
1946
+ local_tax_amount: number | null;
1947
+ /**
1948
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1949
+ * assessed.
1950
+ */
1951
+ local_tax_currency: string | null;
1952
+ /**
1953
+ * Fields specific to lodging.
1954
+ */
1955
+ lodging: PurchaseDetails.Lodging | null;
1956
+ /**
1957
+ * The national tax amount in minor units.
1958
+ */
1959
+ national_tax_amount: number | null;
1960
+ /**
1961
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1962
+ * assessed.
1963
+ */
1964
+ national_tax_currency: string | null;
1965
+ /**
1966
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
1967
+ */
1968
+ purchase_identifier: string | null;
1969
+ /**
1970
+ * The format of the purchase identifier.
1971
+ *
1972
+ * - `free_text` - Free text
1973
+ * - `order_number` - Order number
1974
+ * - `rental_agreement_number` - Rental agreement number
1975
+ * - `hotel_folio_number` - Hotel folio number
1976
+ * - `invoice_number` - Invoice number
1977
+ */
1978
+ purchase_identifier_format:
1979
+ | 'free_text'
1980
+ | 'order_number'
1981
+ | 'rental_agreement_number'
1982
+ | 'hotel_folio_number'
1983
+ | 'invoice_number'
1984
+ | null;
1985
+ /**
1986
+ * Fields specific to travel.
1987
+ */
1988
+ travel: PurchaseDetails.Travel | null;
1989
+ }
1990
+ namespace PurchaseDetails {
1991
+ /**
1992
+ * Fields specific to car rentals.
1993
+ */
1994
+ interface CarRental {
1995
+ /**
1996
+ * Code indicating the vehicle's class.
1997
+ */
1998
+ car_class_code: string | null;
1999
+ /**
2000
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
2001
+ * transaction, the scheduled pick up date.
2002
+ */
2003
+ checkout_date: string | null;
2004
+ /**
2005
+ * Daily rate being charged for the vehicle.
2006
+ */
2007
+ daily_rental_rate_amount: number | null;
2008
+ /**
2009
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
2010
+ * rate.
2011
+ */
2012
+ daily_rental_rate_currency: string | null;
2013
+ /**
2014
+ * Number of days the vehicle was rented.
2015
+ */
2016
+ days_rented: number | null;
2017
+ /**
2018
+ * Additional charges (gas, late fee, etc.) being billed.
2019
+ *
2020
+ * - `no_extra_charge` - No extra charge
2021
+ * - `gas` - Gas
2022
+ * - `extra_mileage` - Extra mileage
2023
+ * - `late_return` - Late return
2024
+ * - `one_way_service_fee` - One way service fee
2025
+ * - `parking_violation` - Parking violation
2026
+ */
2027
+ extra_charges:
2028
+ | 'no_extra_charge'
2029
+ | 'gas'
2030
+ | 'extra_mileage'
2031
+ | 'late_return'
2032
+ | 'one_way_service_fee'
2033
+ | 'parking_violation'
2034
+ | null;
2035
+ /**
2036
+ * Fuel charges for the vehicle.
2037
+ */
2038
+ fuel_charges_amount: number | null;
2039
+ /**
2040
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
2041
+ * assessed.
2042
+ */
2043
+ fuel_charges_currency: string | null;
2044
+ /**
2045
+ * Any insurance being charged for the vehicle.
2046
+ */
2047
+ insurance_charges_amount: number | null;
2048
+ /**
2049
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
2050
+ * charges assessed.
2051
+ */
2052
+ insurance_charges_currency: string | null;
2053
+ /**
2054
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
2055
+ * not actually rented (that is, a "no-show" charge).
2056
+ *
2057
+ * - `not_applicable` - Not applicable
2058
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
2059
+ */
2060
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
2061
+ /**
2062
+ * Charges for returning the vehicle at a different location than where it was
2063
+ * picked up.
2064
+ */
2065
+ one_way_drop_off_charges_amount: number | null;
2066
+ /**
2067
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
2068
+ * drop-off charges assessed.
2069
+ */
2070
+ one_way_drop_off_charges_currency: string | null;
2071
+ /**
2072
+ * Name of the person renting the vehicle.
2073
+ */
2074
+ renter_name: string | null;
2075
+ /**
2076
+ * Weekly rate being charged for the vehicle.
2077
+ */
2078
+ weekly_rental_rate_amount: number | null;
2079
+ /**
2080
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
2081
+ * rental rate.
2082
+ */
2083
+ weekly_rental_rate_currency: string | null;
2084
+ }
2085
+ /**
2086
+ * Fields specific to lodging.
2087
+ */
2088
+ interface Lodging {
2089
+ /**
2090
+ * Date the customer checked in.
2091
+ */
2092
+ check_in_date: string | null;
2093
+ /**
2094
+ * Daily rate being charged for the room.
2095
+ */
2096
+ daily_room_rate_amount: number | null;
2097
+ /**
2098
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
2099
+ * rate.
2100
+ */
2101
+ daily_room_rate_currency: string | null;
2102
+ /**
2103
+ * Additional charges (phone, late check-out, etc.) being billed.
2104
+ *
2105
+ * - `no_extra_charge` - No extra charge
2106
+ * - `restaurant` - Restaurant
2107
+ * - `gift_shop` - Gift shop
2108
+ * - `mini_bar` - Mini bar
2109
+ * - `telephone` - Telephone
2110
+ * - `other` - Other
2111
+ * - `laundry` - Laundry
2112
+ */
2113
+ extra_charges:
2114
+ | 'no_extra_charge'
2115
+ | 'restaurant'
2116
+ | 'gift_shop'
2117
+ | 'mini_bar'
2118
+ | 'telephone'
2119
+ | 'other'
2120
+ | 'laundry'
2121
+ | null;
2122
+ /**
2123
+ * Folio cash advances for the room.
2124
+ */
2125
+ folio_cash_advances_amount: number | null;
2126
+ /**
2127
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
2128
+ * advances.
2129
+ */
2130
+ folio_cash_advances_currency: string | null;
2131
+ /**
2132
+ * Food and beverage charges for the room.
2133
+ */
2134
+ food_beverage_charges_amount: number | null;
2135
+ /**
2136
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
2137
+ * beverage charges.
2138
+ */
2139
+ food_beverage_charges_currency: string | null;
2140
+ /**
2141
+ * Indicator that the cardholder is being billed for a reserved room that was not
2142
+ * actually used.
2143
+ *
2144
+ * - `not_applicable` - Not applicable
2145
+ * - `no_show` - No show
2146
+ */
2147
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
2148
+ /**
2149
+ * Prepaid expenses being charged for the room.
2150
+ */
2151
+ prepaid_expenses_amount: number | null;
2152
+ /**
2153
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
2154
+ * expenses.
2155
+ */
2156
+ prepaid_expenses_currency: string | null;
2157
+ /**
2158
+ * Number of nights the room was rented.
2159
+ */
2160
+ room_nights: number | null;
2161
+ /**
2162
+ * Total room tax being charged.
2163
+ */
2164
+ total_room_tax_amount: number | null;
2165
+ /**
2166
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
2167
+ * tax.
2168
+ */
2169
+ total_room_tax_currency: string | null;
2170
+ /**
2171
+ * Total tax being charged for the room.
2172
+ */
2173
+ total_tax_amount: number | null;
2174
+ /**
2175
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
2176
+ * assessed.
2177
+ */
2178
+ total_tax_currency: string | null;
2179
+ }
2180
+ /**
2181
+ * Fields specific to travel.
2182
+ */
2183
+ interface Travel {
2184
+ /**
2185
+ * Ancillary purchases in addition to the airfare.
2186
+ */
2187
+ ancillary: Travel.Ancillary | null;
2188
+ /**
2189
+ * Indicates the computerized reservation system used to book the ticket.
2190
+ */
2191
+ computerized_reservation_system: string | null;
2192
+ /**
2193
+ * Indicates the reason for a credit to the cardholder.
2194
+ *
2195
+ * - `no_credit` - No credit
2196
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
2197
+ * ancillary purchase cancellation
2198
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
2199
+ * Airline ticket and passenger transport ancillary purchase cancellation
2200
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
2201
+ * - `other` - Other
2202
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
2203
+ */
2204
+ credit_reason_indicator:
2205
+ | 'no_credit'
2206
+ | 'passenger_transport_ancillary_purchase_cancellation'
2207
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
2208
+ | 'airline_ticket_cancellation'
2209
+ | 'other'
2210
+ | 'partial_refund_of_airline_ticket'
2211
+ | null;
2212
+ /**
2213
+ * Date of departure.
2214
+ */
2215
+ departure_date: string | null;
2216
+ /**
2217
+ * Code for the originating city or airport.
2218
+ */
2219
+ origination_city_airport_code: string | null;
2220
+ /**
2221
+ * Name of the passenger.
2222
+ */
2223
+ passenger_name: string | null;
2224
+ /**
2225
+ * Indicates whether this ticket is non-refundable.
2226
+ *
2227
+ * - `no_restrictions` - No restrictions
2228
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
2229
+ */
2230
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
2231
+ /**
2232
+ * Indicates why a ticket was changed.
2233
+ *
2234
+ * - `none` - None
2235
+ * - `change_to_existing_ticket` - Change to existing ticket
2236
+ * - `new_ticket` - New ticket
2237
+ */
2238
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
2239
+ /**
2240
+ * Ticket number.
2241
+ */
2242
+ ticket_number: string | null;
2243
+ /**
2244
+ * Code for the travel agency if the ticket was issued by a travel agency.
2245
+ */
2246
+ travel_agency_code: string | null;
2247
+ /**
2248
+ * Name of the travel agency if the ticket was issued by a travel agency.
2249
+ */
2250
+ travel_agency_name: string | null;
2251
+ /**
2252
+ * Fields specific to each leg of the journey.
2253
+ */
2254
+ trip_legs: Array<Travel.TripLeg> | null;
2255
+ }
2256
+ namespace Travel {
2257
+ /**
2258
+ * Ancillary purchases in addition to the airfare.
2259
+ */
2260
+ interface Ancillary {
2261
+ /**
2262
+ * If this purchase has a connection or relationship to another purchase, such as a
2263
+ * baggage fee for a passenger transport ticket, this field should contain the
2264
+ * ticket document number for the other purchase.
2265
+ */
2266
+ connected_ticket_document_number: string | null;
2267
+ /**
2268
+ * Indicates the reason for a credit to the cardholder.
2269
+ *
2270
+ * - `no_credit` - No credit
2271
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
2272
+ * ancillary purchase cancellation
2273
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
2274
+ * Airline ticket and passenger transport ancillary purchase cancellation
2275
+ * - `other` - Other
2276
+ */
2277
+ credit_reason_indicator:
2278
+ | 'no_credit'
2279
+ | 'passenger_transport_ancillary_purchase_cancellation'
2280
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
2281
+ | 'other'
2282
+ | null;
2283
+ /**
2284
+ * Name of the passenger or description of the ancillary purchase.
2285
+ */
2286
+ passenger_name_or_description: string | null;
2287
+ /**
2288
+ * Additional travel charges, such as baggage fees.
2289
+ */
2290
+ services: Array<Ancillary.Service>;
2291
+ /**
2292
+ * Ticket document number.
2293
+ */
2294
+ ticket_document_number: string | null;
2295
+ }
2296
+ namespace Ancillary {
2297
+ interface Service {
2298
+ /**
2299
+ * Category of the ancillary service.
2300
+ *
2301
+ * - `none` - None
2302
+ * - `bundled_service` - Bundled service
2303
+ * - `baggage_fee` - Baggage fee
2304
+ * - `change_fee` - Change fee
2305
+ * - `cargo` - Cargo
2306
+ * - `carbon_offset` - Carbon offset
2307
+ * - `frequent_flyer` - Frequent flyer
2308
+ * - `gift_card` - Gift card
2309
+ * - `ground_transport` - Ground transport
2310
+ * - `in_flight_entertainment` - In-flight entertainment
2311
+ * - `lounge` - Lounge
2312
+ * - `medical` - Medical
2313
+ * - `meal_beverage` - Meal beverage
2314
+ * - `other` - Other
2315
+ * - `passenger_assist_fee` - Passenger assist fee
2316
+ * - `pets` - Pets
2317
+ * - `seat_fees` - Seat fees
2318
+ * - `standby` - Standby
2319
+ * - `service_fee` - Service fee
2320
+ * - `store` - Store
2321
+ * - `travel_service` - Travel service
2322
+ * - `unaccompanied_travel` - Unaccompanied travel
2323
+ * - `upgrades` - Upgrades
2324
+ * - `wifi` - Wi-fi
2325
+ */
2326
+ category:
2327
+ | 'none'
2328
+ | 'bundled_service'
2329
+ | 'baggage_fee'
2330
+ | 'change_fee'
2331
+ | 'cargo'
2332
+ | 'carbon_offset'
2333
+ | 'frequent_flyer'
2334
+ | 'gift_card'
2335
+ | 'ground_transport'
2336
+ | 'in_flight_entertainment'
2337
+ | 'lounge'
2338
+ | 'medical'
2339
+ | 'meal_beverage'
2340
+ | 'other'
2341
+ | 'passenger_assist_fee'
2342
+ | 'pets'
2343
+ | 'seat_fees'
2344
+ | 'standby'
2345
+ | 'service_fee'
2346
+ | 'store'
2347
+ | 'travel_service'
2348
+ | 'unaccompanied_travel'
2349
+ | 'upgrades'
2350
+ | 'wifi'
2351
+ | null;
2352
+ /**
2353
+ * Sub-category of the ancillary service, free-form.
2354
+ */
2355
+ sub_category: string | null;
2356
+ }
2357
+ }
2358
+ interface TripLeg {
2359
+ /**
2360
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
2361
+ */
2362
+ carrier_code: string | null;
2363
+ /**
2364
+ * Code for the destination city or airport.
2365
+ */
2366
+ destination_city_airport_code: string | null;
2367
+ /**
2368
+ * Fare basis code.
2369
+ */
2370
+ fare_basis_code: string | null;
2371
+ /**
2372
+ * Flight number.
2373
+ */
2374
+ flight_number: string | null;
2375
+ /**
2376
+ * Service class (e.g., first class, business class, etc.).
2377
+ */
2378
+ service_class: string | null;
2379
+ /**
2380
+ * Indicates whether a stopover is allowed on this ticket.
2381
+ *
2382
+ * - `none` - None
2383
+ * - `stop_over_allowed` - Stop over allowed
2384
+ * - `stop_over_not_allowed` - Stop over not allowed
2385
+ */
2386
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
2387
+ }
2388
+ }
2389
+ }
2390
+ }
1479
2391
  /**
1480
2392
  * A Check Deposit Acceptance object. This field will be present in the JSON
1481
2393
  * response if and only if `category` is equal to `check_deposit_acceptance`.
@@ -1664,16 +2576,6 @@ export declare namespace ACHTransferSimulation {
1664
2576
  */
1665
2577
  transfer_id: string;
1666
2578
  }
1667
- /**
1668
- * A Check Transfer Rejection object. This field will be present in the JSON
1669
- * response if and only if `category` is equal to `check_transfer_rejection`.
1670
- */
1671
- interface CheckTransferRejection {
1672
- /**
1673
- * The identifier of the Check Transfer that led to this Transaction.
1674
- */
1675
- transfer_id: string;
1676
- }
1677
2579
  /**
1678
2580
  * A Check Transfer Stop Payment Request object. This field will be present in the
1679
2581
  * JSON response if and only if `category` is equal to
@@ -1684,9 +2586,11 @@ export declare namespace ACHTransferSimulation {
1684
2586
  * The reason why this transfer was stopped.
1685
2587
  *
1686
2588
  * - `mail_delivery_failed` - The check could not be delivered.
2589
+ * - `rejected_by_increase` - The check was cancelled by an Increase operator who
2590
+ * will provide details out-of-band.
1687
2591
  * - `unknown` - The check was stopped for another reason.
1688
2592
  */
1689
- reason: 'mail_delivery_failed' | 'unknown';
2593
+ reason: 'mail_delivery_failed' | 'rejected_by_increase' | 'unknown';
1690
2594
  /**
1691
2595
  * The time the stop-payment was requested.
1692
2596
  */
@@ -1729,8 +2633,8 @@ export declare namespace ACHTransferSimulation {
1729
2633
  fee_period_start: string;
1730
2634
  }
1731
2635
  /**
1732
- * A Inbound ACH Transfer object. This field will be present in the JSON response
1733
- * if and only if `category` is equal to `inbound_ach_transfer`.
2636
+ * An Inbound ACH Transfer Intention object. This field will be present in the JSON
2637
+ * response if and only if `category` is equal to `inbound_ach_transfer`.
1734
2638
  */
1735
2639
  interface InboundACHTransfer {
1736
2640
  /**
@@ -1748,7 +2652,7 @@ export declare namespace ACHTransferSimulation {
1748
2652
  trace_number: string;
1749
2653
  }
1750
2654
  /**
1751
- * A Inbound Check object. This field will be present in the JSON response if and
2655
+ * An Inbound Check object. This field will be present in the JSON response if and
1752
2656
  * only if `category` is equal to `inbound_check`.
1753
2657
  */
1754
2658
  interface InboundCheck {
@@ -1774,7 +2678,7 @@ export declare namespace ACHTransferSimulation {
1774
2678
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1775
2679
  }
1776
2680
  /**
1777
- * A Inbound International ACH Transfer object. This field will be present in the
2681
+ * An Inbound International ACH Transfer object. This field will be present in the
1778
2682
  * JSON response if and only if `category` is equal to
1779
2683
  * `inbound_international_ach_transfer`.
1780
2684
  */
@@ -1821,7 +2725,7 @@ export declare namespace ACHTransferSimulation {
1821
2725
  trace_number: string;
1822
2726
  }
1823
2727
  /**
1824
- * A Inbound Real Time Payments Transfer Confirmation object. This field will be
2728
+ * An Inbound Real Time Payments Transfer Confirmation object. This field will be
1825
2729
  * present in the JSON response if and only if `category` is equal to
1826
2730
  * `inbound_real_time_payments_transfer_confirmation`.
1827
2731
  */
@@ -1869,7 +2773,7 @@ export declare namespace ACHTransferSimulation {
1869
2773
  transaction_identification: string;
1870
2774
  }
1871
2775
  /**
1872
- * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
2776
+ * An Inbound Wire Drawdown Payment object. This field will be present in the JSON
1873
2777
  * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
1874
2778
  */
1875
2779
  interface InboundWireDrawdownPayment {
@@ -1892,7 +2796,7 @@ export declare namespace ACHTransferSimulation {
1892
2796
  originator_to_beneficiary_information: string | null;
1893
2797
  }
1894
2798
  /**
1895
- * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
2799
+ * An Inbound Wire Drawdown Payment Reversal object. This field will be present in
1896
2800
  * the JSON response if and only if `category` is equal to
1897
2801
  * `inbound_wire_drawdown_payment_reversal`.
1898
2802
  */
@@ -1939,7 +2843,7 @@ export declare namespace ACHTransferSimulation {
1939
2843
  previous_message_input_source: string;
1940
2844
  }
1941
2845
  /**
1942
- * A Inbound Wire Reversal object. This field will be present in the JSON response
2846
+ * An Inbound Wire Reversal object. This field will be present in the JSON response
1943
2847
  * if and only if `category` is equal to `inbound_wire_reversal`.
1944
2848
  */
1945
2849
  interface InboundWireReversal {
@@ -2007,7 +2911,7 @@ export declare namespace ACHTransferSimulation {
2007
2911
  wire_transfer_id: string;
2008
2912
  }
2009
2913
  /**
2010
- * A Inbound Wire Transfer object. This field will be present in the JSON response
2914
+ * An Inbound Wire Transfer object. This field will be present in the JSON response
2011
2915
  * if and only if `category` is equal to `inbound_wire_transfer`.
2012
2916
  */
2013
2917
  interface InboundWireTransfer {
@@ -2034,7 +2938,7 @@ export declare namespace ACHTransferSimulation {
2034
2938
  originator_to_beneficiary_information_line4: string | null;
2035
2939
  }
2036
2940
  /**
2037
- * A Interest Payment object. This field will be present in the JSON response if
2941
+ * An Interest Payment object. This field will be present in the JSON response if
2038
2942
  * and only if `category` is equal to `interest_payment`.
2039
2943
  */
2040
2944
  interface InterestPayment {
@@ -2069,8 +2973,8 @@ export declare namespace ACHTransferSimulation {
2069
2973
  period_start: string;
2070
2974
  }
2071
2975
  /**
2072
- * A Internal Source object. This field will be present in the JSON response if and
2073
- * only if `category` is equal to `internal_source`.
2976
+ * An Internal Source object. This field will be present in the JSON response if
2977
+ * and only if `category` is equal to `internal_source`.
2074
2978
  */
2075
2979
  interface InternalSource {
2076
2980
  /**
@@ -2094,6 +2998,7 @@ export declare namespace ACHTransferSimulation {
2094
2998
  * - `account_closure` - Account closure
2095
2999
  * - `bank_migration` - Bank migration
2096
3000
  * - `cashback` - Cashback
3001
+ * - `check_adjustment` - Check adjustment
2097
3002
  * - `collection_receivable` - Collection receivable
2098
3003
  * - `empyreal_adjustment` - Empyreal adjustment
2099
3004
  * - `error` - Error
@@ -2108,6 +3013,7 @@ export declare namespace ACHTransferSimulation {
2108
3013
  | 'account_closure'
2109
3014
  | 'bank_migration'
2110
3015
  | 'cashback'
3016
+ | 'check_adjustment'
2111
3017
  | 'collection_receivable'
2112
3018
  | 'empyreal_adjustment'
2113
3019
  | 'error'