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
@@ -4,7 +4,7 @@ import * as Core from '../../core';
4
4
  import { APIResource } from '../../resource';
5
5
  import * as ACHTransfers_ from '../ach-transfers';
6
6
  import * as Shared from '../shared';
7
- import * as API from '.';
7
+ import * as API from './index';
8
8
 
9
9
  export class ACHTransfers extends APIResource {
10
10
  /**
@@ -18,7 +18,7 @@ export class ACHTransfers extends APIResource {
18
18
  createInbound(
19
19
  body: ACHTransferCreateInboundParams,
20
20
  options?: Core.RequestOptions,
21
- ): Promise<Core.APIResponse<ACHTransferSimulation>> {
21
+ ): Core.APIPromise<ACHTransferSimulation> {
22
22
  return this.post('/simulations/inbound_ach_transfers', { body, ...options });
23
23
  }
24
24
 
@@ -31,7 +31,7 @@ export class ACHTransfers extends APIResource {
31
31
  achTransferId: string,
32
32
  body: ACHTransferReturnParams,
33
33
  options?: Core.RequestOptions,
34
- ): Promise<Core.APIResponse<ACHTransfers_.ACHTransfer>> {
34
+ ): Core.APIPromise<ACHTransfers_.ACHTransfer> {
35
35
  return this.post(`/simulations/ach_transfers/${achTransferId}/return`, { body, ...options });
36
36
  }
37
37
 
@@ -43,10 +43,7 @@ export class ACHTransfers extends APIResource {
43
43
  * not submitted to the Federal Reserve, this endpoint allows you to skip that
44
44
  * delay and transition the ACH Transfer to a status of `submitted`.
45
45
  */
46
- submit(
47
- achTransferId: string,
48
- options?: Core.RequestOptions,
49
- ): Promise<Core.APIResponse<ACHTransfers_.ACHTransfer>> {
46
+ submit(achTransferId: string, options?: Core.RequestOptions): Core.APIPromise<ACHTransfers_.ACHTransfer> {
50
47
  return this.post(`/simulations/ach_transfers/${achTransferId}/submit`, options);
51
48
  }
52
49
  }
@@ -164,7 +161,7 @@ export namespace ACHTransferSimulation {
164
161
  */
165
162
  export interface Source {
166
163
  /**
167
- * A ACH Decline object. This field will be present in the JSON response if and
164
+ * An ACH Decline object. This field will be present in the JSON response if and
168
165
  * only if `category` is equal to `ach_decline`.
169
166
  */
170
167
  ach_decline: Source.ACHDecline | null;
@@ -176,24 +173,21 @@ export namespace ACHTransferSimulation {
176
173
  card_decline: Source.CardDecline | null;
177
174
 
178
175
  /**
179
- * The type of decline that took place. We may add additional possible values for
180
- * this enum over time; your application should be able to handle such additions
181
- * gracefully.
176
+ * The type of the resource. We may add additional possible values for this enum
177
+ * over time; your application should be able to handle such additions gracefully.
182
178
  *
183
- * - `ach_decline` - The Declined Transaction was created by a ACH Decline object.
184
- * Details will be under the `ach_decline` object.
185
- * - `card_decline` - The Declined Transaction was created by a Card Decline
186
- * object. Details will be under the `card_decline` object.
187
- * - `check_decline` - The Declined Transaction was created by a Check Decline
188
- * object. Details will be under the `check_decline` object.
189
- * - `inbound_real_time_payments_transfer_decline` - The Declined Transaction was
190
- * created by a Inbound Real Time Payments Transfer Decline object. Details will
191
- * be under the `inbound_real_time_payments_transfer_decline` object.
192
- * - `international_ach_decline` - The Declined Transaction was created by a
193
- * International ACH Decline object. Details will be under the
194
- * `international_ach_decline` object.
195
- * - `wire_decline` - The Declined Transaction was created by a Wire Decline
196
- * object. Details will be under the `wire_decline` object.
179
+ * - `ach_decline` - ACH Decline: details will be under the `ach_decline` object.
180
+ * - `card_decline` - Card Decline: details will be under the `card_decline`
181
+ * object.
182
+ * - `check_decline` - Check Decline: details will be under the `check_decline`
183
+ * object.
184
+ * - `inbound_real_time_payments_transfer_decline` - Inbound Real Time Payments
185
+ * Transfer Decline: details will be under the
186
+ * `inbound_real_time_payments_transfer_decline` object.
187
+ * - `international_ach_decline` - International ACH Decline: details will be under
188
+ * the `international_ach_decline` object.
189
+ * - `wire_decline` - Wire Decline: details will be under the `wire_decline`
190
+ * object.
197
191
  * - `other` - The Declined Transaction was made for an undocumented or deprecated
198
192
  * reason.
199
193
  */
@@ -213,14 +207,14 @@ export namespace ACHTransferSimulation {
213
207
  check_decline: Source.CheckDecline | null;
214
208
 
215
209
  /**
216
- * A Inbound Real Time Payments Transfer Decline object. This field will be present
217
- * in the JSON response if and only if `category` is equal to
210
+ * An Inbound Real Time Payments Transfer Decline object. This field will be
211
+ * present in the JSON response if and only if `category` is equal to
218
212
  * `inbound_real_time_payments_transfer_decline`.
219
213
  */
220
214
  inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
221
215
 
222
216
  /**
223
- * A International ACH Decline object. This field will be present in the JSON
217
+ * An International ACH Decline object. This field will be present in the JSON
224
218
  * response if and only if `category` is equal to `international_ach_decline`.
225
219
  */
226
220
  international_ach_decline: Source.InternationalACHDecline | null;
@@ -234,7 +228,7 @@ export namespace ACHTransferSimulation {
234
228
 
235
229
  export namespace Source {
236
230
  /**
237
- * A ACH Decline object. This field will be present in the JSON response if and
231
+ * An ACH Decline object. This field will be present in the JSON response if and
238
232
  * only if `category` is equal to `ach_decline`.
239
233
  */
240
234
  export interface ACHDecline {
@@ -539,8 +533,8 @@ export namespace ACHTransferSimulation {
539
533
  }
540
534
 
541
535
  /**
542
- * A Inbound Real Time Payments Transfer Decline object. This field will be present
543
- * in the JSON response if and only if `category` is equal to
536
+ * An Inbound Real Time Payments Transfer Decline object. This field will be
537
+ * present in the JSON response if and only if `category` is equal to
544
538
  * `inbound_real_time_payments_transfer_decline`.
545
539
  */
546
540
  export interface InboundRealTimePaymentsTransferDecline {
@@ -615,7 +609,7 @@ export namespace ACHTransferSimulation {
615
609
  }
616
610
 
617
611
  /**
618
- * A International ACH Decline object. This field will be present in the JSON
612
+ * An International ACH Decline object. This field will be present in the JSON
619
613
  * response if and only if `category` is equal to `international_ach_decline`.
620
614
  */
621
615
  export interface InternationalACHDecline {
@@ -846,26 +840,26 @@ export namespace ACHTransferSimulation {
846
840
  */
847
841
  export interface Source {
848
842
  /**
849
- * A Account Transfer Intention object. This field will be present in the JSON
843
+ * An Account Transfer Intention object. This field will be present in the JSON
850
844
  * response if and only if `category` is equal to `account_transfer_intention`.
851
845
  */
852
846
  account_transfer_intention: Source.AccountTransferIntention | null;
853
847
 
854
848
  /**
855
- * A ACH Transfer Intention object. This field will be present in the JSON response
856
- * if and only if `category` is equal to `ach_transfer_intention`.
849
+ * An ACH Transfer Intention object. This field will be present in the JSON
850
+ * response if and only if `category` is equal to `ach_transfer_intention`.
857
851
  */
858
852
  ach_transfer_intention: Source.ACHTransferIntention | null;
859
853
 
860
854
  /**
861
- * A ACH Transfer Rejection object. This field will be present in the JSON response
862
- * if and only if `category` is equal to `ach_transfer_rejection`.
855
+ * An ACH Transfer Rejection object. This field will be present in the JSON
856
+ * response if and only if `category` is equal to `ach_transfer_rejection`.
863
857
  */
864
858
  ach_transfer_rejection: Source.ACHTransferRejection | null;
865
859
 
866
860
  /**
867
- * A ACH Transfer Return object. This field will be present in the JSON response if
868
- * and only if `category` is equal to `ach_transfer_return`.
861
+ * An ACH Transfer Return object. This field will be present in the JSON response
862
+ * if and only if `category` is equal to `ach_transfer_return`.
869
863
  */
870
864
  ach_transfer_return: Source.ACHTransferReturn | null;
871
865
 
@@ -894,79 +888,69 @@ export namespace ACHTransferSimulation {
894
888
  card_settlement: Source.CardSettlement | null;
895
889
 
896
890
  /**
897
- * The type of transaction that took place. We may add additional possible values
898
- * for this enum over time; your application should be able to handle such
899
- * additions gracefully.
891
+ * The type of the resource. We may add additional possible values for this enum
892
+ * over time; your application should be able to handle such additions gracefully.
900
893
  *
901
- * - `account_transfer_intention` - The Transaction was created by a Account
902
- * Transfer Intention object. Details will be under the
903
- * `account_transfer_intention` object.
904
- * - `ach_transfer_intention` - The Transaction was created by a ACH Transfer
905
- * Intention object. Details will be under the `ach_transfer_intention` object.
906
- * - `ach_transfer_rejection` - The Transaction was created by a ACH Transfer
907
- * Rejection object. Details will be under the `ach_transfer_rejection` object.
908
- * - `ach_transfer_return` - The Transaction was created by a ACH Transfer Return
909
- * object. Details will be under the `ach_transfer_return` object.
910
- * - `card_dispute_acceptance` - The Transaction was created by a Card Dispute
911
- * Acceptance object. Details will be under the `card_dispute_acceptance` object.
912
- * - `card_refund` - The Transaction was created by a Card Refund object. Details
913
- * will be under the `card_refund` object.
914
- * - `card_revenue_payment` - The Transaction was created by a Card Revenue Payment
915
- * object. Details will be under the `card_revenue_payment` object.
916
- * - `card_settlement` - The Transaction was created by a Card Settlement object.
917
- * Details will be under the `card_settlement` object.
918
- * - `check_deposit_acceptance` - The Transaction was created by a Check Deposit
919
- * Acceptance object. Details will be under the `check_deposit_acceptance`
894
+ * - `account_transfer_intention` - Account Transfer Intention: details will be
895
+ * under the `account_transfer_intention` object.
896
+ * - `ach_transfer_intention` - ACH Transfer Intention: details will be under the
897
+ * `ach_transfer_intention` object.
898
+ * - `ach_transfer_rejection` - ACH Transfer Rejection: details will be under the
899
+ * `ach_transfer_rejection` object.
900
+ * - `ach_transfer_return` - ACH Transfer Return: details will be under the
901
+ * `ach_transfer_return` object.
902
+ * - `card_dispute_acceptance` - Card Dispute Acceptance: details will be under the
903
+ * `card_dispute_acceptance` object.
904
+ * - `card_refund` - Card Refund: details will be under the `card_refund` object.
905
+ * - `card_revenue_payment` - Card Revenue Payment: details will be under the
906
+ * `card_revenue_payment` object.
907
+ * - `card_settlement` - Card Settlement: details will be under the
908
+ * `card_settlement` object.
909
+ * - `check_deposit_acceptance` - Check Deposit Acceptance: details will be under
910
+ * the `check_deposit_acceptance` object.
911
+ * - `check_deposit_return` - Check Deposit Return: details will be under the
912
+ * `check_deposit_return` object.
913
+ * - `check_transfer_deposit` - Check Transfer Deposit: details will be under the
914
+ * `check_transfer_deposit` object.
915
+ * - `check_transfer_intention` - Check Transfer Intention: details will be under
916
+ * the `check_transfer_intention` object.
917
+ * - `check_transfer_stop_payment_request` - Check Transfer Stop Payment Request:
918
+ * details will be under the `check_transfer_stop_payment_request` object.
919
+ * - `fee_payment` - Fee Payment: details will be under the `fee_payment` object.
920
+ * - `inbound_ach_transfer` - Inbound ACH Transfer Intention: details will be under
921
+ * the `inbound_ach_transfer` object.
922
+ * - `inbound_ach_transfer_return_intention` - Inbound ACH Transfer Return
923
+ * Intention: details will be under the `inbound_ach_transfer_return_intention`
924
+ * object.
925
+ * - `inbound_check` - Inbound Check: details will be under the `inbound_check`
920
926
  * object.
921
- * - `check_deposit_return` - The Transaction was created by a Check Deposit Return
922
- * object. Details will be under the `check_deposit_return` object.
923
- * - `check_transfer_deposit` - The Transaction was created by a Check Transfer
924
- * Deposit object. Details will be under the `check_transfer_deposit` object.
925
- * - `check_transfer_intention` - The Transaction was created by a Check Transfer
926
- * Intention object. Details will be under the `check_transfer_intention` object.
927
- * - `check_transfer_rejection` - The Transaction was created by a Check Transfer
928
- * Rejection object. Details will be under the `check_transfer_rejection` object.
929
- * - `check_transfer_stop_payment_request` - The Transaction was created by a Check
930
- * Transfer Stop Payment Request object. Details will be under the
931
- * `check_transfer_stop_payment_request` object.
932
- * - `fee_payment` - The Transaction was created by a Fee Payment object. Details
933
- * will be under the `fee_payment` object.
934
- * - `inbound_ach_transfer` - The Transaction was created by a Inbound ACH Transfer
935
- * object. Details will be under the `inbound_ach_transfer` object.
936
- * - `inbound_ach_transfer_return_intention` - The Transaction was created by a
937
- * Inbound ACH Transfer Return Intention object. Details will be under the
938
- * `inbound_ach_transfer_return_intention` object.
939
- * - `inbound_check` - The Transaction was created by a Inbound Check object.
940
- * Details will be under the `inbound_check` object.
941
- * - `inbound_international_ach_transfer` - The Transaction was created by a
942
- * Inbound International ACH Transfer object. Details will be under the
943
- * `inbound_international_ach_transfer` object.
944
- * - `inbound_real_time_payments_transfer_confirmation` - The Transaction was
945
- * created by a Inbound Real Time Payments Transfer Confirmation object. Details
946
- * will be under the `inbound_real_time_payments_transfer_confirmation` object.
947
- * - `inbound_wire_drawdown_payment` - The Transaction was created by a Inbound
948
- * Wire Drawdown Payment object. Details will be under the
949
- * `inbound_wire_drawdown_payment` object.
950
- * - `inbound_wire_drawdown_payment_reversal` - The Transaction was created by a
951
- * Inbound Wire Drawdown Payment Reversal object. Details will be under the
952
- * `inbound_wire_drawdown_payment_reversal` object.
953
- * - `inbound_wire_reversal` - The Transaction was created by a Inbound Wire
954
- * Reversal object. Details will be under the `inbound_wire_reversal` object.
955
- * - `inbound_wire_transfer` - The Transaction was created by a Inbound Wire
956
- * Transfer object. Details will be under the `inbound_wire_transfer` object.
957
- * - `interest_payment` - The Transaction was created by a Interest Payment object.
958
- * Details will be under the `interest_payment` object.
959
- * - `internal_source` - The Transaction was created by a Internal Source object.
960
- * Details will be under the `internal_source` object.
961
- * - `real_time_payments_transfer_acknowledgement` - The Transaction was created by
962
- * a Real Time Payments Transfer Acknowledgement object. Details will be under
963
- * the `real_time_payments_transfer_acknowledgement` object.
964
- * - `sample_funds` - The Transaction was created by a Sample Funds object. Details
965
- * will be under the `sample_funds` object.
966
- * - `wire_transfer_intention` - The Transaction was created by a Wire Transfer
967
- * Intention object. Details will be under the `wire_transfer_intention` object.
968
- * - `wire_transfer_rejection` - The Transaction was created by a Wire Transfer
969
- * Rejection object. Details will be under the `wire_transfer_rejection` object.
927
+ * - `inbound_international_ach_transfer` - Inbound International ACH Transfer:
928
+ * details will be under the `inbound_international_ach_transfer` object.
929
+ * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real Time
930
+ * Payments Transfer Confirmation: details will be under the
931
+ * `inbound_real_time_payments_transfer_confirmation` object.
932
+ * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
933
+ * be under the `inbound_wire_drawdown_payment` object.
934
+ * - `inbound_wire_drawdown_payment_reversal` - Inbound Wire Drawdown Payment
935
+ * Reversal: details will be under the `inbound_wire_drawdown_payment_reversal`
936
+ * object.
937
+ * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
938
+ * `inbound_wire_reversal` object.
939
+ * - `inbound_wire_transfer` - Inbound Wire Transfer: details will be under the
940
+ * `inbound_wire_transfer` object.
941
+ * - `interest_payment` - Interest Payment: details will be under the
942
+ * `interest_payment` object.
943
+ * - `internal_source` - Internal Source: details will be under the
944
+ * `internal_source` object.
945
+ * - `real_time_payments_transfer_acknowledgement` - Real Time Payments Transfer
946
+ * Acknowledgement: details will be under the
947
+ * `real_time_payments_transfer_acknowledgement` object.
948
+ * - `sample_funds` - Sample Funds: details will be under the `sample_funds`
949
+ * object.
950
+ * - `wire_transfer_intention` - Wire Transfer Intention: details will be under the
951
+ * `wire_transfer_intention` object.
952
+ * - `wire_transfer_rejection` - Wire Transfer Rejection: details will be under the
953
+ * `wire_transfer_rejection` object.
970
954
  * - `other` - The Transaction was made for an undocumented or deprecated reason.
971
955
  */
972
956
  category:
@@ -982,7 +966,6 @@ export namespace ACHTransferSimulation {
982
966
  | 'check_deposit_return'
983
967
  | 'check_transfer_deposit'
984
968
  | 'check_transfer_intention'
985
- | 'check_transfer_rejection'
986
969
  | 'check_transfer_stop_payment_request'
987
970
  | 'fee_payment'
988
971
  | 'inbound_ach_transfer'
@@ -1026,12 +1009,6 @@ export namespace ACHTransferSimulation {
1026
1009
  */
1027
1010
  check_transfer_intention: Source.CheckTransferIntention | null;
1028
1011
 
1029
- /**
1030
- * A Check Transfer Rejection object. This field will be present in the JSON
1031
- * response if and only if `category` is equal to `check_transfer_rejection`.
1032
- */
1033
- check_transfer_rejection: Source.CheckTransferRejection | null;
1034
-
1035
1012
  /**
1036
1013
  * A Check Transfer Stop Payment Request object. This field will be present in the
1037
1014
  * JSON response if and only if `category` is equal to
@@ -1046,65 +1023,65 @@ export namespace ACHTransferSimulation {
1046
1023
  fee_payment: Source.FeePayment | null;
1047
1024
 
1048
1025
  /**
1049
- * A Inbound ACH Transfer object. This field will be present in the JSON response
1050
- * if and only if `category` is equal to `inbound_ach_transfer`.
1026
+ * An Inbound ACH Transfer Intention object. This field will be present in the JSON
1027
+ * response if and only if `category` is equal to `inbound_ach_transfer`.
1051
1028
  */
1052
1029
  inbound_ach_transfer: Source.InboundACHTransfer | null;
1053
1030
 
1054
1031
  /**
1055
- * A Inbound Check object. This field will be present in the JSON response if and
1032
+ * An Inbound Check object. This field will be present in the JSON response if and
1056
1033
  * only if `category` is equal to `inbound_check`.
1057
1034
  */
1058
1035
  inbound_check: Source.InboundCheck | null;
1059
1036
 
1060
1037
  /**
1061
- * A Inbound International ACH Transfer object. This field will be present in the
1038
+ * An Inbound International ACH Transfer object. This field will be present in the
1062
1039
  * JSON response if and only if `category` is equal to
1063
1040
  * `inbound_international_ach_transfer`.
1064
1041
  */
1065
1042
  inbound_international_ach_transfer: Source.InboundInternationalACHTransfer | null;
1066
1043
 
1067
1044
  /**
1068
- * A Inbound Real Time Payments Transfer Confirmation object. This field will be
1045
+ * An Inbound Real Time Payments Transfer Confirmation object. This field will be
1069
1046
  * present in the JSON response if and only if `category` is equal to
1070
1047
  * `inbound_real_time_payments_transfer_confirmation`.
1071
1048
  */
1072
1049
  inbound_real_time_payments_transfer_confirmation: Source.InboundRealTimePaymentsTransferConfirmation | null;
1073
1050
 
1074
1051
  /**
1075
- * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
1052
+ * An Inbound Wire Drawdown Payment object. This field will be present in the JSON
1076
1053
  * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
1077
1054
  */
1078
1055
  inbound_wire_drawdown_payment: Source.InboundWireDrawdownPayment | null;
1079
1056
 
1080
1057
  /**
1081
- * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
1058
+ * An Inbound Wire Drawdown Payment Reversal object. This field will be present in
1082
1059
  * the JSON response if and only if `category` is equal to
1083
1060
  * `inbound_wire_drawdown_payment_reversal`.
1084
1061
  */
1085
1062
  inbound_wire_drawdown_payment_reversal: Source.InboundWireDrawdownPaymentReversal | null;
1086
1063
 
1087
1064
  /**
1088
- * A Inbound Wire Reversal object. This field will be present in the JSON response
1065
+ * An Inbound Wire Reversal object. This field will be present in the JSON response
1089
1066
  * if and only if `category` is equal to `inbound_wire_reversal`.
1090
1067
  */
1091
1068
  inbound_wire_reversal: Source.InboundWireReversal | null;
1092
1069
 
1093
1070
  /**
1094
- * A Inbound Wire Transfer object. This field will be present in the JSON response
1071
+ * An Inbound Wire Transfer object. This field will be present in the JSON response
1095
1072
  * if and only if `category` is equal to `inbound_wire_transfer`.
1096
1073
  */
1097
1074
  inbound_wire_transfer: Source.InboundWireTransfer | null;
1098
1075
 
1099
1076
  /**
1100
- * A Interest Payment object. This field will be present in the JSON response if
1077
+ * An Interest Payment object. This field will be present in the JSON response if
1101
1078
  * and only if `category` is equal to `interest_payment`.
1102
1079
  */
1103
1080
  interest_payment: Source.InterestPayment | null;
1104
1081
 
1105
1082
  /**
1106
- * A Internal Source object. This field will be present in the JSON response if and
1107
- * only if `category` is equal to `internal_source`.
1083
+ * An Internal Source object. This field will be present in the JSON response if
1084
+ * and only if `category` is equal to `internal_source`.
1108
1085
  */
1109
1086
  internal_source: Source.InternalSource | null;
1110
1087
 
@@ -1136,7 +1113,7 @@ export namespace ACHTransferSimulation {
1136
1113
 
1137
1114
  export namespace Source {
1138
1115
  /**
1139
- * A Account Transfer Intention object. This field will be present in the JSON
1116
+ * An Account Transfer Intention object. This field will be present in the JSON
1140
1117
  * response if and only if `category` is equal to `account_transfer_intention`.
1141
1118
  */
1142
1119
  export interface AccountTransferIntention {
@@ -1181,8 +1158,8 @@ export namespace ACHTransferSimulation {
1181
1158
  }
1182
1159
 
1183
1160
  /**
1184
- * A ACH Transfer Intention object. This field will be present in the JSON response
1185
- * if and only if `category` is equal to `ach_transfer_intention`.
1161
+ * An ACH Transfer Intention object. This field will be present in the JSON
1162
+ * response if and only if `category` is equal to `ach_transfer_intention`.
1186
1163
  */
1187
1164
  export interface ACHTransferIntention {
1188
1165
  account_number: string;
@@ -1204,8 +1181,8 @@ export namespace ACHTransferSimulation {
1204
1181
  }
1205
1182
 
1206
1183
  /**
1207
- * A ACH Transfer Rejection object. This field will be present in the JSON response
1208
- * if and only if `category` is equal to `ach_transfer_rejection`.
1184
+ * An ACH Transfer Rejection object. This field will be present in the JSON
1185
+ * response if and only if `category` is equal to `ach_transfer_rejection`.
1209
1186
  */
1210
1187
  export interface ACHTransferRejection {
1211
1188
  /**
@@ -1215,8 +1192,8 @@ export namespace ACHTransferSimulation {
1215
1192
  }
1216
1193
 
1217
1194
  /**
1218
- * A ACH Transfer Return object. This field will be present in the JSON response if
1219
- * and only if `category` is equal to `ach_transfer_return`.
1195
+ * An ACH Transfer Return object. This field will be present in the JSON response
1196
+ * if and only if `category` is equal to `ach_transfer_return`.
1220
1197
  */
1221
1198
  export interface ACHTransferReturn {
1222
1199
  /**
@@ -1544,6 +1521,12 @@ export namespace ACHTransferSimulation {
1544
1521
  */
1545
1522
  merchant_state: string | null;
1546
1523
 
1524
+ /**
1525
+ * Additional details about the card purchase, such as tax and industry-specific
1526
+ * fields.
1527
+ */
1528
+ purchase_details: CardRefund.PurchaseDetails | null;
1529
+
1547
1530
  /**
1548
1531
  * The identifier of the Transaction associated with this Transaction.
1549
1532
  */
@@ -1556,6 +1539,535 @@ export namespace ACHTransferSimulation {
1556
1539
  type: 'card_refund';
1557
1540
  }
1558
1541
 
1542
+ export namespace CardRefund {
1543
+ /**
1544
+ * Additional details about the card purchase, such as tax and industry-specific
1545
+ * fields.
1546
+ */
1547
+ export interface PurchaseDetails {
1548
+ /**
1549
+ * Fields specific to car rentals.
1550
+ */
1551
+ car_rental: PurchaseDetails.CarRental | null;
1552
+
1553
+ /**
1554
+ * An identifier from the merchant for the customer or consumer.
1555
+ */
1556
+ customer_reference_identifier: string | null;
1557
+
1558
+ /**
1559
+ * The state or provincial tax amount in minor units.
1560
+ */
1561
+ local_tax_amount: number | null;
1562
+
1563
+ /**
1564
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1565
+ * assessed.
1566
+ */
1567
+ local_tax_currency: string | null;
1568
+
1569
+ /**
1570
+ * Fields specific to lodging.
1571
+ */
1572
+ lodging: PurchaseDetails.Lodging | null;
1573
+
1574
+ /**
1575
+ * The national tax amount in minor units.
1576
+ */
1577
+ national_tax_amount: number | null;
1578
+
1579
+ /**
1580
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1581
+ * assessed.
1582
+ */
1583
+ national_tax_currency: string | null;
1584
+
1585
+ /**
1586
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
1587
+ */
1588
+ purchase_identifier: string | null;
1589
+
1590
+ /**
1591
+ * The format of the purchase identifier.
1592
+ *
1593
+ * - `free_text` - Free text
1594
+ * - `order_number` - Order number
1595
+ * - `rental_agreement_number` - Rental agreement number
1596
+ * - `hotel_folio_number` - Hotel folio number
1597
+ * - `invoice_number` - Invoice number
1598
+ */
1599
+ purchase_identifier_format:
1600
+ | 'free_text'
1601
+ | 'order_number'
1602
+ | 'rental_agreement_number'
1603
+ | 'hotel_folio_number'
1604
+ | 'invoice_number'
1605
+ | null;
1606
+
1607
+ /**
1608
+ * Fields specific to travel.
1609
+ */
1610
+ travel: PurchaseDetails.Travel | null;
1611
+ }
1612
+
1613
+ export namespace PurchaseDetails {
1614
+ /**
1615
+ * Fields specific to car rentals.
1616
+ */
1617
+ export interface CarRental {
1618
+ /**
1619
+ * Code indicating the vehicle's class.
1620
+ */
1621
+ car_class_code: string | null;
1622
+
1623
+ /**
1624
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
1625
+ * transaction, the scheduled pick up date.
1626
+ */
1627
+ checkout_date: string | null;
1628
+
1629
+ /**
1630
+ * Daily rate being charged for the vehicle.
1631
+ */
1632
+ daily_rental_rate_amount: number | null;
1633
+
1634
+ /**
1635
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
1636
+ * rate.
1637
+ */
1638
+ daily_rental_rate_currency: string | null;
1639
+
1640
+ /**
1641
+ * Number of days the vehicle was rented.
1642
+ */
1643
+ days_rented: number | null;
1644
+
1645
+ /**
1646
+ * Additional charges (gas, late fee, etc.) being billed.
1647
+ *
1648
+ * - `no_extra_charge` - No extra charge
1649
+ * - `gas` - Gas
1650
+ * - `extra_mileage` - Extra mileage
1651
+ * - `late_return` - Late return
1652
+ * - `one_way_service_fee` - One way service fee
1653
+ * - `parking_violation` - Parking violation
1654
+ */
1655
+ extra_charges:
1656
+ | 'no_extra_charge'
1657
+ | 'gas'
1658
+ | 'extra_mileage'
1659
+ | 'late_return'
1660
+ | 'one_way_service_fee'
1661
+ | 'parking_violation'
1662
+ | null;
1663
+
1664
+ /**
1665
+ * Fuel charges for the vehicle.
1666
+ */
1667
+ fuel_charges_amount: number | null;
1668
+
1669
+ /**
1670
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
1671
+ * assessed.
1672
+ */
1673
+ fuel_charges_currency: string | null;
1674
+
1675
+ /**
1676
+ * Any insurance being charged for the vehicle.
1677
+ */
1678
+ insurance_charges_amount: number | null;
1679
+
1680
+ /**
1681
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
1682
+ * charges assessed.
1683
+ */
1684
+ insurance_charges_currency: string | null;
1685
+
1686
+ /**
1687
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
1688
+ * not actually rented (that is, a "no-show" charge).
1689
+ *
1690
+ * - `not_applicable` - Not applicable
1691
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
1692
+ */
1693
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
1694
+
1695
+ /**
1696
+ * Charges for returning the vehicle at a different location than where it was
1697
+ * picked up.
1698
+ */
1699
+ one_way_drop_off_charges_amount: number | null;
1700
+
1701
+ /**
1702
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
1703
+ * drop-off charges assessed.
1704
+ */
1705
+ one_way_drop_off_charges_currency: string | null;
1706
+
1707
+ /**
1708
+ * Name of the person renting the vehicle.
1709
+ */
1710
+ renter_name: string | null;
1711
+
1712
+ /**
1713
+ * Weekly rate being charged for the vehicle.
1714
+ */
1715
+ weekly_rental_rate_amount: number | null;
1716
+
1717
+ /**
1718
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
1719
+ * rental rate.
1720
+ */
1721
+ weekly_rental_rate_currency: string | null;
1722
+ }
1723
+
1724
+ /**
1725
+ * Fields specific to lodging.
1726
+ */
1727
+ export interface Lodging {
1728
+ /**
1729
+ * Date the customer checked in.
1730
+ */
1731
+ check_in_date: string | null;
1732
+
1733
+ /**
1734
+ * Daily rate being charged for the room.
1735
+ */
1736
+ daily_room_rate_amount: number | null;
1737
+
1738
+ /**
1739
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
1740
+ * rate.
1741
+ */
1742
+ daily_room_rate_currency: string | null;
1743
+
1744
+ /**
1745
+ * Additional charges (phone, late check-out, etc.) being billed.
1746
+ *
1747
+ * - `no_extra_charge` - No extra charge
1748
+ * - `restaurant` - Restaurant
1749
+ * - `gift_shop` - Gift shop
1750
+ * - `mini_bar` - Mini bar
1751
+ * - `telephone` - Telephone
1752
+ * - `other` - Other
1753
+ * - `laundry` - Laundry
1754
+ */
1755
+ extra_charges:
1756
+ | 'no_extra_charge'
1757
+ | 'restaurant'
1758
+ | 'gift_shop'
1759
+ | 'mini_bar'
1760
+ | 'telephone'
1761
+ | 'other'
1762
+ | 'laundry'
1763
+ | null;
1764
+
1765
+ /**
1766
+ * Folio cash advances for the room.
1767
+ */
1768
+ folio_cash_advances_amount: number | null;
1769
+
1770
+ /**
1771
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
1772
+ * advances.
1773
+ */
1774
+ folio_cash_advances_currency: string | null;
1775
+
1776
+ /**
1777
+ * Food and beverage charges for the room.
1778
+ */
1779
+ food_beverage_charges_amount: number | null;
1780
+
1781
+ /**
1782
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
1783
+ * beverage charges.
1784
+ */
1785
+ food_beverage_charges_currency: string | null;
1786
+
1787
+ /**
1788
+ * Indicator that the cardholder is being billed for a reserved room that was not
1789
+ * actually used.
1790
+ *
1791
+ * - `not_applicable` - Not applicable
1792
+ * - `no_show` - No show
1793
+ */
1794
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
1795
+
1796
+ /**
1797
+ * Prepaid expenses being charged for the room.
1798
+ */
1799
+ prepaid_expenses_amount: number | null;
1800
+
1801
+ /**
1802
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
1803
+ * expenses.
1804
+ */
1805
+ prepaid_expenses_currency: string | null;
1806
+
1807
+ /**
1808
+ * Number of nights the room was rented.
1809
+ */
1810
+ room_nights: number | null;
1811
+
1812
+ /**
1813
+ * Total room tax being charged.
1814
+ */
1815
+ total_room_tax_amount: number | null;
1816
+
1817
+ /**
1818
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
1819
+ * tax.
1820
+ */
1821
+ total_room_tax_currency: string | null;
1822
+
1823
+ /**
1824
+ * Total tax being charged for the room.
1825
+ */
1826
+ total_tax_amount: number | null;
1827
+
1828
+ /**
1829
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
1830
+ * assessed.
1831
+ */
1832
+ total_tax_currency: string | null;
1833
+ }
1834
+
1835
+ /**
1836
+ * Fields specific to travel.
1837
+ */
1838
+ export interface Travel {
1839
+ /**
1840
+ * Ancillary purchases in addition to the airfare.
1841
+ */
1842
+ ancillary: Travel.Ancillary | null;
1843
+
1844
+ /**
1845
+ * Indicates the computerized reservation system used to book the ticket.
1846
+ */
1847
+ computerized_reservation_system: string | null;
1848
+
1849
+ /**
1850
+ * Indicates the reason for a credit to the cardholder.
1851
+ *
1852
+ * - `no_credit` - No credit
1853
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1854
+ * ancillary purchase cancellation
1855
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1856
+ * Airline ticket and passenger transport ancillary purchase cancellation
1857
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
1858
+ * - `other` - Other
1859
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
1860
+ */
1861
+ credit_reason_indicator:
1862
+ | 'no_credit'
1863
+ | 'passenger_transport_ancillary_purchase_cancellation'
1864
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1865
+ | 'airline_ticket_cancellation'
1866
+ | 'other'
1867
+ | 'partial_refund_of_airline_ticket'
1868
+ | null;
1869
+
1870
+ /**
1871
+ * Date of departure.
1872
+ */
1873
+ departure_date: string | null;
1874
+
1875
+ /**
1876
+ * Code for the originating city or airport.
1877
+ */
1878
+ origination_city_airport_code: string | null;
1879
+
1880
+ /**
1881
+ * Name of the passenger.
1882
+ */
1883
+ passenger_name: string | null;
1884
+
1885
+ /**
1886
+ * Indicates whether this ticket is non-refundable.
1887
+ *
1888
+ * - `no_restrictions` - No restrictions
1889
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
1890
+ */
1891
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
1892
+
1893
+ /**
1894
+ * Indicates why a ticket was changed.
1895
+ *
1896
+ * - `none` - None
1897
+ * - `change_to_existing_ticket` - Change to existing ticket
1898
+ * - `new_ticket` - New ticket
1899
+ */
1900
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
1901
+
1902
+ /**
1903
+ * Ticket number.
1904
+ */
1905
+ ticket_number: string | null;
1906
+
1907
+ /**
1908
+ * Code for the travel agency if the ticket was issued by a travel agency.
1909
+ */
1910
+ travel_agency_code: string | null;
1911
+
1912
+ /**
1913
+ * Name of the travel agency if the ticket was issued by a travel agency.
1914
+ */
1915
+ travel_agency_name: string | null;
1916
+
1917
+ /**
1918
+ * Fields specific to each leg of the journey.
1919
+ */
1920
+ trip_legs: Array<Travel.TripLeg> | null;
1921
+ }
1922
+
1923
+ export namespace Travel {
1924
+ /**
1925
+ * Ancillary purchases in addition to the airfare.
1926
+ */
1927
+ export interface Ancillary {
1928
+ /**
1929
+ * If this purchase has a connection or relationship to another purchase, such as a
1930
+ * baggage fee for a passenger transport ticket, this field should contain the
1931
+ * ticket document number for the other purchase.
1932
+ */
1933
+ connected_ticket_document_number: string | null;
1934
+
1935
+ /**
1936
+ * Indicates the reason for a credit to the cardholder.
1937
+ *
1938
+ * - `no_credit` - No credit
1939
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1940
+ * ancillary purchase cancellation
1941
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1942
+ * Airline ticket and passenger transport ancillary purchase cancellation
1943
+ * - `other` - Other
1944
+ */
1945
+ credit_reason_indicator:
1946
+ | 'no_credit'
1947
+ | 'passenger_transport_ancillary_purchase_cancellation'
1948
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1949
+ | 'other'
1950
+ | null;
1951
+
1952
+ /**
1953
+ * Name of the passenger or description of the ancillary purchase.
1954
+ */
1955
+ passenger_name_or_description: string | null;
1956
+
1957
+ /**
1958
+ * Additional travel charges, such as baggage fees.
1959
+ */
1960
+ services: Array<Ancillary.Service>;
1961
+
1962
+ /**
1963
+ * Ticket document number.
1964
+ */
1965
+ ticket_document_number: string | null;
1966
+ }
1967
+
1968
+ export namespace Ancillary {
1969
+ export interface Service {
1970
+ /**
1971
+ * Category of the ancillary service.
1972
+ *
1973
+ * - `none` - None
1974
+ * - `bundled_service` - Bundled service
1975
+ * - `baggage_fee` - Baggage fee
1976
+ * - `change_fee` - Change fee
1977
+ * - `cargo` - Cargo
1978
+ * - `carbon_offset` - Carbon offset
1979
+ * - `frequent_flyer` - Frequent flyer
1980
+ * - `gift_card` - Gift card
1981
+ * - `ground_transport` - Ground transport
1982
+ * - `in_flight_entertainment` - In-flight entertainment
1983
+ * - `lounge` - Lounge
1984
+ * - `medical` - Medical
1985
+ * - `meal_beverage` - Meal beverage
1986
+ * - `other` - Other
1987
+ * - `passenger_assist_fee` - Passenger assist fee
1988
+ * - `pets` - Pets
1989
+ * - `seat_fees` - Seat fees
1990
+ * - `standby` - Standby
1991
+ * - `service_fee` - Service fee
1992
+ * - `store` - Store
1993
+ * - `travel_service` - Travel service
1994
+ * - `unaccompanied_travel` - Unaccompanied travel
1995
+ * - `upgrades` - Upgrades
1996
+ * - `wifi` - Wi-fi
1997
+ */
1998
+ category:
1999
+ | 'none'
2000
+ | 'bundled_service'
2001
+ | 'baggage_fee'
2002
+ | 'change_fee'
2003
+ | 'cargo'
2004
+ | 'carbon_offset'
2005
+ | 'frequent_flyer'
2006
+ | 'gift_card'
2007
+ | 'ground_transport'
2008
+ | 'in_flight_entertainment'
2009
+ | 'lounge'
2010
+ | 'medical'
2011
+ | 'meal_beverage'
2012
+ | 'other'
2013
+ | 'passenger_assist_fee'
2014
+ | 'pets'
2015
+ | 'seat_fees'
2016
+ | 'standby'
2017
+ | 'service_fee'
2018
+ | 'store'
2019
+ | 'travel_service'
2020
+ | 'unaccompanied_travel'
2021
+ | 'upgrades'
2022
+ | 'wifi'
2023
+ | null;
2024
+
2025
+ /**
2026
+ * Sub-category of the ancillary service, free-form.
2027
+ */
2028
+ sub_category: string | null;
2029
+ }
2030
+ }
2031
+
2032
+ export interface TripLeg {
2033
+ /**
2034
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
2035
+ */
2036
+ carrier_code: string | null;
2037
+
2038
+ /**
2039
+ * Code for the destination city or airport.
2040
+ */
2041
+ destination_city_airport_code: string | null;
2042
+
2043
+ /**
2044
+ * Fare basis code.
2045
+ */
2046
+ fare_basis_code: string | null;
2047
+
2048
+ /**
2049
+ * Flight number.
2050
+ */
2051
+ flight_number: string | null;
2052
+
2053
+ /**
2054
+ * Service class (e.g., first class, business class, etc.).
2055
+ */
2056
+ service_class: string | null;
2057
+
2058
+ /**
2059
+ * Indicates whether a stopover is allowed on this ticket.
2060
+ *
2061
+ * - `none` - None
2062
+ * - `stop_over_allowed` - Stop over allowed
2063
+ * - `stop_over_not_allowed` - Stop over not allowed
2064
+ */
2065
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
2066
+ }
2067
+ }
2068
+ }
2069
+ }
2070
+
1559
2071
  /**
1560
2072
  * A Card Revenue Payment object. This field will be present in the JSON response
1561
2073
  * if and only if `category` is equal to `card_revenue_payment`.
@@ -1678,6 +2190,12 @@ export namespace ACHTransferSimulation {
1678
2190
  */
1679
2191
  presentment_currency: string;
1680
2192
 
2193
+ /**
2194
+ * Additional details about the card purchase, such as tax and industry-specific
2195
+ * fields.
2196
+ */
2197
+ purchase_details: CardSettlement.PurchaseDetails | null;
2198
+
1681
2199
  /**
1682
2200
  * The identifier of the Transaction associated with this Transaction.
1683
2201
  */
@@ -1690,6 +2208,535 @@ export namespace ACHTransferSimulation {
1690
2208
  type: 'card_settlement';
1691
2209
  }
1692
2210
 
2211
+ export namespace CardSettlement {
2212
+ /**
2213
+ * Additional details about the card purchase, such as tax and industry-specific
2214
+ * fields.
2215
+ */
2216
+ export interface PurchaseDetails {
2217
+ /**
2218
+ * Fields specific to car rentals.
2219
+ */
2220
+ car_rental: PurchaseDetails.CarRental | null;
2221
+
2222
+ /**
2223
+ * An identifier from the merchant for the customer or consumer.
2224
+ */
2225
+ customer_reference_identifier: string | null;
2226
+
2227
+ /**
2228
+ * The state or provincial tax amount in minor units.
2229
+ */
2230
+ local_tax_amount: number | null;
2231
+
2232
+ /**
2233
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
2234
+ * assessed.
2235
+ */
2236
+ local_tax_currency: string | null;
2237
+
2238
+ /**
2239
+ * Fields specific to lodging.
2240
+ */
2241
+ lodging: PurchaseDetails.Lodging | null;
2242
+
2243
+ /**
2244
+ * The national tax amount in minor units.
2245
+ */
2246
+ national_tax_amount: number | null;
2247
+
2248
+ /**
2249
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
2250
+ * assessed.
2251
+ */
2252
+ national_tax_currency: string | null;
2253
+
2254
+ /**
2255
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
2256
+ */
2257
+ purchase_identifier: string | null;
2258
+
2259
+ /**
2260
+ * The format of the purchase identifier.
2261
+ *
2262
+ * - `free_text` - Free text
2263
+ * - `order_number` - Order number
2264
+ * - `rental_agreement_number` - Rental agreement number
2265
+ * - `hotel_folio_number` - Hotel folio number
2266
+ * - `invoice_number` - Invoice number
2267
+ */
2268
+ purchase_identifier_format:
2269
+ | 'free_text'
2270
+ | 'order_number'
2271
+ | 'rental_agreement_number'
2272
+ | 'hotel_folio_number'
2273
+ | 'invoice_number'
2274
+ | null;
2275
+
2276
+ /**
2277
+ * Fields specific to travel.
2278
+ */
2279
+ travel: PurchaseDetails.Travel | null;
2280
+ }
2281
+
2282
+ export namespace PurchaseDetails {
2283
+ /**
2284
+ * Fields specific to car rentals.
2285
+ */
2286
+ export interface CarRental {
2287
+ /**
2288
+ * Code indicating the vehicle's class.
2289
+ */
2290
+ car_class_code: string | null;
2291
+
2292
+ /**
2293
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
2294
+ * transaction, the scheduled pick up date.
2295
+ */
2296
+ checkout_date: string | null;
2297
+
2298
+ /**
2299
+ * Daily rate being charged for the vehicle.
2300
+ */
2301
+ daily_rental_rate_amount: number | null;
2302
+
2303
+ /**
2304
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
2305
+ * rate.
2306
+ */
2307
+ daily_rental_rate_currency: string | null;
2308
+
2309
+ /**
2310
+ * Number of days the vehicle was rented.
2311
+ */
2312
+ days_rented: number | null;
2313
+
2314
+ /**
2315
+ * Additional charges (gas, late fee, etc.) being billed.
2316
+ *
2317
+ * - `no_extra_charge` - No extra charge
2318
+ * - `gas` - Gas
2319
+ * - `extra_mileage` - Extra mileage
2320
+ * - `late_return` - Late return
2321
+ * - `one_way_service_fee` - One way service fee
2322
+ * - `parking_violation` - Parking violation
2323
+ */
2324
+ extra_charges:
2325
+ | 'no_extra_charge'
2326
+ | 'gas'
2327
+ | 'extra_mileage'
2328
+ | 'late_return'
2329
+ | 'one_way_service_fee'
2330
+ | 'parking_violation'
2331
+ | null;
2332
+
2333
+ /**
2334
+ * Fuel charges for the vehicle.
2335
+ */
2336
+ fuel_charges_amount: number | null;
2337
+
2338
+ /**
2339
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
2340
+ * assessed.
2341
+ */
2342
+ fuel_charges_currency: string | null;
2343
+
2344
+ /**
2345
+ * Any insurance being charged for the vehicle.
2346
+ */
2347
+ insurance_charges_amount: number | null;
2348
+
2349
+ /**
2350
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
2351
+ * charges assessed.
2352
+ */
2353
+ insurance_charges_currency: string | null;
2354
+
2355
+ /**
2356
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
2357
+ * not actually rented (that is, a "no-show" charge).
2358
+ *
2359
+ * - `not_applicable` - Not applicable
2360
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
2361
+ */
2362
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
2363
+
2364
+ /**
2365
+ * Charges for returning the vehicle at a different location than where it was
2366
+ * picked up.
2367
+ */
2368
+ one_way_drop_off_charges_amount: number | null;
2369
+
2370
+ /**
2371
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
2372
+ * drop-off charges assessed.
2373
+ */
2374
+ one_way_drop_off_charges_currency: string | null;
2375
+
2376
+ /**
2377
+ * Name of the person renting the vehicle.
2378
+ */
2379
+ renter_name: string | null;
2380
+
2381
+ /**
2382
+ * Weekly rate being charged for the vehicle.
2383
+ */
2384
+ weekly_rental_rate_amount: number | null;
2385
+
2386
+ /**
2387
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
2388
+ * rental rate.
2389
+ */
2390
+ weekly_rental_rate_currency: string | null;
2391
+ }
2392
+
2393
+ /**
2394
+ * Fields specific to lodging.
2395
+ */
2396
+ export interface Lodging {
2397
+ /**
2398
+ * Date the customer checked in.
2399
+ */
2400
+ check_in_date: string | null;
2401
+
2402
+ /**
2403
+ * Daily rate being charged for the room.
2404
+ */
2405
+ daily_room_rate_amount: number | null;
2406
+
2407
+ /**
2408
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
2409
+ * rate.
2410
+ */
2411
+ daily_room_rate_currency: string | null;
2412
+
2413
+ /**
2414
+ * Additional charges (phone, late check-out, etc.) being billed.
2415
+ *
2416
+ * - `no_extra_charge` - No extra charge
2417
+ * - `restaurant` - Restaurant
2418
+ * - `gift_shop` - Gift shop
2419
+ * - `mini_bar` - Mini bar
2420
+ * - `telephone` - Telephone
2421
+ * - `other` - Other
2422
+ * - `laundry` - Laundry
2423
+ */
2424
+ extra_charges:
2425
+ | 'no_extra_charge'
2426
+ | 'restaurant'
2427
+ | 'gift_shop'
2428
+ | 'mini_bar'
2429
+ | 'telephone'
2430
+ | 'other'
2431
+ | 'laundry'
2432
+ | null;
2433
+
2434
+ /**
2435
+ * Folio cash advances for the room.
2436
+ */
2437
+ folio_cash_advances_amount: number | null;
2438
+
2439
+ /**
2440
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
2441
+ * advances.
2442
+ */
2443
+ folio_cash_advances_currency: string | null;
2444
+
2445
+ /**
2446
+ * Food and beverage charges for the room.
2447
+ */
2448
+ food_beverage_charges_amount: number | null;
2449
+
2450
+ /**
2451
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
2452
+ * beverage charges.
2453
+ */
2454
+ food_beverage_charges_currency: string | null;
2455
+
2456
+ /**
2457
+ * Indicator that the cardholder is being billed for a reserved room that was not
2458
+ * actually used.
2459
+ *
2460
+ * - `not_applicable` - Not applicable
2461
+ * - `no_show` - No show
2462
+ */
2463
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
2464
+
2465
+ /**
2466
+ * Prepaid expenses being charged for the room.
2467
+ */
2468
+ prepaid_expenses_amount: number | null;
2469
+
2470
+ /**
2471
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
2472
+ * expenses.
2473
+ */
2474
+ prepaid_expenses_currency: string | null;
2475
+
2476
+ /**
2477
+ * Number of nights the room was rented.
2478
+ */
2479
+ room_nights: number | null;
2480
+
2481
+ /**
2482
+ * Total room tax being charged.
2483
+ */
2484
+ total_room_tax_amount: number | null;
2485
+
2486
+ /**
2487
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
2488
+ * tax.
2489
+ */
2490
+ total_room_tax_currency: string | null;
2491
+
2492
+ /**
2493
+ * Total tax being charged for the room.
2494
+ */
2495
+ total_tax_amount: number | null;
2496
+
2497
+ /**
2498
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
2499
+ * assessed.
2500
+ */
2501
+ total_tax_currency: string | null;
2502
+ }
2503
+
2504
+ /**
2505
+ * Fields specific to travel.
2506
+ */
2507
+ export interface Travel {
2508
+ /**
2509
+ * Ancillary purchases in addition to the airfare.
2510
+ */
2511
+ ancillary: Travel.Ancillary | null;
2512
+
2513
+ /**
2514
+ * Indicates the computerized reservation system used to book the ticket.
2515
+ */
2516
+ computerized_reservation_system: string | null;
2517
+
2518
+ /**
2519
+ * Indicates the reason for a credit to the cardholder.
2520
+ *
2521
+ * - `no_credit` - No credit
2522
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
2523
+ * ancillary purchase cancellation
2524
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
2525
+ * Airline ticket and passenger transport ancillary purchase cancellation
2526
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
2527
+ * - `other` - Other
2528
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
2529
+ */
2530
+ credit_reason_indicator:
2531
+ | 'no_credit'
2532
+ | 'passenger_transport_ancillary_purchase_cancellation'
2533
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
2534
+ | 'airline_ticket_cancellation'
2535
+ | 'other'
2536
+ | 'partial_refund_of_airline_ticket'
2537
+ | null;
2538
+
2539
+ /**
2540
+ * Date of departure.
2541
+ */
2542
+ departure_date: string | null;
2543
+
2544
+ /**
2545
+ * Code for the originating city or airport.
2546
+ */
2547
+ origination_city_airport_code: string | null;
2548
+
2549
+ /**
2550
+ * Name of the passenger.
2551
+ */
2552
+ passenger_name: string | null;
2553
+
2554
+ /**
2555
+ * Indicates whether this ticket is non-refundable.
2556
+ *
2557
+ * - `no_restrictions` - No restrictions
2558
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
2559
+ */
2560
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
2561
+
2562
+ /**
2563
+ * Indicates why a ticket was changed.
2564
+ *
2565
+ * - `none` - None
2566
+ * - `change_to_existing_ticket` - Change to existing ticket
2567
+ * - `new_ticket` - New ticket
2568
+ */
2569
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
2570
+
2571
+ /**
2572
+ * Ticket number.
2573
+ */
2574
+ ticket_number: string | null;
2575
+
2576
+ /**
2577
+ * Code for the travel agency if the ticket was issued by a travel agency.
2578
+ */
2579
+ travel_agency_code: string | null;
2580
+
2581
+ /**
2582
+ * Name of the travel agency if the ticket was issued by a travel agency.
2583
+ */
2584
+ travel_agency_name: string | null;
2585
+
2586
+ /**
2587
+ * Fields specific to each leg of the journey.
2588
+ */
2589
+ trip_legs: Array<Travel.TripLeg> | null;
2590
+ }
2591
+
2592
+ export namespace Travel {
2593
+ /**
2594
+ * Ancillary purchases in addition to the airfare.
2595
+ */
2596
+ export interface Ancillary {
2597
+ /**
2598
+ * If this purchase has a connection or relationship to another purchase, such as a
2599
+ * baggage fee for a passenger transport ticket, this field should contain the
2600
+ * ticket document number for the other purchase.
2601
+ */
2602
+ connected_ticket_document_number: string | null;
2603
+
2604
+ /**
2605
+ * Indicates the reason for a credit to the cardholder.
2606
+ *
2607
+ * - `no_credit` - No credit
2608
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
2609
+ * ancillary purchase cancellation
2610
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
2611
+ * Airline ticket and passenger transport ancillary purchase cancellation
2612
+ * - `other` - Other
2613
+ */
2614
+ credit_reason_indicator:
2615
+ | 'no_credit'
2616
+ | 'passenger_transport_ancillary_purchase_cancellation'
2617
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
2618
+ | 'other'
2619
+ | null;
2620
+
2621
+ /**
2622
+ * Name of the passenger or description of the ancillary purchase.
2623
+ */
2624
+ passenger_name_or_description: string | null;
2625
+
2626
+ /**
2627
+ * Additional travel charges, such as baggage fees.
2628
+ */
2629
+ services: Array<Ancillary.Service>;
2630
+
2631
+ /**
2632
+ * Ticket document number.
2633
+ */
2634
+ ticket_document_number: string | null;
2635
+ }
2636
+
2637
+ export namespace Ancillary {
2638
+ export interface Service {
2639
+ /**
2640
+ * Category of the ancillary service.
2641
+ *
2642
+ * - `none` - None
2643
+ * - `bundled_service` - Bundled service
2644
+ * - `baggage_fee` - Baggage fee
2645
+ * - `change_fee` - Change fee
2646
+ * - `cargo` - Cargo
2647
+ * - `carbon_offset` - Carbon offset
2648
+ * - `frequent_flyer` - Frequent flyer
2649
+ * - `gift_card` - Gift card
2650
+ * - `ground_transport` - Ground transport
2651
+ * - `in_flight_entertainment` - In-flight entertainment
2652
+ * - `lounge` - Lounge
2653
+ * - `medical` - Medical
2654
+ * - `meal_beverage` - Meal beverage
2655
+ * - `other` - Other
2656
+ * - `passenger_assist_fee` - Passenger assist fee
2657
+ * - `pets` - Pets
2658
+ * - `seat_fees` - Seat fees
2659
+ * - `standby` - Standby
2660
+ * - `service_fee` - Service fee
2661
+ * - `store` - Store
2662
+ * - `travel_service` - Travel service
2663
+ * - `unaccompanied_travel` - Unaccompanied travel
2664
+ * - `upgrades` - Upgrades
2665
+ * - `wifi` - Wi-fi
2666
+ */
2667
+ category:
2668
+ | 'none'
2669
+ | 'bundled_service'
2670
+ | 'baggage_fee'
2671
+ | 'change_fee'
2672
+ | 'cargo'
2673
+ | 'carbon_offset'
2674
+ | 'frequent_flyer'
2675
+ | 'gift_card'
2676
+ | 'ground_transport'
2677
+ | 'in_flight_entertainment'
2678
+ | 'lounge'
2679
+ | 'medical'
2680
+ | 'meal_beverage'
2681
+ | 'other'
2682
+ | 'passenger_assist_fee'
2683
+ | 'pets'
2684
+ | 'seat_fees'
2685
+ | 'standby'
2686
+ | 'service_fee'
2687
+ | 'store'
2688
+ | 'travel_service'
2689
+ | 'unaccompanied_travel'
2690
+ | 'upgrades'
2691
+ | 'wifi'
2692
+ | null;
2693
+
2694
+ /**
2695
+ * Sub-category of the ancillary service, free-form.
2696
+ */
2697
+ sub_category: string | null;
2698
+ }
2699
+ }
2700
+
2701
+ export interface TripLeg {
2702
+ /**
2703
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
2704
+ */
2705
+ carrier_code: string | null;
2706
+
2707
+ /**
2708
+ * Code for the destination city or airport.
2709
+ */
2710
+ destination_city_airport_code: string | null;
2711
+
2712
+ /**
2713
+ * Fare basis code.
2714
+ */
2715
+ fare_basis_code: string | null;
2716
+
2717
+ /**
2718
+ * Flight number.
2719
+ */
2720
+ flight_number: string | null;
2721
+
2722
+ /**
2723
+ * Service class (e.g., first class, business class, etc.).
2724
+ */
2725
+ service_class: string | null;
2726
+
2727
+ /**
2728
+ * Indicates whether a stopover is allowed on this ticket.
2729
+ *
2730
+ * - `none` - None
2731
+ * - `stop_over_allowed` - Stop over allowed
2732
+ * - `stop_over_not_allowed` - Stop over not allowed
2733
+ */
2734
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
2735
+ }
2736
+ }
2737
+ }
2738
+ }
2739
+
1693
2740
  /**
1694
2741
  * A Check Deposit Acceptance object. This field will be present in the JSON
1695
2742
  * response if and only if `category` is equal to `check_deposit_acceptance`.
@@ -1905,17 +2952,6 @@ export namespace ACHTransferSimulation {
1905
2952
  transfer_id: string;
1906
2953
  }
1907
2954
 
1908
- /**
1909
- * A Check Transfer Rejection object. This field will be present in the JSON
1910
- * response if and only if `category` is equal to `check_transfer_rejection`.
1911
- */
1912
- export interface CheckTransferRejection {
1913
- /**
1914
- * The identifier of the Check Transfer that led to this Transaction.
1915
- */
1916
- transfer_id: string;
1917
- }
1918
-
1919
2955
  /**
1920
2956
  * A Check Transfer Stop Payment Request object. This field will be present in the
1921
2957
  * JSON response if and only if `category` is equal to
@@ -1926,9 +2962,11 @@ export namespace ACHTransferSimulation {
1926
2962
  * The reason why this transfer was stopped.
1927
2963
  *
1928
2964
  * - `mail_delivery_failed` - The check could not be delivered.
2965
+ * - `rejected_by_increase` - The check was cancelled by an Increase operator who
2966
+ * will provide details out-of-band.
1929
2967
  * - `unknown` - The check was stopped for another reason.
1930
2968
  */
1931
- reason: 'mail_delivery_failed' | 'unknown';
2969
+ reason: 'mail_delivery_failed' | 'rejected_by_increase' | 'unknown';
1932
2970
 
1933
2971
  /**
1934
2972
  * The time the stop-payment was requested.
@@ -1978,8 +3016,8 @@ export namespace ACHTransferSimulation {
1978
3016
  }
1979
3017
 
1980
3018
  /**
1981
- * A Inbound ACH Transfer object. This field will be present in the JSON response
1982
- * if and only if `category` is equal to `inbound_ach_transfer`.
3019
+ * An Inbound ACH Transfer Intention object. This field will be present in the JSON
3020
+ * response if and only if `category` is equal to `inbound_ach_transfer`.
1983
3021
  */
1984
3022
  export interface InboundACHTransfer {
1985
3023
  /**
@@ -2006,7 +3044,7 @@ export namespace ACHTransferSimulation {
2006
3044
  }
2007
3045
 
2008
3046
  /**
2009
- * A Inbound Check object. This field will be present in the JSON response if and
3047
+ * An Inbound Check object. This field will be present in the JSON response if and
2010
3048
  * only if `category` is equal to `inbound_check`.
2011
3049
  */
2012
3050
  export interface InboundCheck {
@@ -2037,7 +3075,7 @@ export namespace ACHTransferSimulation {
2037
3075
  }
2038
3076
 
2039
3077
  /**
2040
- * A Inbound International ACH Transfer object. This field will be present in the
3078
+ * An Inbound International ACH Transfer object. This field will be present in the
2041
3079
  * JSON response if and only if `category` is equal to
2042
3080
  * `inbound_international_ach_transfer`.
2043
3081
  */
@@ -2120,7 +3158,7 @@ export namespace ACHTransferSimulation {
2120
3158
  }
2121
3159
 
2122
3160
  /**
2123
- * A Inbound Real Time Payments Transfer Confirmation object. This field will be
3161
+ * An Inbound Real Time Payments Transfer Confirmation object. This field will be
2124
3162
  * present in the JSON response if and only if `category` is equal to
2125
3163
  * `inbound_real_time_payments_transfer_confirmation`.
2126
3164
  */
@@ -2176,7 +3214,7 @@ export namespace ACHTransferSimulation {
2176
3214
  }
2177
3215
 
2178
3216
  /**
2179
- * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
3217
+ * An Inbound Wire Drawdown Payment object. This field will be present in the JSON
2180
3218
  * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
2181
3219
  */
2182
3220
  export interface InboundWireDrawdownPayment {
@@ -2212,7 +3250,7 @@ export namespace ACHTransferSimulation {
2212
3250
  }
2213
3251
 
2214
3252
  /**
2215
- * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
3253
+ * An Inbound Wire Drawdown Payment Reversal object. This field will be present in
2216
3254
  * the JSON response if and only if `category` is equal to
2217
3255
  * `inbound_wire_drawdown_payment_reversal`.
2218
3256
  */
@@ -2269,7 +3307,7 @@ export namespace ACHTransferSimulation {
2269
3307
  }
2270
3308
 
2271
3309
  /**
2272
- * A Inbound Wire Reversal object. This field will be present in the JSON response
3310
+ * An Inbound Wire Reversal object. This field will be present in the JSON response
2273
3311
  * if and only if `category` is equal to `inbound_wire_reversal`.
2274
3312
  */
2275
3313
  export interface InboundWireReversal {
@@ -2352,7 +3390,7 @@ export namespace ACHTransferSimulation {
2352
3390
  }
2353
3391
 
2354
3392
  /**
2355
- * A Inbound Wire Transfer object. This field will be present in the JSON response
3393
+ * An Inbound Wire Transfer object. This field will be present in the JSON response
2356
3394
  * if and only if `category` is equal to `inbound_wire_transfer`.
2357
3395
  */
2358
3396
  export interface InboundWireTransfer {
@@ -2396,7 +3434,7 @@ export namespace ACHTransferSimulation {
2396
3434
  }
2397
3435
 
2398
3436
  /**
2399
- * A Interest Payment object. This field will be present in the JSON response if
3437
+ * An Interest Payment object. This field will be present in the JSON response if
2400
3438
  * and only if `category` is equal to `interest_payment`.
2401
3439
  */
2402
3440
  export interface InterestPayment {
@@ -2436,8 +3474,8 @@ export namespace ACHTransferSimulation {
2436
3474
  }
2437
3475
 
2438
3476
  /**
2439
- * A Internal Source object. This field will be present in the JSON response if and
2440
- * only if `category` is equal to `internal_source`.
3477
+ * An Internal Source object. This field will be present in the JSON response if
3478
+ * and only if `category` is equal to `internal_source`.
2441
3479
  */
2442
3480
  export interface InternalSource {
2443
3481
  /**
@@ -2463,6 +3501,7 @@ export namespace ACHTransferSimulation {
2463
3501
  * - `account_closure` - Account closure
2464
3502
  * - `bank_migration` - Bank migration
2465
3503
  * - `cashback` - Cashback
3504
+ * - `check_adjustment` - Check adjustment
2466
3505
  * - `collection_receivable` - Collection receivable
2467
3506
  * - `empyreal_adjustment` - Empyreal adjustment
2468
3507
  * - `error` - Error
@@ -2477,6 +3516,7 @@ export namespace ACHTransferSimulation {
2477
3516
  | 'account_closure'
2478
3517
  | 'bank_migration'
2479
3518
  | 'cashback'
3519
+ | 'check_adjustment'
2480
3520
  | 'collection_receivable'
2481
3521
  | 'empyreal_adjustment'
2482
3522
  | 'error'