increase 0.377.0 → 0.378.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 (1262) hide show
  1. package/CHANGELOG.md +180 -4442
  2. package/README.md +115 -50
  3. package/api-promise.d.mts +2 -0
  4. package/api-promise.d.mts.map +1 -0
  5. package/api-promise.d.ts +2 -0
  6. package/api-promise.d.ts.map +1 -0
  7. package/api-promise.js +6 -0
  8. package/api-promise.js.map +1 -0
  9. package/api-promise.mjs +2 -0
  10. package/api-promise.mjs.map +1 -0
  11. package/bin/cli +46 -0
  12. package/bin/migration-config.json +6 -0
  13. package/client.d.mts +382 -0
  14. package/client.d.mts.map +1 -0
  15. package/client.d.ts +382 -0
  16. package/client.d.ts.map +1 -0
  17. package/client.js +650 -0
  18. package/client.js.map +1 -0
  19. package/client.mjs +646 -0
  20. package/client.mjs.map +1 -0
  21. package/core/api-promise.d.mts +46 -0
  22. package/core/api-promise.d.mts.map +1 -0
  23. package/core/api-promise.d.ts +46 -0
  24. package/core/api-promise.d.ts.map +1 -0
  25. package/core/api-promise.js +74 -0
  26. package/core/api-promise.js.map +1 -0
  27. package/core/api-promise.mjs +70 -0
  28. package/core/api-promise.mjs.map +1 -0
  29. package/core/error.d.mts +145 -0
  30. package/core/error.d.mts.map +1 -0
  31. package/core/error.d.ts +145 -0
  32. package/core/error.d.ts.map +1 -0
  33. package/core/error.js +280 -0
  34. package/core/error.js.map +1 -0
  35. package/core/error.mjs +253 -0
  36. package/core/error.mjs.map +1 -0
  37. package/core/pagination.d.mts +67 -0
  38. package/core/pagination.d.mts.map +1 -0
  39. package/core/pagination.d.ts +67 -0
  40. package/core/pagination.d.ts.map +1 -0
  41. package/core/pagination.js +101 -0
  42. package/core/pagination.js.map +1 -0
  43. package/core/pagination.mjs +95 -0
  44. package/core/pagination.mjs.map +1 -0
  45. package/core/resource.d.mts +6 -0
  46. package/core/resource.d.mts.map +1 -0
  47. package/core/resource.d.ts +6 -0
  48. package/core/resource.d.ts.map +1 -0
  49. package/core/resource.js +11 -0
  50. package/core/resource.js.map +1 -0
  51. package/core/resource.mjs +7 -0
  52. package/core/resource.mjs.map +1 -0
  53. package/core/uploads.d.mts +3 -0
  54. package/core/uploads.d.mts.map +1 -0
  55. package/core/uploads.d.ts +3 -0
  56. package/core/uploads.d.ts.map +1 -0
  57. package/core/uploads.js +6 -0
  58. package/core/uploads.js.map +1 -0
  59. package/core/uploads.mjs +2 -0
  60. package/core/uploads.mjs.map +1 -0
  61. package/error.d.mts +2 -0
  62. package/error.d.mts.map +1 -0
  63. package/error.d.ts +1 -145
  64. package/error.d.ts.map +1 -1
  65. package/error.js +3 -277
  66. package/error.js.map +1 -1
  67. package/error.mjs +1 -252
  68. package/error.mjs.map +1 -1
  69. package/index.d.mts +7 -320
  70. package/index.d.mts.map +1 -0
  71. package/index.d.ts +6 -319
  72. package/index.d.ts.map +1 -1
  73. package/index.js +14 -358
  74. package/index.js.map +1 -1
  75. package/index.mjs +6 -331
  76. package/index.mjs.map +1 -1
  77. package/internal/builtin-types.d.mts +73 -0
  78. package/internal/builtin-types.d.mts.map +1 -0
  79. package/internal/builtin-types.d.ts +73 -0
  80. package/internal/builtin-types.d.ts.map +1 -0
  81. package/internal/builtin-types.js +4 -0
  82. package/internal/builtin-types.js.map +1 -0
  83. package/internal/builtin-types.mjs +3 -0
  84. package/internal/builtin-types.mjs.map +1 -0
  85. package/internal/detect-platform.d.mts +15 -0
  86. package/internal/detect-platform.d.mts.map +1 -0
  87. package/internal/detect-platform.d.ts +15 -0
  88. package/internal/detect-platform.d.ts.map +1 -0
  89. package/internal/detect-platform.js +162 -0
  90. package/internal/detect-platform.js.map +1 -0
  91. package/internal/detect-platform.mjs +157 -0
  92. package/internal/detect-platform.mjs.map +1 -0
  93. package/internal/errors.d.mts +3 -0
  94. package/internal/errors.d.mts.map +1 -0
  95. package/internal/errors.d.ts +3 -0
  96. package/internal/errors.d.ts.map +1 -0
  97. package/internal/errors.js +41 -0
  98. package/internal/errors.js.map +1 -0
  99. package/internal/errors.mjs +36 -0
  100. package/internal/errors.mjs.map +1 -0
  101. package/internal/headers.d.mts +20 -0
  102. package/internal/headers.d.mts.map +1 -0
  103. package/internal/headers.d.ts +20 -0
  104. package/internal/headers.d.ts.map +1 -0
  105. package/internal/headers.js +79 -0
  106. package/internal/headers.js.map +1 -0
  107. package/internal/headers.mjs +74 -0
  108. package/internal/headers.mjs.map +1 -0
  109. package/internal/parse.d.mts +12 -0
  110. package/internal/parse.d.mts.map +1 -0
  111. package/internal/parse.d.ts +12 -0
  112. package/internal/parse.d.ts.map +1 -0
  113. package/internal/parse.js +35 -0
  114. package/internal/parse.js.map +1 -0
  115. package/internal/parse.mjs +32 -0
  116. package/internal/parse.mjs.map +1 -0
  117. package/internal/qs/formats.d.mts +7 -0
  118. package/internal/qs/formats.d.mts.map +1 -0
  119. package/internal/qs/formats.d.ts +1 -0
  120. package/internal/qs/formats.d.ts.map +1 -1
  121. package/internal/qs/formats.js +4 -2
  122. package/internal/qs/formats.js.map +1 -1
  123. package/internal/qs/formats.mjs +2 -1
  124. package/internal/qs/formats.mjs.map +1 -1
  125. package/internal/qs/index.d.mts +10 -0
  126. package/internal/qs/index.d.mts.map +1 -0
  127. package/internal/qs/index.d.ts.map +1 -1
  128. package/internal/qs/stringify.d.mts +3 -0
  129. package/internal/qs/stringify.d.mts.map +1 -0
  130. package/internal/qs/stringify.d.ts.map +1 -1
  131. package/internal/qs/stringify.js +16 -19
  132. package/internal/qs/stringify.js.map +1 -1
  133. package/internal/qs/stringify.mjs +17 -19
  134. package/internal/qs/stringify.mjs.map +1 -1
  135. package/internal/qs/types.d.mts +57 -0
  136. package/internal/qs/types.d.mts.map +1 -0
  137. package/internal/qs/utils.d.mts +15 -0
  138. package/internal/qs/utils.d.mts.map +1 -0
  139. package/internal/qs/utils.d.ts +1 -0
  140. package/internal/qs/utils.d.ts.map +1 -1
  141. package/internal/qs/utils.js +22 -21
  142. package/internal/qs/utils.js.map +1 -1
  143. package/internal/qs/utils.mjs +12 -12
  144. package/internal/qs/utils.mjs.map +1 -1
  145. package/internal/request-options.d.mts +75 -0
  146. package/internal/request-options.d.mts.map +1 -0
  147. package/internal/request-options.d.ts +75 -0
  148. package/internal/request-options.d.ts.map +1 -0
  149. package/internal/request-options.js +14 -0
  150. package/internal/request-options.js.map +1 -0
  151. package/internal/request-options.mjs +10 -0
  152. package/internal/request-options.mjs.map +1 -0
  153. package/internal/shim-types.d.mts +17 -0
  154. package/internal/shim-types.d.mts.map +1 -0
  155. package/internal/shim-types.d.ts +17 -0
  156. package/internal/shim-types.d.ts.map +1 -0
  157. package/internal/shim-types.js +4 -0
  158. package/internal/shim-types.js.map +1 -0
  159. package/internal/shim-types.mjs +3 -0
  160. package/internal/shim-types.mjs.map +1 -0
  161. package/internal/shims.d.mts +20 -0
  162. package/internal/shims.d.mts.map +1 -0
  163. package/internal/shims.d.ts +20 -0
  164. package/internal/shims.d.ts.map +1 -0
  165. package/internal/shims.js +92 -0
  166. package/internal/shims.js.map +1 -0
  167. package/internal/shims.mjs +85 -0
  168. package/internal/shims.mjs.map +1 -0
  169. package/internal/to-file.d.mts +45 -0
  170. package/internal/to-file.d.mts.map +1 -0
  171. package/internal/to-file.d.ts +45 -0
  172. package/internal/to-file.d.ts.map +1 -0
  173. package/internal/to-file.js +91 -0
  174. package/internal/to-file.js.map +1 -0
  175. package/internal/to-file.mjs +88 -0
  176. package/internal/to-file.mjs.map +1 -0
  177. package/internal/tslib.js +81 -0
  178. package/internal/tslib.mjs +17 -0
  179. package/internal/types.d.mts +69 -0
  180. package/internal/types.d.mts.map +1 -0
  181. package/internal/types.d.ts +69 -0
  182. package/internal/types.d.ts.map +1 -0
  183. package/internal/types.js +4 -0
  184. package/internal/types.js.map +1 -0
  185. package/internal/types.mjs +3 -0
  186. package/internal/types.mjs.map +1 -0
  187. package/internal/uploads.d.mts +42 -0
  188. package/internal/uploads.d.mts.map +1 -0
  189. package/internal/uploads.d.ts +42 -0
  190. package/internal/uploads.d.ts.map +1 -0
  191. package/internal/uploads.js +141 -0
  192. package/internal/uploads.js.map +1 -0
  193. package/internal/uploads.mjs +131 -0
  194. package/internal/uploads.mjs.map +1 -0
  195. package/internal/utils/base64.d.mts +3 -0
  196. package/internal/utils/base64.d.mts.map +1 -0
  197. package/internal/utils/base64.d.ts +3 -0
  198. package/internal/utils/base64.d.ts.map +1 -0
  199. package/internal/utils/base64.js +38 -0
  200. package/internal/utils/base64.js.map +1 -0
  201. package/internal/utils/base64.mjs +33 -0
  202. package/internal/utils/base64.mjs.map +1 -0
  203. package/internal/utils/bytes.d.mts +4 -0
  204. package/internal/utils/bytes.d.mts.map +1 -0
  205. package/internal/utils/bytes.d.ts +4 -0
  206. package/internal/utils/bytes.d.ts.map +1 -0
  207. package/internal/utils/bytes.js +31 -0
  208. package/internal/utils/bytes.js.map +1 -0
  209. package/internal/utils/bytes.mjs +26 -0
  210. package/internal/utils/bytes.mjs.map +1 -0
  211. package/internal/utils/env.d.mts +9 -0
  212. package/internal/utils/env.d.mts.map +1 -0
  213. package/internal/utils/env.d.ts +9 -0
  214. package/internal/utils/env.d.ts.map +1 -0
  215. package/internal/utils/env.js +22 -0
  216. package/internal/utils/env.js.map +1 -0
  217. package/internal/utils/env.mjs +18 -0
  218. package/internal/utils/env.mjs.map +1 -0
  219. package/internal/utils/log.d.mts +37 -0
  220. package/internal/utils/log.d.mts.map +1 -0
  221. package/internal/utils/log.d.ts +37 -0
  222. package/internal/utils/log.d.ts.map +1 -0
  223. package/internal/utils/log.js +85 -0
  224. package/internal/utils/log.js.map +1 -0
  225. package/internal/utils/log.mjs +79 -0
  226. package/internal/utils/log.mjs.map +1 -0
  227. package/internal/utils/path.d.mts +15 -0
  228. package/internal/utils/path.d.mts.map +1 -0
  229. package/internal/utils/path.d.ts +15 -0
  230. package/internal/utils/path.d.ts.map +1 -0
  231. package/internal/utils/path.js +79 -0
  232. package/internal/utils/path.js.map +1 -0
  233. package/internal/utils/path.mjs +74 -0
  234. package/internal/utils/path.mjs.map +1 -0
  235. package/internal/utils/sleep.d.mts +2 -0
  236. package/internal/utils/sleep.d.mts.map +1 -0
  237. package/internal/utils/sleep.d.ts +2 -0
  238. package/internal/utils/sleep.d.ts.map +1 -0
  239. package/internal/utils/sleep.js +7 -0
  240. package/internal/utils/sleep.js.map +1 -0
  241. package/internal/utils/sleep.mjs +3 -0
  242. package/internal/utils/sleep.mjs.map +1 -0
  243. package/internal/utils/uuid.d.mts +5 -0
  244. package/internal/utils/uuid.d.mts.map +1 -0
  245. package/internal/utils/uuid.d.ts +5 -0
  246. package/internal/utils/uuid.d.ts.map +1 -0
  247. package/internal/utils/uuid.js +19 -0
  248. package/internal/utils/uuid.js.map +1 -0
  249. package/internal/utils/uuid.mjs +15 -0
  250. package/internal/utils/uuid.mjs.map +1 -0
  251. package/internal/utils/values.d.mts +18 -0
  252. package/internal/utils/values.d.mts.map +1 -0
  253. package/internal/utils/values.d.ts +18 -0
  254. package/internal/utils/values.d.ts.map +1 -0
  255. package/internal/utils/values.js +112 -0
  256. package/internal/utils/values.js.map +1 -0
  257. package/internal/utils/values.mjs +94 -0
  258. package/internal/utils/values.mjs.map +1 -0
  259. package/internal/utils.d.mts +7 -0
  260. package/internal/utils.d.mts.map +1 -0
  261. package/internal/utils.d.ts +7 -0
  262. package/internal/utils.d.ts.map +1 -0
  263. package/internal/utils.js +11 -0
  264. package/internal/utils.js.map +1 -0
  265. package/internal/utils.mjs +8 -0
  266. package/internal/utils.mjs.map +1 -0
  267. package/package.json +114 -66
  268. package/pagination.d.mts +2 -0
  269. package/pagination.d.mts.map +1 -0
  270. package/pagination.d.ts +1 -30
  271. package/pagination.d.ts.map +1 -1
  272. package/pagination.js +3 -37
  273. package/pagination.js.map +1 -1
  274. package/pagination.mjs +1 -35
  275. package/pagination.mjs.map +1 -1
  276. package/resource.d.mts +2 -0
  277. package/resource.d.mts.map +1 -0
  278. package/resource.d.ts +1 -5
  279. package/resource.d.ts.map +1 -1
  280. package/resource.js +3 -8
  281. package/resource.js.map +1 -1
  282. package/resource.mjs +1 -6
  283. package/resource.mjs.map +1 -1
  284. package/resources/account-numbers.d.mts +309 -0
  285. package/resources/account-numbers.d.mts.map +1 -0
  286. package/resources/account-numbers.d.ts +10 -11
  287. package/resources/account-numbers.d.ts.map +1 -1
  288. package/resources/account-numbers.js +20 -16
  289. package/resources/account-numbers.js.map +1 -1
  290. package/resources/account-numbers.mjs +19 -14
  291. package/resources/account-numbers.mjs.map +1 -1
  292. package/resources/account-statements.d.mts +113 -0
  293. package/resources/account-statements.d.mts.map +1 -0
  294. package/resources/account-statements.d.ts +8 -9
  295. package/resources/account-statements.d.ts.map +1 -1
  296. package/resources/account-statements.js +18 -14
  297. package/resources/account-statements.js.map +1 -1
  298. package/resources/account-statements.mjs +17 -12
  299. package/resources/account-statements.mjs.map +1 -1
  300. package/resources/account-transfers.d.mts +325 -0
  301. package/resources/account-transfers.d.mts.map +1 -0
  302. package/resources/account-transfers.d.ts +11 -12
  303. package/resources/account-transfers.d.ts.map +1 -1
  304. package/resources/account-transfers.js +22 -18
  305. package/resources/account-transfers.js.map +1 -1
  306. package/resources/account-transfers.mjs +21 -16
  307. package/resources/account-transfers.mjs.map +1 -1
  308. package/resources/accounts.d.mts +291 -0
  309. package/resources/accounts.d.mts.map +1 -0
  310. package/resources/accounts.d.ts +12 -14
  311. package/resources/accounts.d.ts.map +1 -1
  312. package/resources/accounts.js +35 -23
  313. package/resources/accounts.js.map +1 -1
  314. package/resources/accounts.mjs +34 -21
  315. package/resources/accounts.mjs.map +1 -1
  316. package/resources/ach-prenotifications.d.mts +473 -0
  317. package/resources/ach-prenotifications.d.mts.map +1 -0
  318. package/resources/ach-prenotifications.d.ts +9 -10
  319. package/resources/ach-prenotifications.d.ts.map +1 -1
  320. package/resources/ach-prenotifications.js +18 -14
  321. package/resources/ach-prenotifications.js.map +1 -1
  322. package/resources/ach-prenotifications.mjs +17 -12
  323. package/resources/ach-prenotifications.mjs.map +1 -1
  324. package/resources/ach-transfers.d.mts +1091 -0
  325. package/resources/ach-transfers.d.mts.map +1 -0
  326. package/resources/ach-transfers.d.ts +11 -12
  327. package/resources/ach-transfers.d.ts.map +1 -1
  328. package/resources/ach-transfers.js +22 -18
  329. package/resources/ach-transfers.js.map +1 -1
  330. package/resources/ach-transfers.mjs +21 -16
  331. package/resources/ach-transfers.mjs.map +1 -1
  332. package/resources/bookkeeping-accounts.d.mts +164 -0
  333. package/resources/bookkeeping-accounts.d.mts.map +1 -0
  334. package/resources/bookkeeping-accounts.d.ts +10 -12
  335. package/resources/bookkeeping-accounts.d.ts.map +1 -1
  336. package/resources/bookkeeping-accounts.js +34 -19
  337. package/resources/bookkeeping-accounts.js.map +1 -1
  338. package/resources/bookkeeping-accounts.mjs +33 -17
  339. package/resources/bookkeeping-accounts.mjs.map +1 -1
  340. package/resources/bookkeeping-entries.d.mts +74 -0
  341. package/resources/bookkeeping-entries.d.mts.map +1 -0
  342. package/resources/bookkeeping-entries.d.ts +8 -9
  343. package/resources/bookkeeping-entries.d.ts.map +1 -1
  344. package/resources/bookkeeping-entries.js +18 -14
  345. package/resources/bookkeeping-entries.js.map +1 -1
  346. package/resources/bookkeeping-entries.mjs +17 -12
  347. package/resources/bookkeeping-entries.mjs.map +1 -1
  348. package/resources/bookkeeping-entry-sets.d.mts +156 -0
  349. package/resources/bookkeeping-entry-sets.d.mts.map +1 -0
  350. package/resources/bookkeeping-entry-sets.d.ts +9 -10
  351. package/resources/bookkeeping-entry-sets.d.ts.map +1 -1
  352. package/resources/bookkeeping-entry-sets.js +18 -14
  353. package/resources/bookkeeping-entry-sets.js.map +1 -1
  354. package/resources/bookkeeping-entry-sets.mjs +17 -12
  355. package/resources/bookkeeping-entry-sets.mjs.map +1 -1
  356. package/resources/card-disputes.d.mts +5657 -0
  357. package/resources/card-disputes.d.mts.map +1 -0
  358. package/resources/card-disputes.d.ts +11 -12
  359. package/resources/card-disputes.d.ts.map +1 -1
  360. package/resources/card-disputes.js +25 -18
  361. package/resources/card-disputes.js.map +1 -1
  362. package/resources/card-disputes.mjs +24 -16
  363. package/resources/card-disputes.mjs.map +1 -1
  364. package/resources/card-payments.d.mts +4523 -0
  365. package/resources/card-payments.d.mts.map +1 -0
  366. package/resources/card-payments.d.ts +8 -9
  367. package/resources/card-payments.d.ts.map +1 -1
  368. package/resources/card-payments.js +18 -14
  369. package/resources/card-payments.js.map +1 -1
  370. package/resources/card-payments.mjs +17 -12
  371. package/resources/card-payments.mjs.map +1 -1
  372. package/resources/card-purchase-supplements.d.mts +266 -0
  373. package/resources/card-purchase-supplements.d.mts.map +1 -0
  374. package/resources/card-purchase-supplements.d.ts +8 -9
  375. package/resources/card-purchase-supplements.d.ts.map +1 -1
  376. package/resources/card-purchase-supplements.js +18 -14
  377. package/resources/card-purchase-supplements.js.map +1 -1
  378. package/resources/card-purchase-supplements.mjs +17 -12
  379. package/resources/card-purchase-supplements.mjs.map +1 -1
  380. package/resources/card-push-transfers.d.mts +992 -0
  381. package/resources/card-push-transfers.d.mts.map +1 -0
  382. package/resources/card-push-transfers.d.ts +11 -12
  383. package/resources/card-push-transfers.d.ts.map +1 -1
  384. package/resources/card-push-transfers.js +22 -18
  385. package/resources/card-push-transfers.js.map +1 -1
  386. package/resources/card-push-transfers.mjs +21 -16
  387. package/resources/card-push-transfers.mjs.map +1 -1
  388. package/resources/card-tokens.d.mts +153 -0
  389. package/resources/card-tokens.d.mts.map +1 -0
  390. package/resources/card-tokens.d.ts +9 -10
  391. package/resources/card-tokens.d.ts.map +1 -1
  392. package/resources/card-tokens.js +20 -16
  393. package/resources/card-tokens.js.map +1 -1
  394. package/resources/card-tokens.mjs +19 -14
  395. package/resources/card-tokens.mjs.map +1 -1
  396. package/resources/card-validations.d.mts +513 -0
  397. package/resources/card-validations.d.mts.map +1 -0
  398. package/resources/card-validations.d.ts +9 -10
  399. package/resources/card-validations.d.ts.map +1 -1
  400. package/resources/card-validations.js +18 -14
  401. package/resources/card-validations.js.map +1 -1
  402. package/resources/card-validations.mjs +17 -12
  403. package/resources/card-validations.mjs.map +1 -1
  404. package/resources/cards.d.mts +486 -0
  405. package/resources/cards.d.mts.map +1 -0
  406. package/resources/cards.d.ts +13 -14
  407. package/resources/cards.d.ts.map +1 -1
  408. package/resources/cards.js +26 -22
  409. package/resources/cards.js.map +1 -1
  410. package/resources/cards.mjs +25 -20
  411. package/resources/cards.mjs.map +1 -1
  412. package/resources/check-deposits.d.mts +453 -0
  413. package/resources/check-deposits.d.mts.map +1 -0
  414. package/resources/check-deposits.d.ts +9 -10
  415. package/resources/check-deposits.d.ts.map +1 -1
  416. package/resources/check-deposits.js +18 -14
  417. package/resources/check-deposits.js.map +1 -1
  418. package/resources/check-deposits.mjs +17 -12
  419. package/resources/check-deposits.mjs.map +1 -1
  420. package/resources/check-transfers.d.mts +874 -0
  421. package/resources/check-transfers.d.mts.map +1 -0
  422. package/resources/check-transfers.d.ts +12 -13
  423. package/resources/check-transfers.d.ts.map +1 -1
  424. package/resources/check-transfers.js +24 -20
  425. package/resources/check-transfers.js.map +1 -1
  426. package/resources/check-transfers.mjs +23 -18
  427. package/resources/check-transfers.mjs.map +1 -1
  428. package/resources/declined-transactions.d.mts +1161 -0
  429. package/resources/declined-transactions.d.mts.map +1 -0
  430. package/resources/declined-transactions.d.ts +8 -9
  431. package/resources/declined-transactions.d.ts.map +1 -1
  432. package/resources/declined-transactions.js +21 -14
  433. package/resources/declined-transactions.js.map +1 -1
  434. package/resources/declined-transactions.mjs +20 -12
  435. package/resources/declined-transactions.mjs.map +1 -1
  436. package/resources/digital-card-profiles.d.mts +303 -0
  437. package/resources/digital-card-profiles.d.mts.map +1 -0
  438. package/resources/digital-card-profiles.d.ts +11 -12
  439. package/resources/digital-card-profiles.d.ts.map +1 -1
  440. package/resources/digital-card-profiles.js +25 -18
  441. package/resources/digital-card-profiles.js.map +1 -1
  442. package/resources/digital-card-profiles.mjs +24 -16
  443. package/resources/digital-card-profiles.mjs.map +1 -1
  444. package/resources/digital-wallet-tokens.d.mts +181 -0
  445. package/resources/digital-wallet-tokens.d.mts.map +1 -0
  446. package/resources/digital-wallet-tokens.d.ts +8 -9
  447. package/resources/digital-wallet-tokens.d.ts.map +1 -1
  448. package/resources/digital-wallet-tokens.js +18 -14
  449. package/resources/digital-wallet-tokens.js.map +1 -1
  450. package/resources/digital-wallet-tokens.mjs +17 -12
  451. package/resources/digital-wallet-tokens.mjs.map +1 -1
  452. package/resources/documents.d.mts +213 -0
  453. package/resources/documents.d.mts.map +1 -0
  454. package/resources/documents.d.ts +9 -10
  455. package/resources/documents.d.ts.map +1 -1
  456. package/resources/documents.js +18 -14
  457. package/resources/documents.js.map +1 -1
  458. package/resources/documents.mjs +17 -12
  459. package/resources/documents.mjs.map +1 -1
  460. package/resources/entities.d.mts +2759 -0
  461. package/resources/entities.d.mts.map +1 -0
  462. package/resources/entities.d.ts +17 -18
  463. package/resources/entities.d.ts.map +1 -1
  464. package/resources/entities.js +37 -30
  465. package/resources/entities.js.map +1 -1
  466. package/resources/entities.mjs +36 -28
  467. package/resources/entities.mjs.map +1 -1
  468. package/resources/event-subscriptions.d.mts +471 -0
  469. package/resources/event-subscriptions.d.mts.map +1 -0
  470. package/resources/event-subscriptions.d.ts +10 -11
  471. package/resources/event-subscriptions.d.ts.map +1 -1
  472. package/resources/event-subscriptions.js +20 -16
  473. package/resources/event-subscriptions.js.map +1 -1
  474. package/resources/event-subscriptions.mjs +19 -14
  475. package/resources/event-subscriptions.mjs.map +1 -1
  476. package/resources/events.d.mts +261 -0
  477. package/resources/events.d.mts.map +1 -0
  478. package/resources/events.d.ts +8 -9
  479. package/resources/events.d.ts.map +1 -1
  480. package/resources/events.js +18 -14
  481. package/resources/events.js.map +1 -1
  482. package/resources/events.mjs +17 -12
  483. package/resources/events.mjs.map +1 -1
  484. package/resources/exports.d.mts +440 -0
  485. package/resources/exports.d.mts.map +1 -0
  486. package/resources/exports.d.ts +9 -10
  487. package/resources/exports.d.ts.map +1 -1
  488. package/resources/exports.js +18 -14
  489. package/resources/exports.js.map +1 -1
  490. package/resources/exports.mjs +17 -12
  491. package/resources/exports.mjs.map +1 -1
  492. package/resources/external-accounts.d.mts +212 -0
  493. package/resources/external-accounts.d.mts.map +1 -0
  494. package/resources/external-accounts.d.ts +10 -11
  495. package/resources/external-accounts.d.ts.map +1 -1
  496. package/resources/external-accounts.js +20 -16
  497. package/resources/external-accounts.js.map +1 -1
  498. package/resources/external-accounts.mjs +19 -14
  499. package/resources/external-accounts.mjs.map +1 -1
  500. package/resources/fednow-transfers.d.mts +474 -0
  501. package/resources/fednow-transfers.d.mts.map +1 -0
  502. package/resources/fednow-transfers.d.ts +11 -12
  503. package/resources/fednow-transfers.d.ts.map +1 -1
  504. package/resources/fednow-transfers.js +22 -18
  505. package/resources/fednow-transfers.js.map +1 -1
  506. package/resources/fednow-transfers.mjs +21 -16
  507. package/resources/fednow-transfers.mjs.map +1 -1
  508. package/resources/file-links.d.mts +72 -0
  509. package/resources/file-links.d.mts.map +1 -0
  510. package/resources/file-links.d.ts +4 -3
  511. package/resources/file-links.d.ts.map +1 -1
  512. package/resources/file-links.js +1 -1
  513. package/resources/file-links.js.map +1 -1
  514. package/resources/file-links.mjs +1 -1
  515. package/resources/file-links.mjs.map +1 -1
  516. package/resources/files.d.mts +242 -0
  517. package/resources/files.d.mts.map +1 -0
  518. package/resources/files.d.ts +11 -11
  519. package/resources/files.d.ts.map +1 -1
  520. package/resources/files.js +20 -39
  521. package/resources/files.js.map +1 -1
  522. package/resources/files.mjs +19 -14
  523. package/resources/files.mjs.map +1 -1
  524. package/resources/groups.d.mts +54 -0
  525. package/resources/groups.d.mts.map +1 -0
  526. package/resources/groups.d.ts +4 -3
  527. package/resources/groups.d.ts.map +1 -1
  528. package/resources/groups.js +1 -1
  529. package/resources/groups.js.map +1 -1
  530. package/resources/groups.mjs +1 -1
  531. package/resources/groups.mjs.map +1 -1
  532. package/resources/inbound-ach-transfers.d.mts +704 -0
  533. package/resources/inbound-ach-transfers.d.mts.map +1 -0
  534. package/resources/inbound-ach-transfers.d.ts +11 -12
  535. package/resources/inbound-ach-transfers.d.ts.map +1 -1
  536. package/resources/inbound-ach-transfers.js +27 -23
  537. package/resources/inbound-ach-transfers.js.map +1 -1
  538. package/resources/inbound-ach-transfers.mjs +26 -21
  539. package/resources/inbound-ach-transfers.mjs.map +1 -1
  540. package/resources/inbound-check-deposits.d.mts +278 -0
  541. package/resources/inbound-check-deposits.d.mts.map +1 -0
  542. package/resources/inbound-check-deposits.d.ts +10 -11
  543. package/resources/inbound-check-deposits.d.ts.map +1 -1
  544. package/resources/inbound-check-deposits.js +25 -18
  545. package/resources/inbound-check-deposits.js.map +1 -1
  546. package/resources/inbound-check-deposits.mjs +24 -16
  547. package/resources/inbound-check-deposits.mjs.map +1 -1
  548. package/resources/inbound-fednow-transfers.d.mts +188 -0
  549. package/resources/inbound-fednow-transfers.d.mts.map +1 -0
  550. package/resources/inbound-fednow-transfers.d.ts +8 -9
  551. package/resources/inbound-fednow-transfers.d.ts.map +1 -1
  552. package/resources/inbound-fednow-transfers.js +18 -14
  553. package/resources/inbound-fednow-transfers.js.map +1 -1
  554. package/resources/inbound-fednow-transfers.mjs +17 -12
  555. package/resources/inbound-fednow-transfers.mjs.map +1 -1
  556. package/resources/inbound-mail-items.d.mts +187 -0
  557. package/resources/inbound-mail-items.d.mts.map +1 -0
  558. package/resources/inbound-mail-items.d.ts +9 -10
  559. package/resources/inbound-mail-items.d.ts.map +1 -1
  560. package/resources/inbound-mail-items.js +20 -16
  561. package/resources/inbound-mail-items.js.map +1 -1
  562. package/resources/inbound-mail-items.mjs +19 -14
  563. package/resources/inbound-mail-items.mjs.map +1 -1
  564. package/resources/inbound-real-time-payments-transfers.d.mts +192 -0
  565. package/resources/inbound-real-time-payments-transfers.d.mts.map +1 -0
  566. package/resources/inbound-real-time-payments-transfers.d.ts +8 -9
  567. package/resources/inbound-real-time-payments-transfers.d.ts.map +1 -1
  568. package/resources/inbound-real-time-payments-transfers.js +18 -14
  569. package/resources/inbound-real-time-payments-transfers.js.map +1 -1
  570. package/resources/inbound-real-time-payments-transfers.mjs +17 -12
  571. package/resources/inbound-real-time-payments-transfers.mjs.map +1 -1
  572. package/resources/inbound-wire-drawdown-requests.d.mts +138 -0
  573. package/resources/inbound-wire-drawdown-requests.d.mts.map +1 -0
  574. package/resources/inbound-wire-drawdown-requests.d.ts +8 -9
  575. package/resources/inbound-wire-drawdown-requests.d.ts.map +1 -1
  576. package/resources/inbound-wire-drawdown-requests.js +18 -14
  577. package/resources/inbound-wire-drawdown-requests.js.map +1 -1
  578. package/resources/inbound-wire-drawdown-requests.mjs +17 -12
  579. package/resources/inbound-wire-drawdown-requests.mjs.map +1 -1
  580. package/resources/inbound-wire-transfers.d.mts +245 -0
  581. package/resources/inbound-wire-transfers.d.mts.map +1 -0
  582. package/resources/inbound-wire-transfers.d.ts +9 -10
  583. package/resources/inbound-wire-transfers.d.ts.map +1 -1
  584. package/resources/inbound-wire-transfers.js +20 -16
  585. package/resources/inbound-wire-transfers.js.map +1 -1
  586. package/resources/inbound-wire-transfers.mjs +19 -14
  587. package/resources/inbound-wire-transfers.mjs.map +1 -1
  588. package/resources/index.d.mts +58 -0
  589. package/resources/index.d.mts.map +1 -0
  590. package/resources/index.d.ts +51 -52
  591. package/resources/index.d.ts.map +1 -1
  592. package/resources/index.js +4 -58
  593. package/resources/index.js.map +1 -1
  594. package/resources/index.mjs +51 -52
  595. package/resources/index.mjs.map +1 -1
  596. package/resources/intrafi-account-enrollments.d.mts +153 -0
  597. package/resources/intrafi-account-enrollments.d.mts.map +1 -0
  598. package/resources/intrafi-account-enrollments.d.ts +10 -11
  599. package/resources/intrafi-account-enrollments.d.ts.map +1 -1
  600. package/resources/intrafi-account-enrollments.js +20 -16
  601. package/resources/intrafi-account-enrollments.js.map +1 -1
  602. package/resources/intrafi-account-enrollments.mjs +19 -14
  603. package/resources/intrafi-account-enrollments.mjs.map +1 -1
  604. package/resources/intrafi-balances.d.mts +101 -0
  605. package/resources/intrafi-balances.d.mts.map +1 -0
  606. package/resources/intrafi-balances.d.ts +4 -3
  607. package/resources/intrafi-balances.d.ts.map +1 -1
  608. package/resources/intrafi-balances.js +4 -3
  609. package/resources/intrafi-balances.js.map +1 -1
  610. package/resources/intrafi-balances.mjs +4 -3
  611. package/resources/intrafi-balances.mjs.map +1 -1
  612. package/resources/intrafi-exclusions.d.mts +141 -0
  613. package/resources/intrafi-exclusions.d.mts.map +1 -0
  614. package/resources/intrafi-exclusions.d.ts +10 -11
  615. package/resources/intrafi-exclusions.d.ts.map +1 -1
  616. package/resources/intrafi-exclusions.js +20 -16
  617. package/resources/intrafi-exclusions.js.map +1 -1
  618. package/resources/intrafi-exclusions.mjs +19 -14
  619. package/resources/intrafi-exclusions.mjs.map +1 -1
  620. package/resources/lockboxes.d.mts +215 -0
  621. package/resources/lockboxes.d.mts.map +1 -0
  622. package/resources/lockboxes.d.ts +10 -11
  623. package/resources/lockboxes.d.ts.map +1 -1
  624. package/resources/lockboxes.js +20 -16
  625. package/resources/lockboxes.js.map +1 -1
  626. package/resources/lockboxes.mjs +19 -14
  627. package/resources/lockboxes.mjs.map +1 -1
  628. package/resources/oauth-applications.d.mts +113 -0
  629. package/resources/oauth-applications.d.mts.map +1 -0
  630. package/resources/oauth-applications.d.ts +8 -9
  631. package/resources/oauth-applications.d.ts.map +1 -1
  632. package/resources/oauth-applications.js +18 -14
  633. package/resources/oauth-applications.js.map +1 -1
  634. package/resources/oauth-applications.mjs +17 -12
  635. package/resources/oauth-applications.mjs.map +1 -1
  636. package/resources/oauth-connections.d.mts +94 -0
  637. package/resources/oauth-connections.d.mts.map +1 -0
  638. package/resources/oauth-connections.d.ts +8 -9
  639. package/resources/oauth-connections.d.ts.map +1 -1
  640. package/resources/oauth-connections.js +18 -14
  641. package/resources/oauth-connections.js.map +1 -1
  642. package/resources/oauth-connections.mjs +17 -12
  643. package/resources/oauth-connections.mjs.map +1 -1
  644. package/resources/oauth-tokens.d.mts +77 -0
  645. package/resources/oauth-tokens.d.mts.map +1 -0
  646. package/resources/oauth-tokens.d.ts +4 -3
  647. package/resources/oauth-tokens.d.ts.map +1 -1
  648. package/resources/oauth-tokens.js +1 -1
  649. package/resources/oauth-tokens.js.map +1 -1
  650. package/resources/oauth-tokens.mjs +1 -1
  651. package/resources/oauth-tokens.mjs.map +1 -1
  652. package/resources/pending-transactions.d.mts +1182 -0
  653. package/resources/pending-transactions.d.mts.map +1 -0
  654. package/resources/pending-transactions.d.ts +10 -11
  655. package/resources/pending-transactions.d.ts.map +1 -1
  656. package/resources/pending-transactions.js +20 -16
  657. package/resources/pending-transactions.js.map +1 -1
  658. package/resources/pending-transactions.mjs +19 -14
  659. package/resources/pending-transactions.mjs.map +1 -1
  660. package/resources/physical-card-profiles.d.mts +268 -0
  661. package/resources/physical-card-profiles.d.mts.map +1 -0
  662. package/resources/physical-card-profiles.d.ts +11 -12
  663. package/resources/physical-card-profiles.d.ts.map +1 -1
  664. package/resources/physical-card-profiles.js +25 -18
  665. package/resources/physical-card-profiles.js.map +1 -1
  666. package/resources/physical-card-profiles.mjs +24 -16
  667. package/resources/physical-card-profiles.mjs.map +1 -1
  668. package/resources/physical-cards.d.mts +455 -0
  669. package/resources/physical-cards.d.mts.map +1 -0
  670. package/resources/physical-cards.d.ts +10 -11
  671. package/resources/physical-cards.d.ts.map +1 -1
  672. package/resources/physical-cards.js +20 -16
  673. package/resources/physical-cards.js.map +1 -1
  674. package/resources/physical-cards.mjs +19 -14
  675. package/resources/physical-cards.mjs.map +1 -1
  676. package/resources/programs.d.mts +89 -0
  677. package/resources/programs.d.mts.map +1 -0
  678. package/resources/programs.d.ts +8 -9
  679. package/resources/programs.d.ts.map +1 -1
  680. package/resources/programs.js +18 -14
  681. package/resources/programs.js.map +1 -1
  682. package/resources/programs.mjs +17 -12
  683. package/resources/programs.mjs.map +1 -1
  684. package/resources/real-time-decisions.d.mts +1132 -0
  685. package/resources/real-time-decisions.d.mts.map +1 -0
  686. package/resources/real-time-decisions.d.ts +5 -4
  687. package/resources/real-time-decisions.d.ts.map +1 -1
  688. package/resources/real-time-decisions.js +6 -5
  689. package/resources/real-time-decisions.js.map +1 -1
  690. package/resources/real-time-decisions.mjs +6 -5
  691. package/resources/real-time-decisions.mjs.map +1 -1
  692. package/resources/real-time-payments-transfers.d.mts +504 -0
  693. package/resources/real-time-payments-transfers.d.mts.map +1 -0
  694. package/resources/real-time-payments-transfers.d.ts +11 -12
  695. package/resources/real-time-payments-transfers.d.ts.map +1 -1
  696. package/resources/real-time-payments-transfers.js +22 -18
  697. package/resources/real-time-payments-transfers.js.map +1 -1
  698. package/resources/real-time-payments-transfers.mjs +21 -16
  699. package/resources/real-time-payments-transfers.mjs.map +1 -1
  700. package/resources/routing-numbers.d.mts +79 -0
  701. package/resources/routing-numbers.d.mts.map +1 -0
  702. package/resources/routing-numbers.d.ts +6 -7
  703. package/resources/routing-numbers.d.ts.map +1 -1
  704. package/resources/routing-numbers.js +7 -8
  705. package/resources/routing-numbers.js.map +1 -1
  706. package/resources/routing-numbers.mjs +6 -6
  707. package/resources/routing-numbers.mjs.map +1 -1
  708. package/resources/simulations/account-statements.d.mts +29 -0
  709. package/resources/simulations/account-statements.d.mts.map +1 -0
  710. package/resources/simulations/account-statements.d.ts +4 -3
  711. package/resources/simulations/account-statements.d.ts.map +1 -1
  712. package/resources/simulations/account-statements.js +1 -1
  713. package/resources/simulations/account-statements.js.map +1 -1
  714. package/resources/simulations/account-statements.mjs +1 -1
  715. package/resources/simulations/account-statements.mjs.map +1 -1
  716. package/resources/simulations/account-transfers.d.mts +22 -0
  717. package/resources/simulations/account-transfers.d.mts.map +1 -0
  718. package/resources/simulations/account-transfers.d.ts +4 -3
  719. package/resources/simulations/account-transfers.d.ts.map +1 -1
  720. package/resources/simulations/account-transfers.js +4 -3
  721. package/resources/simulations/account-transfers.js.map +1 -1
  722. package/resources/simulations/account-transfers.mjs +4 -3
  723. package/resources/simulations/account-transfers.mjs.map +1 -1
  724. package/resources/simulations/ach-transfers.d.mts +307 -0
  725. package/resources/simulations/ach-transfers.d.mts.map +1 -0
  726. package/resources/simulations/ach-transfers.d.ts +8 -7
  727. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  728. package/resources/simulations/ach-transfers.js +12 -14
  729. package/resources/simulations/ach-transfers.js.map +1 -1
  730. package/resources/simulations/ach-transfers.mjs +12 -14
  731. package/resources/simulations/ach-transfers.mjs.map +1 -1
  732. package/resources/simulations/card-authorization-expirations.d.mts +30 -0
  733. package/resources/simulations/card-authorization-expirations.d.mts.map +1 -0
  734. package/resources/simulations/card-authorization-expirations.d.ts +4 -3
  735. package/resources/simulations/card-authorization-expirations.d.ts.map +1 -1
  736. package/resources/simulations/card-authorization-expirations.js +1 -1
  737. package/resources/simulations/card-authorization-expirations.js.map +1 -1
  738. package/resources/simulations/card-authorization-expirations.mjs +1 -1
  739. package/resources/simulations/card-authorization-expirations.mjs.map +1 -1
  740. package/resources/simulations/card-authorizations.d.mts +244 -0
  741. package/resources/simulations/card-authorizations.d.mts.map +1 -0
  742. package/resources/simulations/card-authorizations.d.ts +4 -3
  743. package/resources/simulations/card-authorizations.d.ts.map +1 -1
  744. package/resources/simulations/card-authorizations.js +1 -1
  745. package/resources/simulations/card-authorizations.js.map +1 -1
  746. package/resources/simulations/card-authorizations.mjs +1 -1
  747. package/resources/simulations/card-authorizations.mjs.map +1 -1
  748. package/resources/simulations/card-disputes.d.mts +192 -0
  749. package/resources/simulations/card-disputes.d.mts.map +1 -0
  750. package/resources/simulations/card-disputes.d.ts +4 -3
  751. package/resources/simulations/card-disputes.d.ts.map +1 -1
  752. package/resources/simulations/card-disputes.js +4 -3
  753. package/resources/simulations/card-disputes.js.map +1 -1
  754. package/resources/simulations/card-disputes.mjs +4 -3
  755. package/resources/simulations/card-disputes.mjs.map +1 -1
  756. package/resources/simulations/card-fuel-confirmations.d.mts +36 -0
  757. package/resources/simulations/card-fuel-confirmations.d.mts.map +1 -0
  758. package/resources/simulations/card-fuel-confirmations.d.ts +4 -3
  759. package/resources/simulations/card-fuel-confirmations.d.ts.map +1 -1
  760. package/resources/simulations/card-fuel-confirmations.js +1 -1
  761. package/resources/simulations/card-fuel-confirmations.js.map +1 -1
  762. package/resources/simulations/card-fuel-confirmations.mjs +1 -1
  763. package/resources/simulations/card-fuel-confirmations.mjs.map +1 -1
  764. package/resources/simulations/card-increments.d.mts +41 -0
  765. package/resources/simulations/card-increments.d.mts.map +1 -0
  766. package/resources/simulations/card-increments.d.ts +4 -3
  767. package/resources/simulations/card-increments.d.ts.map +1 -1
  768. package/resources/simulations/card-increments.js +1 -1
  769. package/resources/simulations/card-increments.js.map +1 -1
  770. package/resources/simulations/card-increments.mjs +1 -1
  771. package/resources/simulations/card-increments.mjs.map +1 -1
  772. package/resources/simulations/card-refunds.d.mts +39 -0
  773. package/resources/simulations/card-refunds.d.mts.map +1 -0
  774. package/resources/simulations/card-refunds.d.ts +4 -3
  775. package/resources/simulations/card-refunds.d.ts.map +1 -1
  776. package/resources/simulations/card-refunds.js +1 -1
  777. package/resources/simulations/card-refunds.js.map +1 -1
  778. package/resources/simulations/card-refunds.mjs +1 -1
  779. package/resources/simulations/card-refunds.mjs.map +1 -1
  780. package/resources/simulations/card-reversals.d.mts +36 -0
  781. package/resources/simulations/card-reversals.d.mts.map +1 -0
  782. package/resources/simulations/card-reversals.d.ts +4 -3
  783. package/resources/simulations/card-reversals.d.ts.map +1 -1
  784. package/resources/simulations/card-reversals.js +1 -1
  785. package/resources/simulations/card-reversals.js.map +1 -1
  786. package/resources/simulations/card-reversals.mjs +1 -1
  787. package/resources/simulations/card-reversals.mjs.map +1 -1
  788. package/resources/simulations/card-settlements.d.mts +44 -0
  789. package/resources/simulations/card-settlements.d.mts.map +1 -0
  790. package/resources/simulations/card-settlements.d.ts +4 -3
  791. package/resources/simulations/card-settlements.d.ts.map +1 -1
  792. package/resources/simulations/card-settlements.js +1 -1
  793. package/resources/simulations/card-settlements.js.map +1 -1
  794. package/resources/simulations/card-settlements.mjs +1 -1
  795. package/resources/simulations/card-settlements.mjs.map +1 -1
  796. package/resources/simulations/card-tokens.d.mts +67 -0
  797. package/resources/simulations/card-tokens.d.mts.map +1 -0
  798. package/resources/simulations/card-tokens.d.ts +4 -3
  799. package/resources/simulations/card-tokens.d.ts.map +1 -1
  800. package/resources/simulations/card-tokens.js +1 -1
  801. package/resources/simulations/card-tokens.js.map +1 -1
  802. package/resources/simulations/card-tokens.mjs +1 -1
  803. package/resources/simulations/card-tokens.mjs.map +1 -1
  804. package/resources/simulations/check-deposits.d.mts +47 -0
  805. package/resources/simulations/check-deposits.d.mts.map +1 -0
  806. package/resources/simulations/check-deposits.d.ts +6 -5
  807. package/resources/simulations/check-deposits.d.ts.map +1 -1
  808. package/resources/simulations/check-deposits.js +8 -7
  809. package/resources/simulations/check-deposits.js.map +1 -1
  810. package/resources/simulations/check-deposits.mjs +8 -7
  811. package/resources/simulations/check-deposits.mjs.map +1 -1
  812. package/resources/simulations/check-transfers.d.mts +22 -0
  813. package/resources/simulations/check-transfers.d.mts.map +1 -0
  814. package/resources/simulations/check-transfers.d.ts +4 -3
  815. package/resources/simulations/check-transfers.d.ts.map +1 -1
  816. package/resources/simulations/check-transfers.js +4 -3
  817. package/resources/simulations/check-transfers.js.map +1 -1
  818. package/resources/simulations/check-transfers.mjs +4 -3
  819. package/resources/simulations/check-transfers.mjs.map +1 -1
  820. package/resources/simulations/digital-wallet-token-requests.d.mts +55 -0
  821. package/resources/simulations/digital-wallet-token-requests.d.mts.map +1 -0
  822. package/resources/simulations/digital-wallet-token-requests.d.ts +4 -3
  823. package/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -1
  824. package/resources/simulations/digital-wallet-token-requests.js +1 -1
  825. package/resources/simulations/digital-wallet-token-requests.js.map +1 -1
  826. package/resources/simulations/digital-wallet-token-requests.mjs +1 -1
  827. package/resources/simulations/digital-wallet-token-requests.mjs.map +1 -1
  828. package/resources/simulations/documents.d.mts +27 -0
  829. package/resources/simulations/documents.d.mts.map +1 -0
  830. package/resources/simulations/documents.d.ts +4 -3
  831. package/resources/simulations/documents.d.ts.map +1 -1
  832. package/resources/simulations/documents.js +1 -1
  833. package/resources/simulations/documents.js.map +1 -1
  834. package/resources/simulations/documents.mjs +1 -1
  835. package/resources/simulations/documents.mjs.map +1 -1
  836. package/resources/simulations/inbound-ach-transfers.d.mts +140 -0
  837. package/resources/simulations/inbound-ach-transfers.d.mts.map +1 -0
  838. package/resources/simulations/inbound-ach-transfers.d.ts +4 -3
  839. package/resources/simulations/inbound-ach-transfers.d.ts.map +1 -1
  840. package/resources/simulations/inbound-ach-transfers.js +1 -1
  841. package/resources/simulations/inbound-ach-transfers.js.map +1 -1
  842. package/resources/simulations/inbound-ach-transfers.mjs +1 -1
  843. package/resources/simulations/inbound-ach-transfers.mjs.map +1 -1
  844. package/resources/simulations/inbound-check-deposits.d.mts +56 -0
  845. package/resources/simulations/inbound-check-deposits.d.mts.map +1 -0
  846. package/resources/simulations/inbound-check-deposits.d.ts +4 -3
  847. package/resources/simulations/inbound-check-deposits.d.ts.map +1 -1
  848. package/resources/simulations/inbound-check-deposits.js +1 -1
  849. package/resources/simulations/inbound-check-deposits.js.map +1 -1
  850. package/resources/simulations/inbound-check-deposits.mjs +1 -1
  851. package/resources/simulations/inbound-check-deposits.mjs.map +1 -1
  852. package/resources/simulations/inbound-fednow-transfers.d.mts +51 -0
  853. package/resources/simulations/inbound-fednow-transfers.d.mts.map +1 -0
  854. package/resources/simulations/inbound-fednow-transfers.d.ts +4 -3
  855. package/resources/simulations/inbound-fednow-transfers.d.ts.map +1 -1
  856. package/resources/simulations/inbound-fednow-transfers.js +1 -1
  857. package/resources/simulations/inbound-fednow-transfers.js.map +1 -1
  858. package/resources/simulations/inbound-fednow-transfers.mjs +1 -1
  859. package/resources/simulations/inbound-fednow-transfers.mjs.map +1 -1
  860. package/resources/simulations/inbound-mail-items.d.mts +39 -0
  861. package/resources/simulations/inbound-mail-items.d.mts.map +1 -0
  862. package/resources/simulations/inbound-mail-items.d.ts +4 -3
  863. package/resources/simulations/inbound-mail-items.d.ts.map +1 -1
  864. package/resources/simulations/inbound-mail-items.js +1 -1
  865. package/resources/simulations/inbound-mail-items.js.map +1 -1
  866. package/resources/simulations/inbound-mail-items.mjs +1 -1
  867. package/resources/simulations/inbound-mail-items.mjs.map +1 -1
  868. package/resources/simulations/inbound-real-time-payments-transfers.d.mts +59 -0
  869. package/resources/simulations/inbound-real-time-payments-transfers.d.mts.map +1 -0
  870. package/resources/simulations/inbound-real-time-payments-transfers.d.ts +4 -3
  871. package/resources/simulations/inbound-real-time-payments-transfers.d.ts.map +1 -1
  872. package/resources/simulations/inbound-real-time-payments-transfers.js +1 -1
  873. package/resources/simulations/inbound-real-time-payments-transfers.js.map +1 -1
  874. package/resources/simulations/inbound-real-time-payments-transfers.mjs +1 -1
  875. package/resources/simulations/inbound-real-time-payments-transfers.mjs.map +1 -1
  876. package/resources/simulations/inbound-wire-drawdown-requests.d.mts +117 -0
  877. package/resources/simulations/inbound-wire-drawdown-requests.d.mts.map +1 -0
  878. package/resources/simulations/inbound-wire-drawdown-requests.d.ts +4 -3
  879. package/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -1
  880. package/resources/simulations/inbound-wire-drawdown-requests.js +1 -1
  881. package/resources/simulations/inbound-wire-drawdown-requests.js.map +1 -1
  882. package/resources/simulations/inbound-wire-drawdown-requests.mjs +1 -1
  883. package/resources/simulations/inbound-wire-drawdown-requests.mjs.map +1 -1
  884. package/resources/simulations/inbound-wire-transfers.d.mts +104 -0
  885. package/resources/simulations/inbound-wire-transfers.d.mts.map +1 -0
  886. package/resources/simulations/inbound-wire-transfers.d.ts +4 -3
  887. package/resources/simulations/inbound-wire-transfers.d.ts.map +1 -1
  888. package/resources/simulations/inbound-wire-transfers.js +1 -1
  889. package/resources/simulations/inbound-wire-transfers.js.map +1 -1
  890. package/resources/simulations/inbound-wire-transfers.mjs +1 -1
  891. package/resources/simulations/inbound-wire-transfers.mjs.map +1 -1
  892. package/resources/simulations/index.d.mts +32 -0
  893. package/resources/simulations/index.d.mts.map +1 -0
  894. package/resources/simulations/index.d.ts.map +1 -1
  895. package/resources/simulations/interest-payments.d.mts +46 -0
  896. package/resources/simulations/interest-payments.d.mts.map +1 -0
  897. package/resources/simulations/interest-payments.d.ts +4 -3
  898. package/resources/simulations/interest-payments.d.ts.map +1 -1
  899. package/resources/simulations/interest-payments.js +1 -1
  900. package/resources/simulations/interest-payments.js.map +1 -1
  901. package/resources/simulations/interest-payments.mjs +1 -1
  902. package/resources/simulations/interest-payments.mjs.map +1 -1
  903. package/resources/simulations/pending-transactions.d.mts +20 -0
  904. package/resources/simulations/pending-transactions.d.mts.map +1 -0
  905. package/resources/simulations/pending-transactions.d.ts +4 -3
  906. package/resources/simulations/pending-transactions.d.ts.map +1 -1
  907. package/resources/simulations/pending-transactions.js +4 -3
  908. package/resources/simulations/pending-transactions.js.map +1 -1
  909. package/resources/simulations/pending-transactions.mjs +4 -3
  910. package/resources/simulations/pending-transactions.mjs.map +1 -1
  911. package/resources/simulations/physical-cards.d.mts +88 -0
  912. package/resources/simulations/physical-cards.d.mts.map +1 -0
  913. package/resources/simulations/physical-cards.d.ts +5 -4
  914. package/resources/simulations/physical-cards.d.ts.map +1 -1
  915. package/resources/simulations/physical-cards.js +6 -5
  916. package/resources/simulations/physical-cards.js.map +1 -1
  917. package/resources/simulations/physical-cards.mjs +6 -5
  918. package/resources/simulations/physical-cards.mjs.map +1 -1
  919. package/resources/simulations/programs.d.mts +46 -0
  920. package/resources/simulations/programs.d.mts.map +1 -0
  921. package/resources/simulations/programs.d.ts +4 -3
  922. package/resources/simulations/programs.d.ts.map +1 -1
  923. package/resources/simulations/programs.js +1 -1
  924. package/resources/simulations/programs.js.map +1 -1
  925. package/resources/simulations/programs.mjs +1 -1
  926. package/resources/simulations/programs.mjs.map +1 -1
  927. package/resources/simulations/real-time-payments-transfers.d.mts +91 -0
  928. package/resources/simulations/real-time-payments-transfers.d.mts.map +1 -0
  929. package/resources/simulations/real-time-payments-transfers.d.ts +4 -3
  930. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  931. package/resources/simulations/real-time-payments-transfers.js +4 -3
  932. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  933. package/resources/simulations/real-time-payments-transfers.mjs +4 -3
  934. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  935. package/resources/simulations/simulations.d.mts +126 -0
  936. package/resources/simulations/simulations.d.mts.map +1 -0
  937. package/resources/simulations/simulations.d.ts +1 -1
  938. package/resources/simulations/simulations.d.ts.map +1 -1
  939. package/resources/simulations/simulations.js +32 -54
  940. package/resources/simulations/simulations.js.map +1 -1
  941. package/resources/simulations/simulations.mjs +1 -1
  942. package/resources/simulations/wire-drawdown-requests.d.mts +31 -0
  943. package/resources/simulations/wire-drawdown-requests.d.mts.map +1 -0
  944. package/resources/simulations/wire-drawdown-requests.d.ts +5 -4
  945. package/resources/simulations/wire-drawdown-requests.d.ts.map +1 -1
  946. package/resources/simulations/wire-drawdown-requests.js +6 -5
  947. package/resources/simulations/wire-drawdown-requests.js.map +1 -1
  948. package/resources/simulations/wire-drawdown-requests.mjs +6 -5
  949. package/resources/simulations/wire-drawdown-requests.mjs.map +1 -1
  950. package/resources/simulations/wire-transfers.d.mts +36 -0
  951. package/resources/simulations/wire-transfers.d.mts.map +1 -0
  952. package/resources/simulations/wire-transfers.d.ts +5 -4
  953. package/resources/simulations/wire-transfers.d.ts.map +1 -1
  954. package/resources/simulations/wire-transfers.js +6 -5
  955. package/resources/simulations/wire-transfers.js.map +1 -1
  956. package/resources/simulations/wire-transfers.mjs +6 -5
  957. package/resources/simulations/wire-transfers.mjs.map +1 -1
  958. package/resources/simulations.d.mts +2 -0
  959. package/resources/simulations.d.mts.map +1 -0
  960. package/resources/simulations.d.ts.map +1 -1
  961. package/resources/simulations.js +2 -15
  962. package/resources/simulations.js.map +1 -1
  963. package/resources/supplemental-documents.d.mts +92 -0
  964. package/resources/supplemental-documents.d.mts.map +1 -0
  965. package/resources/supplemental-documents.d.ts +8 -8
  966. package/resources/supplemental-documents.d.ts.map +1 -1
  967. package/resources/supplemental-documents.js +4 -8
  968. package/resources/supplemental-documents.js.map +1 -1
  969. package/resources/supplemental-documents.mjs +3 -6
  970. package/resources/supplemental-documents.mjs.map +1 -1
  971. package/resources/transactions.d.mts +3483 -0
  972. package/resources/transactions.d.mts.map +1 -0
  973. package/resources/transactions.d.ts +8 -9
  974. package/resources/transactions.d.ts.map +1 -1
  975. package/resources/transactions.js +18 -14
  976. package/resources/transactions.js.map +1 -1
  977. package/resources/transactions.mjs +17 -12
  978. package/resources/transactions.mjs.map +1 -1
  979. package/resources/wire-drawdown-requests.d.mts +362 -0
  980. package/resources/wire-drawdown-requests.d.mts.map +1 -0
  981. package/resources/wire-drawdown-requests.d.ts +9 -10
  982. package/resources/wire-drawdown-requests.d.ts.map +1 -1
  983. package/resources/wire-drawdown-requests.js +18 -14
  984. package/resources/wire-drawdown-requests.js.map +1 -1
  985. package/resources/wire-drawdown-requests.mjs +17 -12
  986. package/resources/wire-drawdown-requests.mjs.map +1 -1
  987. package/resources/wire-transfers.d.mts +751 -0
  988. package/resources/wire-transfers.d.mts.map +1 -0
  989. package/resources/wire-transfers.d.ts +11 -12
  990. package/resources/wire-transfers.d.ts.map +1 -1
  991. package/resources/wire-transfers.js +22 -18
  992. package/resources/wire-transfers.js.map +1 -1
  993. package/resources/wire-transfers.mjs +21 -16
  994. package/resources/wire-transfers.mjs.map +1 -1
  995. package/resources.d.mts +2 -0
  996. package/resources.d.mts.map +1 -0
  997. package/resources.d.ts.map +1 -1
  998. package/resources.js +2 -15
  999. package/resources.js.map +1 -1
  1000. package/src/api-promise.ts +2 -0
  1001. package/src/client.ts +1692 -0
  1002. package/src/core/README.md +3 -0
  1003. package/src/core/api-promise.ts +92 -0
  1004. package/src/core/error.ts +443 -0
  1005. package/src/core/pagination.ts +165 -0
  1006. package/src/core/resource.ts +11 -0
  1007. package/src/core/uploads.ts +2 -0
  1008. package/src/error.ts +2 -443
  1009. package/src/index.ts +6 -1199
  1010. package/src/internal/README.md +3 -0
  1011. package/src/internal/builtin-types.ts +93 -0
  1012. package/src/internal/detect-platform.ts +196 -0
  1013. package/src/internal/errors.ts +33 -0
  1014. package/src/internal/headers.ts +97 -0
  1015. package/src/internal/parse.ts +50 -0
  1016. package/src/internal/qs/formats.ts +2 -1
  1017. package/src/internal/qs/stringify.ts +17 -20
  1018. package/src/internal/qs/utils.ts +14 -14
  1019. package/src/internal/request-options.ts +91 -0
  1020. package/src/internal/shim-types.ts +26 -0
  1021. package/src/internal/shims.ts +107 -0
  1022. package/src/internal/to-file.ts +154 -0
  1023. package/src/internal/types.ts +95 -0
  1024. package/src/internal/uploads.ts +187 -0
  1025. package/src/internal/utils/base64.ts +40 -0
  1026. package/src/internal/utils/bytes.ts +32 -0
  1027. package/src/internal/utils/env.ts +18 -0
  1028. package/src/internal/utils/log.ts +126 -0
  1029. package/src/internal/utils/path.ts +88 -0
  1030. package/src/internal/utils/sleep.ts +3 -0
  1031. package/src/internal/utils/uuid.ts +17 -0
  1032. package/src/internal/utils/values.ts +105 -0
  1033. package/src/internal/utils.ts +8 -0
  1034. package/src/pagination.ts +2 -68
  1035. package/src/resource.ts +2 -11
  1036. package/src/resources/account-numbers.ts +18 -27
  1037. package/src/resources/account-statements.ts +13 -22
  1038. package/src/resources/account-transfers.ts +18 -27
  1039. package/src/resources/accounts.ts +23 -42
  1040. package/src/resources/ach-prenotifications.ts +14 -26
  1041. package/src/resources/ach-transfers.ts +18 -27
  1042. package/src/resources/bookkeeping-accounts.ts +24 -45
  1043. package/src/resources/bookkeeping-entries.ts +13 -22
  1044. package/src/resources/bookkeeping-entry-sets.ts +14 -29
  1045. package/src/resources/card-disputes.ts +23 -29
  1046. package/src/resources/card-payments.ts +13 -22
  1047. package/src/resources/card-purchase-supplements.ts +13 -25
  1048. package/src/resources/card-push-transfers.ts +18 -30
  1049. package/src/resources/card-tokens.ts +15 -24
  1050. package/src/resources/card-validations.ts +14 -23
  1051. package/src/resources/cards.ts +24 -34
  1052. package/src/resources/check-deposits.ts +14 -23
  1053. package/src/resources/check-transfers.ts +22 -31
  1054. package/src/resources/declined-transactions.ts +16 -25
  1055. package/src/resources/digital-card-profiles.ts +23 -32
  1056. package/src/resources/digital-wallet-tokens.ts +13 -22
  1057. package/src/resources/documents.ts +14 -20
  1058. package/src/resources/entities.ts +43 -50
  1059. package/src/resources/event-subscriptions.ts +18 -30
  1060. package/src/resources/events.ts +13 -19
  1061. package/src/resources/exports.ts +14 -20
  1062. package/src/resources/external-accounts.ts +18 -27
  1063. package/src/resources/fednow-transfers.ts +18 -27
  1064. package/src/resources/file-links.ts +4 -3
  1065. package/src/resources/files.ts +18 -22
  1066. package/src/resources/groups.ts +4 -3
  1067. package/src/resources/inbound-ach-transfers.ts +31 -37
  1068. package/src/resources/inbound-check-deposits.ts +22 -34
  1069. package/src/resources/inbound-fednow-transfers.ts +13 -25
  1070. package/src/resources/inbound-mail-items.ts +17 -26
  1071. package/src/resources/inbound-real-time-payments-transfers.ts +15 -26
  1072. package/src/resources/inbound-wire-drawdown-requests.ts +15 -26
  1073. package/src/resources/inbound-wire-transfers.ts +17 -29
  1074. package/src/resources/index.ts +68 -58
  1075. package/src/resources/intrafi-account-enrollments.ts +24 -32
  1076. package/src/resources/intrafi-balances.ts +6 -4
  1077. package/src/resources/intrafi-exclusions.ts +16 -28
  1078. package/src/resources/lockboxes.ts +16 -26
  1079. package/src/resources/oauth-applications.ts +13 -22
  1080. package/src/resources/oauth-connections.ts +13 -22
  1081. package/src/resources/oauth-tokens.ts +4 -3
  1082. package/src/resources/pending-transactions.ts +16 -28
  1083. package/src/resources/physical-card-profiles.ts +23 -38
  1084. package/src/resources/physical-cards.ts +18 -27
  1085. package/src/resources/programs.ts +13 -19
  1086. package/src/resources/real-time-decisions.ts +10 -8
  1087. package/src/resources/real-time-payments-transfers.ts +29 -37
  1088. package/src/resources/routing-numbers.ts +11 -10
  1089. package/src/resources/simulations/account-statements.ts +5 -4
  1090. package/src/resources/simulations/account-transfers.ts +8 -6
  1091. package/src/resources/simulations/ach-transfers.ts +23 -24
  1092. package/src/resources/simulations/card-authorization-expirations.ts +5 -4
  1093. package/src/resources/simulations/card-authorizations.ts +5 -4
  1094. package/src/resources/simulations/card-disputes.ts +8 -6
  1095. package/src/resources/simulations/card-fuel-confirmations.ts +5 -4
  1096. package/src/resources/simulations/card-increments.ts +4 -6
  1097. package/src/resources/simulations/card-refunds.ts +4 -6
  1098. package/src/resources/simulations/card-reversals.ts +4 -6
  1099. package/src/resources/simulations/card-settlements.ts +5 -4
  1100. package/src/resources/simulations/card-tokens.ts +4 -6
  1101. package/src/resources/simulations/check-deposits.ts +10 -17
  1102. package/src/resources/simulations/check-transfers.ts +6 -7
  1103. package/src/resources/simulations/digital-wallet-token-requests.ts +5 -4
  1104. package/src/resources/simulations/documents.ts +4 -3
  1105. package/src/resources/simulations/inbound-ach-transfers.ts +5 -4
  1106. package/src/resources/simulations/inbound-check-deposits.ts +5 -4
  1107. package/src/resources/simulations/inbound-fednow-transfers.ts +5 -4
  1108. package/src/resources/simulations/inbound-mail-items.ts +5 -4
  1109. package/src/resources/simulations/inbound-real-time-payments-transfers.ts +5 -4
  1110. package/src/resources/simulations/inbound-wire-drawdown-requests.ts +5 -4
  1111. package/src/resources/simulations/inbound-wire-transfers.ts +5 -4
  1112. package/src/resources/simulations/interest-payments.ts +5 -4
  1113. package/src/resources/simulations/pending-transactions.ts +8 -6
  1114. package/src/resources/simulations/physical-cards.ts +12 -10
  1115. package/src/resources/simulations/programs.ts +4 -3
  1116. package/src/resources/simulations/real-time-payments-transfers.ts +8 -6
  1117. package/src/resources/simulations/simulations.ts +1 -1
  1118. package/src/resources/simulations/wire-drawdown-requests.ts +18 -10
  1119. package/src/resources/simulations/wire-transfers.ts +8 -12
  1120. package/src/resources/supplemental-documents.ts +11 -12
  1121. package/src/resources/transactions.ts +13 -22
  1122. package/src/resources/wire-drawdown-requests.ts +14 -29
  1123. package/src/resources/wire-transfers.ts +18 -27
  1124. package/src/tsconfig.json +2 -2
  1125. package/src/uploads.ts +2 -255
  1126. package/src/version.ts +1 -1
  1127. package/uploads.d.mts +2 -0
  1128. package/uploads.d.mts.map +1 -0
  1129. package/uploads.d.ts +1 -74
  1130. package/uploads.d.ts.map +1 -1
  1131. package/uploads.js +3 -168
  1132. package/uploads.js.map +1 -1
  1133. package/uploads.mjs +1 -157
  1134. package/uploads.mjs.map +1 -1
  1135. package/version.d.mts +2 -0
  1136. package/version.d.mts.map +1 -0
  1137. package/version.d.ts +1 -1
  1138. package/version.js +1 -1
  1139. package/version.mjs +1 -1
  1140. package/_shims/MultipartBody.d.ts +0 -9
  1141. package/_shims/MultipartBody.d.ts.map +0 -1
  1142. package/_shims/MultipartBody.js +0 -16
  1143. package/_shims/MultipartBody.js.map +0 -1
  1144. package/_shims/MultipartBody.mjs +0 -12
  1145. package/_shims/MultipartBody.mjs.map +0 -1
  1146. package/_shims/README.md +0 -46
  1147. package/_shims/auto/runtime-bun.d.ts +0 -5
  1148. package/_shims/auto/runtime-bun.d.ts.map +0 -1
  1149. package/_shims/auto/runtime-bun.js +0 -21
  1150. package/_shims/auto/runtime-bun.js.map +0 -1
  1151. package/_shims/auto/runtime-bun.mjs +0 -2
  1152. package/_shims/auto/runtime-bun.mjs.map +0 -1
  1153. package/_shims/auto/runtime-node.d.ts +0 -5
  1154. package/_shims/auto/runtime-node.d.ts.map +0 -1
  1155. package/_shims/auto/runtime-node.js +0 -21
  1156. package/_shims/auto/runtime-node.js.map +0 -1
  1157. package/_shims/auto/runtime-node.mjs +0 -2
  1158. package/_shims/auto/runtime-node.mjs.map +0 -1
  1159. package/_shims/auto/runtime.d.ts +0 -5
  1160. package/_shims/auto/runtime.d.ts.map +0 -1
  1161. package/_shims/auto/runtime.js +0 -21
  1162. package/_shims/auto/runtime.js.map +0 -1
  1163. package/_shims/auto/runtime.mjs +0 -2
  1164. package/_shims/auto/runtime.mjs.map +0 -1
  1165. package/_shims/auto/types-node.d.ts +0 -5
  1166. package/_shims/auto/types-node.d.ts.map +0 -1
  1167. package/_shims/auto/types-node.js +0 -21
  1168. package/_shims/auto/types-node.js.map +0 -1
  1169. package/_shims/auto/types-node.mjs +0 -2
  1170. package/_shims/auto/types-node.mjs.map +0 -1
  1171. package/_shims/auto/types.d.ts +0 -101
  1172. package/_shims/auto/types.js +0 -3
  1173. package/_shims/auto/types.mjs +0 -3
  1174. package/_shims/bun-runtime.d.ts +0 -6
  1175. package/_shims/bun-runtime.d.ts.map +0 -1
  1176. package/_shims/bun-runtime.js +0 -14
  1177. package/_shims/bun-runtime.js.map +0 -1
  1178. package/_shims/bun-runtime.mjs +0 -10
  1179. package/_shims/bun-runtime.mjs.map +0 -1
  1180. package/_shims/index.d.ts +0 -83
  1181. package/_shims/index.js +0 -17
  1182. package/_shims/index.mjs +0 -11
  1183. package/_shims/manual-types.d.ts +0 -12
  1184. package/_shims/manual-types.js +0 -3
  1185. package/_shims/manual-types.mjs +0 -3
  1186. package/_shims/node-runtime.d.ts +0 -3
  1187. package/_shims/node-runtime.d.ts.map +0 -1
  1188. package/_shims/node-runtime.js +0 -89
  1189. package/_shims/node-runtime.js.map +0 -1
  1190. package/_shims/node-runtime.mjs +0 -56
  1191. package/_shims/node-runtime.mjs.map +0 -1
  1192. package/_shims/node-types.d.ts +0 -42
  1193. package/_shims/node-types.js +0 -3
  1194. package/_shims/node-types.mjs +0 -3
  1195. package/_shims/registry.d.ts +0 -37
  1196. package/_shims/registry.d.ts.map +0 -1
  1197. package/_shims/registry.js +0 -41
  1198. package/_shims/registry.js.map +0 -1
  1199. package/_shims/registry.mjs +0 -37
  1200. package/_shims/registry.mjs.map +0 -1
  1201. package/_shims/web-runtime.d.ts +0 -5
  1202. package/_shims/web-runtime.d.ts.map +0 -1
  1203. package/_shims/web-runtime.js +0 -78
  1204. package/_shims/web-runtime.js.map +0 -1
  1205. package/_shims/web-runtime.mjs +0 -71
  1206. package/_shims/web-runtime.mjs.map +0 -1
  1207. package/_shims/web-types.d.ts +0 -83
  1208. package/_shims/web-types.js +0 -3
  1209. package/_shims/web-types.mjs +0 -3
  1210. package/core.d.ts +0 -255
  1211. package/core.d.ts.map +0 -1
  1212. package/core.js +0 -924
  1213. package/core.js.map +0 -1
  1214. package/core.mjs +0 -892
  1215. package/core.mjs.map +0 -1
  1216. package/resources/webhooks.d.ts +0 -22
  1217. package/resources/webhooks.d.ts.map +0 -1
  1218. package/resources/webhooks.js +0 -82
  1219. package/resources/webhooks.js.map +0 -1
  1220. package/resources/webhooks.mjs +0 -78
  1221. package/resources/webhooks.mjs.map +0 -1
  1222. package/shims/node.d.ts +0 -30
  1223. package/shims/node.d.ts.map +0 -1
  1224. package/shims/node.js +0 -31
  1225. package/shims/node.js.map +0 -1
  1226. package/shims/node.mjs +0 -5
  1227. package/shims/node.mjs.map +0 -1
  1228. package/shims/web.d.ts +0 -26
  1229. package/shims/web.d.ts.map +0 -1
  1230. package/shims/web.js +0 -31
  1231. package/shims/web.js.map +0 -1
  1232. package/shims/web.mjs +0 -5
  1233. package/shims/web.mjs.map +0 -1
  1234. package/src/_shims/MultipartBody.ts +0 -9
  1235. package/src/_shims/README.md +0 -46
  1236. package/src/_shims/auto/runtime-bun.ts +0 -4
  1237. package/src/_shims/auto/runtime-node.ts +0 -4
  1238. package/src/_shims/auto/runtime.ts +0 -4
  1239. package/src/_shims/auto/types-node.ts +0 -4
  1240. package/src/_shims/auto/types.d.ts +0 -101
  1241. package/src/_shims/auto/types.js +0 -3
  1242. package/src/_shims/auto/types.mjs +0 -3
  1243. package/src/_shims/bun-runtime.ts +0 -14
  1244. package/src/_shims/index.d.ts +0 -83
  1245. package/src/_shims/index.js +0 -17
  1246. package/src/_shims/index.mjs +0 -11
  1247. package/src/_shims/manual-types.d.ts +0 -12
  1248. package/src/_shims/manual-types.js +0 -3
  1249. package/src/_shims/manual-types.mjs +0 -3
  1250. package/src/_shims/node-runtime.ts +0 -81
  1251. package/src/_shims/node-types.d.ts +0 -42
  1252. package/src/_shims/node-types.js +0 -3
  1253. package/src/_shims/node-types.mjs +0 -3
  1254. package/src/_shims/registry.ts +0 -67
  1255. package/src/_shims/web-runtime.ts +0 -103
  1256. package/src/_shims/web-types.d.ts +0 -83
  1257. package/src/_shims/web-types.js +0 -3
  1258. package/src/_shims/web-types.mjs +0 -3
  1259. package/src/core.ts +0 -1236
  1260. package/src/resources/webhooks.ts +0 -110
  1261. package/src/shims/node.ts +0 -50
  1262. package/src/shims/web.ts +0 -50
@@ -0,0 +1,3483 @@
1
+ import { APIResource } from "../core/resource.mjs";
2
+ import { APIPromise } from "../core/api-promise.mjs";
3
+ import { Page, type PageParams, PagePromise } from "../core/pagination.mjs";
4
+ import { RequestOptions } from "../internal/request-options.mjs";
5
+ export declare class Transactions extends APIResource {
6
+ /**
7
+ * Retrieve a Transaction
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const transaction = await client.transactions.retrieve(
12
+ * 'transaction_uyrp7fld2ium70oa7oi',
13
+ * );
14
+ * ```
15
+ */
16
+ retrieve(transactionID: string, options?: RequestOptions): APIPromise<Transaction>;
17
+ /**
18
+ * List Transactions
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * // Automatically fetches more pages as needed.
23
+ * for await (const transaction of client.transactions.list()) {
24
+ * // ...
25
+ * }
26
+ * ```
27
+ */
28
+ list(query?: TransactionListParams | null | undefined, options?: RequestOptions): PagePromise<TransactionsPage, Transaction>;
29
+ }
30
+ export type TransactionsPage = Page<Transaction>;
31
+ /**
32
+ * Transactions are the immutable additions and removals of money from your bank
33
+ * account. They're the equivalent of line items on your bank statement. To learn
34
+ * more, see [Transactions and Transfers](/documentation/transactions-transfers).
35
+ */
36
+ export interface Transaction {
37
+ /**
38
+ * The Transaction identifier.
39
+ */
40
+ id: string;
41
+ /**
42
+ * The identifier for the Account the Transaction belongs to.
43
+ */
44
+ account_id: string;
45
+ /**
46
+ * The Transaction amount in the minor unit of its currency. For dollars, for
47
+ * example, this is cents.
48
+ */
49
+ amount: number;
50
+ /**
51
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
52
+ * Transaction occurred.
53
+ */
54
+ created_at: string;
55
+ /**
56
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
57
+ * Transaction's currency. This will match the currency on the Transaction's
58
+ * Account.
59
+ *
60
+ * - `USD` - US Dollar (USD)
61
+ */
62
+ currency: 'USD';
63
+ /**
64
+ * An informational message describing this transaction. Use the fields in `source`
65
+ * to get more detailed information. This field appears as the line-item on the
66
+ * statement.
67
+ */
68
+ description: string;
69
+ /**
70
+ * The identifier for the route this Transaction came through. Routes are things
71
+ * like cards and ACH details.
72
+ */
73
+ route_id: string | null;
74
+ /**
75
+ * The type of the route this Transaction came through.
76
+ *
77
+ * - `account_number` - An Account Number.
78
+ * - `card` - A Card.
79
+ * - `lockbox` - A Lockbox.
80
+ */
81
+ route_type: 'account_number' | 'card' | 'lockbox' | null;
82
+ /**
83
+ * This is an object giving more details on the network-level event that caused the
84
+ * Transaction. Note that for backwards compatibility reasons, additional
85
+ * undocumented keys may appear in this object. These should be treated as
86
+ * deprecated and will be removed in the future.
87
+ */
88
+ source: Transaction.Source;
89
+ /**
90
+ * A constant representing the object's type. For this resource it will always be
91
+ * `transaction`.
92
+ */
93
+ type: 'transaction';
94
+ [k: string]: unknown;
95
+ }
96
+ export declare namespace Transaction {
97
+ /**
98
+ * This is an object giving more details on the network-level event that caused the
99
+ * Transaction. Note that for backwards compatibility reasons, additional
100
+ * undocumented keys may appear in this object. These should be treated as
101
+ * deprecated and will be removed in the future.
102
+ */
103
+ interface Source {
104
+ /**
105
+ * An Account Revenue Payment object. This field will be present in the JSON
106
+ * response if and only if `category` is equal to `account_revenue_payment`. An
107
+ * Account Revenue Payment represents a payment made to an account from the bank.
108
+ * Account revenue is a type of non-interest income.
109
+ */
110
+ account_revenue_payment: Source.AccountRevenuePayment | null;
111
+ /**
112
+ * An Account Transfer Intention object. This field will be present in the JSON
113
+ * response if and only if `category` is equal to `account_transfer_intention`. Two
114
+ * Account Transfer Intentions are created from each Account Transfer. One
115
+ * decrements the source account, and the other increments the destination account.
116
+ */
117
+ account_transfer_intention: Source.AccountTransferIntention | null;
118
+ /**
119
+ * An ACH Transfer Intention object. This field will be present in the JSON
120
+ * response if and only if `category` is equal to `ach_transfer_intention`. An ACH
121
+ * Transfer Intention is created from an ACH Transfer. It reflects the intention to
122
+ * move money into or out of an Increase account via the ACH network.
123
+ */
124
+ ach_transfer_intention: Source.ACHTransferIntention | null;
125
+ /**
126
+ * An ACH Transfer Rejection object. This field will be present in the JSON
127
+ * response if and only if `category` is equal to `ach_transfer_rejection`. An ACH
128
+ * Transfer Rejection is created when an ACH Transfer is rejected by Increase. It
129
+ * offsets the ACH Transfer Intention. These rejections are rare.
130
+ */
131
+ ach_transfer_rejection: Source.ACHTransferRejection | null;
132
+ /**
133
+ * An ACH Transfer Return object. This field will be present in the JSON response
134
+ * if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer
135
+ * Return is created when an ACH Transfer is returned by the receiving bank. It
136
+ * offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
137
+ * the first two business days after the transfer is initiated, but can occur much
138
+ * later.
139
+ */
140
+ ach_transfer_return: Source.ACHTransferReturn | null;
141
+ /**
142
+ * A Legacy Card Dispute Acceptance object. This field will be present in the JSON
143
+ * response if and only if `category` is equal to `card_dispute_acceptance`.
144
+ * Contains the details of a successful Card Dispute.
145
+ */
146
+ card_dispute_acceptance: Source.CardDisputeAcceptance | null;
147
+ /**
148
+ * A Card Dispute Financial object. This field will be present in the JSON response
149
+ * if and only if `category` is equal to `card_dispute_financial`. Financial event
150
+ * related to a Card Dispute.
151
+ */
152
+ card_dispute_financial: Source.CardDisputeFinancial | null;
153
+ /**
154
+ * A Legacy Card Dispute Loss object. This field will be present in the JSON
155
+ * response if and only if `category` is equal to `card_dispute_loss`. Contains the
156
+ * details of a lost Card Dispute.
157
+ */
158
+ card_dispute_loss: Source.CardDisputeLoss | null;
159
+ /**
160
+ * A Card Financial object. This field will be present in the JSON response if and
161
+ * only if `category` is equal to `card_financial`. Card Financials are temporary
162
+ * holds placed on a customers funds with the intent to later clear a transaction.
163
+ */
164
+ card_financial: Source.CardFinancial | null;
165
+ /**
166
+ * A Card Push Transfer Acceptance object. This field will be present in the JSON
167
+ * response if and only if `category` is equal to `card_push_transfer_acceptance`.
168
+ * A Card Push Transfer Acceptance is created when an Outbound Card Push Transfer
169
+ * sent from Increase is accepted by the receiving bank.
170
+ */
171
+ card_push_transfer_acceptance: Source.CardPushTransferAcceptance | null;
172
+ /**
173
+ * A Card Refund object. This field will be present in the JSON response if and
174
+ * only if `category` is equal to `card_refund`. Card Refunds move money back to
175
+ * the cardholder. While they are usually connected to a Card Settlement an
176
+ * acquirer can also refund money directly to a card without relation to a
177
+ * transaction.
178
+ */
179
+ card_refund: Source.CardRefund | null;
180
+ /**
181
+ * A Card Revenue Payment object. This field will be present in the JSON response
182
+ * if and only if `category` is equal to `card_revenue_payment`. Card Revenue
183
+ * Payments reflect earnings from fees on card transactions.
184
+ */
185
+ card_revenue_payment: Source.CardRevenuePayment | null;
186
+ /**
187
+ * A Card Settlement object. This field will be present in the JSON response if and
188
+ * only if `category` is equal to `card_settlement`. Card Settlements are card
189
+ * transactions that have cleared and settled. While a settlement is usually
190
+ * preceded by an authorization, an acquirer can also directly clear a transaction
191
+ * without first authorizing it.
192
+ */
193
+ card_settlement: Source.CardSettlement | null;
194
+ /**
195
+ * A Cashback Payment object. This field will be present in the JSON response if
196
+ * and only if `category` is equal to `cashback_payment`. A Cashback Payment
197
+ * represents the cashback paid to a cardholder for a given period. Cashback is
198
+ * usually paid monthly for the prior month's transactions.
199
+ */
200
+ cashback_payment: Source.CashbackPayment | null;
201
+ /**
202
+ * The type of the resource. We may add additional possible values for this enum
203
+ * over time; your application should be able to handle such additions gracefully.
204
+ *
205
+ * - `account_transfer_intention` - Account Transfer Intention: details will be
206
+ * under the `account_transfer_intention` object.
207
+ * - `ach_transfer_intention` - ACH Transfer Intention: details will be under the
208
+ * `ach_transfer_intention` object.
209
+ * - `ach_transfer_rejection` - ACH Transfer Rejection: details will be under the
210
+ * `ach_transfer_rejection` object.
211
+ * - `ach_transfer_return` - ACH Transfer Return: details will be under the
212
+ * `ach_transfer_return` object.
213
+ * - `cashback_payment` - Cashback Payment: details will be under the
214
+ * `cashback_payment` object.
215
+ * - `card_dispute_acceptance` - Legacy Card Dispute Acceptance: details will be
216
+ * under the `card_dispute_acceptance` object.
217
+ * - `card_dispute_financial` - Card Dispute Financial: details will be under the
218
+ * `card_dispute_financial` object.
219
+ * - `card_dispute_loss` - Legacy Card Dispute Loss: details will be under the
220
+ * `card_dispute_loss` object.
221
+ * - `card_refund` - Card Refund: details will be under the `card_refund` object.
222
+ * - `card_settlement` - Card Settlement: details will be under the
223
+ * `card_settlement` object.
224
+ * - `card_financial` - Card Financial: details will be under the `card_financial`
225
+ * object.
226
+ * - `card_revenue_payment` - Card Revenue Payment: details will be under the
227
+ * `card_revenue_payment` object.
228
+ * - `check_deposit_acceptance` - Check Deposit Acceptance: details will be under
229
+ * the `check_deposit_acceptance` object.
230
+ * - `check_deposit_return` - Check Deposit Return: details will be under the
231
+ * `check_deposit_return` object.
232
+ * - `fednow_transfer_acknowledgement` - FedNow Transfer Acknowledgement: details
233
+ * will be under the `fednow_transfer_acknowledgement` object.
234
+ * - `check_transfer_deposit` - Check Transfer Deposit: details will be under the
235
+ * `check_transfer_deposit` object.
236
+ * - `fee_payment` - Fee Payment: details will be under the `fee_payment` object.
237
+ * - `inbound_ach_transfer` - Inbound ACH Transfer Intention: details will be under
238
+ * the `inbound_ach_transfer` object.
239
+ * - `inbound_ach_transfer_return_intention` - Inbound ACH Transfer Return
240
+ * Intention: details will be under the `inbound_ach_transfer_return_intention`
241
+ * object.
242
+ * - `inbound_check_deposit_return_intention` - Inbound Check Deposit Return
243
+ * Intention: details will be under the `inbound_check_deposit_return_intention`
244
+ * object.
245
+ * - `inbound_check_adjustment` - Inbound Check Adjustment: details will be under
246
+ * the `inbound_check_adjustment` object.
247
+ * - `inbound_fednow_transfer_confirmation` - Inbound FedNow Transfer Confirmation:
248
+ * details will be under the `inbound_fednow_transfer_confirmation` object.
249
+ * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real-Time
250
+ * Payments Transfer Confirmation: details will be under the
251
+ * `inbound_real_time_payments_transfer_confirmation` object.
252
+ * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
253
+ * `inbound_wire_reversal` object.
254
+ * - `inbound_wire_transfer` - Inbound Wire Transfer Intention: details will be
255
+ * under the `inbound_wire_transfer` object.
256
+ * - `inbound_wire_transfer_reversal` - Inbound Wire Transfer Reversal Intention:
257
+ * details will be under the `inbound_wire_transfer_reversal` object.
258
+ * - `interest_payment` - Interest Payment: details will be under the
259
+ * `interest_payment` object.
260
+ * - `internal_source` - Internal Source: details will be under the
261
+ * `internal_source` object.
262
+ * - `real_time_payments_transfer_acknowledgement` - Real-Time Payments Transfer
263
+ * Acknowledgement: details will be under the
264
+ * `real_time_payments_transfer_acknowledgement` object.
265
+ * - `sample_funds` - Sample Funds: details will be under the `sample_funds`
266
+ * object.
267
+ * - `wire_transfer_intention` - Wire Transfer Intention: details will be under the
268
+ * `wire_transfer_intention` object.
269
+ * - `swift_transfer_intention` - Swift Transfer Intention: details will be under
270
+ * the `swift_transfer_intention` object.
271
+ * - `swift_transfer_return` - Swift Transfer Return: details will be under the
272
+ * `swift_transfer_return` object.
273
+ * - `card_push_transfer_acceptance` - Card Push Transfer Acceptance: details will
274
+ * be under the `card_push_transfer_acceptance` object.
275
+ * - `account_revenue_payment` - Account Revenue Payment: details will be under the
276
+ * `account_revenue_payment` object.
277
+ * - `other` - The Transaction was made for an undocumented or deprecated reason.
278
+ */
279
+ category: 'account_transfer_intention' | 'ach_transfer_intention' | 'ach_transfer_rejection' | 'ach_transfer_return' | 'cashback_payment' | 'card_dispute_acceptance' | 'card_dispute_financial' | 'card_dispute_loss' | 'card_refund' | 'card_settlement' | 'card_financial' | 'card_revenue_payment' | 'check_deposit_acceptance' | 'check_deposit_return' | 'fednow_transfer_acknowledgement' | 'check_transfer_deposit' | 'fee_payment' | 'inbound_ach_transfer' | 'inbound_ach_transfer_return_intention' | 'inbound_check_deposit_return_intention' | 'inbound_check_adjustment' | 'inbound_fednow_transfer_confirmation' | 'inbound_real_time_payments_transfer_confirmation' | 'inbound_wire_reversal' | 'inbound_wire_transfer' | 'inbound_wire_transfer_reversal' | 'interest_payment' | 'internal_source' | 'real_time_payments_transfer_acknowledgement' | 'sample_funds' | 'wire_transfer_intention' | 'swift_transfer_intention' | 'swift_transfer_return' | 'card_push_transfer_acceptance' | 'account_revenue_payment' | 'other';
280
+ /**
281
+ * A Check Deposit Acceptance object. This field will be present in the JSON
282
+ * response if and only if `category` is equal to `check_deposit_acceptance`. A
283
+ * Check Deposit Acceptance is created when a Check Deposit is processed and its
284
+ * details confirmed. Check Deposits may be returned by the receiving bank, which
285
+ * will appear as a Check Deposit Return.
286
+ */
287
+ check_deposit_acceptance: Source.CheckDepositAcceptance | null;
288
+ /**
289
+ * A Check Deposit Return object. This field will be present in the JSON response
290
+ * if and only if `category` is equal to `check_deposit_return`. A Check Deposit
291
+ * Return is created when a Check Deposit is returned by the bank holding the
292
+ * account it was drawn against. Check Deposits may be returned for a variety of
293
+ * reasons, including insufficient funds or a mismatched account number. Usually,
294
+ * checks are returned within the first 7 days after the deposit is made.
295
+ */
296
+ check_deposit_return: Source.CheckDepositReturn | null;
297
+ /**
298
+ * A Check Transfer Deposit object. This field will be present in the JSON response
299
+ * if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check
300
+ * is a check drawn on an Increase account that has been deposited by an external
301
+ * bank account. These types of checks are not pre-registered.
302
+ */
303
+ check_transfer_deposit: Source.CheckTransferDeposit | null;
304
+ /**
305
+ * A FedNow Transfer Acknowledgement object. This field will be present in the JSON
306
+ * response if and only if `category` is equal to
307
+ * `fednow_transfer_acknowledgement`. A FedNow Transfer Acknowledgement is created
308
+ * when a FedNow Transfer sent from Increase is acknowledged by the receiving bank.
309
+ */
310
+ fednow_transfer_acknowledgement: Source.FednowTransferAcknowledgement | null;
311
+ /**
312
+ * A Fee Payment object. This field will be present in the JSON response if and
313
+ * only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
314
+ * made to Increase.
315
+ */
316
+ fee_payment: Source.FeePayment | null;
317
+ /**
318
+ * An Inbound ACH Transfer Intention object. This field will be present in the JSON
319
+ * response if and only if `category` is equal to `inbound_ach_transfer`. An
320
+ * Inbound ACH Transfer Intention is created when an ACH transfer is initiated at
321
+ * another bank and received by Increase.
322
+ */
323
+ inbound_ach_transfer: Source.InboundACHTransfer | null;
324
+ /**
325
+ * An Inbound ACH Transfer Return Intention object. This field will be present in
326
+ * the JSON response if and only if `category` is equal to
327
+ * `inbound_ach_transfer_return_intention`. An Inbound ACH Transfer Return
328
+ * Intention is created when an ACH transfer is initiated at another bank and
329
+ * returned by Increase.
330
+ */
331
+ inbound_ach_transfer_return_intention: Source.InboundACHTransferReturnIntention | null;
332
+ /**
333
+ * An Inbound Check Adjustment object. This field will be present in the JSON
334
+ * response if and only if `category` is equal to `inbound_check_adjustment`. An
335
+ * Inbound Check Adjustment is created when Increase receives an adjustment for a
336
+ * check or return deposited through Check21.
337
+ */
338
+ inbound_check_adjustment: Source.InboundCheckAdjustment | null;
339
+ /**
340
+ * An Inbound Check Deposit Return Intention object. This field will be present in
341
+ * the JSON response if and only if `category` is equal to
342
+ * `inbound_check_deposit_return_intention`. An Inbound Check Deposit Return
343
+ * Intention is created when Increase receives an Inbound Check and the User
344
+ * requests that it be returned.
345
+ */
346
+ inbound_check_deposit_return_intention: Source.InboundCheckDepositReturnIntention | null;
347
+ /**
348
+ * An Inbound FedNow Transfer Confirmation object. This field will be present in
349
+ * the JSON response if and only if `category` is equal to
350
+ * `inbound_fednow_transfer_confirmation`. An Inbound FedNow Transfer Confirmation
351
+ * is created when a FedNow transfer is initiated at another bank and received by
352
+ * Increase.
353
+ */
354
+ inbound_fednow_transfer_confirmation: Source.InboundFednowTransferConfirmation | null;
355
+ /**
356
+ * An Inbound Real-Time Payments Transfer Confirmation object. This field will be
357
+ * present in the JSON response if and only if `category` is equal to
358
+ * `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time
359
+ * Payments Transfer Confirmation is created when a Real-Time Payments transfer is
360
+ * initiated at another bank and received by Increase.
361
+ */
362
+ inbound_real_time_payments_transfer_confirmation: Source.InboundRealTimePaymentsTransferConfirmation | null;
363
+ /**
364
+ * An Inbound Wire Reversal object. This field will be present in the JSON response
365
+ * if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire
366
+ * Reversal represents a reversal of a wire transfer that was initiated via
367
+ * Increase. The other bank is sending the money back. This most often happens when
368
+ * the original destination account details were incorrect.
369
+ */
370
+ inbound_wire_reversal: Source.InboundWireReversal | null;
371
+ /**
372
+ * An Inbound Wire Transfer Intention object. This field will be present in the
373
+ * JSON response if and only if `category` is equal to `inbound_wire_transfer`. An
374
+ * Inbound Wire Transfer Intention is created when a wire transfer is initiated at
375
+ * another bank and received by Increase.
376
+ */
377
+ inbound_wire_transfer: Source.InboundWireTransfer | null;
378
+ /**
379
+ * An Inbound Wire Transfer Reversal Intention object. This field will be present
380
+ * in the JSON response if and only if `category` is equal to
381
+ * `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal Intention is
382
+ * created when Increase has received a wire and the User requests that it be
383
+ * reversed.
384
+ */
385
+ inbound_wire_transfer_reversal: Source.InboundWireTransferReversal | null;
386
+ /**
387
+ * An Interest Payment object. This field will be present in the JSON response if
388
+ * and only if `category` is equal to `interest_payment`. An Interest Payment
389
+ * represents a payment of interest on an account. Interest is usually paid
390
+ * monthly.
391
+ */
392
+ interest_payment: Source.InterestPayment | null;
393
+ /**
394
+ * An Internal Source object. This field will be present in the JSON response if
395
+ * and only if `category` is equal to `internal_source`. A transaction between the
396
+ * user and Increase. See the `reason` attribute for more information.
397
+ */
398
+ internal_source: Source.InternalSource | null;
399
+ /**
400
+ * If the category of this Transaction source is equal to `other`, this field will
401
+ * contain an empty object, otherwise it will contain null.
402
+ */
403
+ other: Source.Other | null;
404
+ /**
405
+ * A Real-Time Payments Transfer Acknowledgement object. This field will be present
406
+ * in the JSON response if and only if `category` is equal to
407
+ * `real_time_payments_transfer_acknowledgement`. A Real-Time Payments Transfer
408
+ * Acknowledgement is created when a Real-Time Payments Transfer sent from Increase
409
+ * is acknowledged by the receiving bank.
410
+ */
411
+ real_time_payments_transfer_acknowledgement: Source.RealTimePaymentsTransferAcknowledgement | null;
412
+ /**
413
+ * A Sample Funds object. This field will be present in the JSON response if and
414
+ * only if `category` is equal to `sample_funds`. Sample funds for testing
415
+ * purposes.
416
+ */
417
+ sample_funds: Source.SampleFunds | null;
418
+ /**
419
+ * A Swift Transfer Intention object. This field will be present in the JSON
420
+ * response if and only if `category` is equal to `swift_transfer_intention`. A
421
+ * Swift Transfer initiated via Increase.
422
+ */
423
+ swift_transfer_intention: Source.SwiftTransferIntention | null;
424
+ /**
425
+ * A Swift Transfer Return object. This field will be present in the JSON response
426
+ * if and only if `category` is equal to `swift_transfer_return`. A Swift Transfer
427
+ * Return is created when a Swift Transfer is returned by the receiving bank.
428
+ */
429
+ swift_transfer_return: Source.SwiftTransferReturn | null;
430
+ /**
431
+ * A Wire Transfer Intention object. This field will be present in the JSON
432
+ * response if and only if `category` is equal to `wire_transfer_intention`. A Wire
433
+ * Transfer initiated via Increase and sent to a different bank.
434
+ */
435
+ wire_transfer_intention: Source.WireTransferIntention | null;
436
+ [k: string]: unknown;
437
+ }
438
+ namespace Source {
439
+ /**
440
+ * An Account Revenue Payment object. This field will be present in the JSON
441
+ * response if and only if `category` is equal to `account_revenue_payment`. An
442
+ * Account Revenue Payment represents a payment made to an account from the bank.
443
+ * Account revenue is a type of non-interest income.
444
+ */
445
+ interface AccountRevenuePayment {
446
+ /**
447
+ * The account on which the account revenue was accrued.
448
+ */
449
+ accrued_on_account_id: string;
450
+ /**
451
+ * The end of the period for which this transaction paid account revenue.
452
+ */
453
+ period_end: string;
454
+ /**
455
+ * The start of the period for which this transaction paid account revenue.
456
+ */
457
+ period_start: string;
458
+ [k: string]: unknown;
459
+ }
460
+ /**
461
+ * An Account Transfer Intention object. This field will be present in the JSON
462
+ * response if and only if `category` is equal to `account_transfer_intention`. Two
463
+ * Account Transfer Intentions are created from each Account Transfer. One
464
+ * decrements the source account, and the other increments the destination account.
465
+ */
466
+ interface AccountTransferIntention {
467
+ /**
468
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
469
+ * for example, this is cents.
470
+ */
471
+ amount: number;
472
+ /**
473
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
474
+ * account currency.
475
+ *
476
+ * - `USD` - US Dollar (USD)
477
+ */
478
+ currency: 'USD';
479
+ /**
480
+ * The description you chose to give the transfer.
481
+ */
482
+ description: string;
483
+ /**
484
+ * The identifier of the Account to where the Account Transfer was sent.
485
+ */
486
+ destination_account_id: string;
487
+ /**
488
+ * The identifier of the Account from where the Account Transfer was sent.
489
+ */
490
+ source_account_id: string;
491
+ /**
492
+ * The identifier of the Account Transfer that led to this Pending Transaction.
493
+ */
494
+ transfer_id: string;
495
+ [k: string]: unknown;
496
+ }
497
+ /**
498
+ * An ACH Transfer Intention object. This field will be present in the JSON
499
+ * response if and only if `category` is equal to `ach_transfer_intention`. An ACH
500
+ * Transfer Intention is created from an ACH Transfer. It reflects the intention to
501
+ * move money into or out of an Increase account via the ACH network.
502
+ */
503
+ interface ACHTransferIntention {
504
+ /**
505
+ * The account number for the destination account.
506
+ */
507
+ account_number: string;
508
+ /**
509
+ * The amount in the minor unit of the transaction's currency. For dollars, for
510
+ * example, this is cents.
511
+ */
512
+ amount: number;
513
+ /**
514
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
515
+ * destination account.
516
+ */
517
+ routing_number: string;
518
+ /**
519
+ * A description set when the ACH Transfer was created.
520
+ */
521
+ statement_descriptor: string;
522
+ /**
523
+ * The identifier of the ACH Transfer that led to this Transaction.
524
+ */
525
+ transfer_id: string;
526
+ [k: string]: unknown;
527
+ }
528
+ /**
529
+ * An ACH Transfer Rejection object. This field will be present in the JSON
530
+ * response if and only if `category` is equal to `ach_transfer_rejection`. An ACH
531
+ * Transfer Rejection is created when an ACH Transfer is rejected by Increase. It
532
+ * offsets the ACH Transfer Intention. These rejections are rare.
533
+ */
534
+ interface ACHTransferRejection {
535
+ /**
536
+ * The identifier of the ACH Transfer that led to this Transaction.
537
+ */
538
+ transfer_id: string;
539
+ [k: string]: unknown;
540
+ }
541
+ /**
542
+ * An ACH Transfer Return object. This field will be present in the JSON response
543
+ * if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer
544
+ * Return is created when an ACH Transfer is returned by the receiving bank. It
545
+ * offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
546
+ * the first two business days after the transfer is initiated, but can occur much
547
+ * later.
548
+ */
549
+ interface ACHTransferReturn {
550
+ /**
551
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
552
+ * the transfer was created.
553
+ */
554
+ created_at: string;
555
+ /**
556
+ * The three character ACH return code, in the range R01 to R85.
557
+ */
558
+ raw_return_reason_code: string;
559
+ /**
560
+ * Why the ACH Transfer was returned. This reason code is sent by the receiving
561
+ * bank back to Increase.
562
+ *
563
+ * - `insufficient_fund` - Code R01. Insufficient funds in the receiving account.
564
+ * Sometimes abbreviated to NSF.
565
+ * - `no_account` - Code R03. The account does not exist or the receiving bank was
566
+ * unable to locate it.
567
+ * - `account_closed` - Code R02. The account is closed at the receiving bank.
568
+ * - `invalid_account_number_structure` - Code R04. The account number is invalid
569
+ * at the receiving bank.
570
+ * - `account_frozen_entry_returned_per_ofac_instruction` - Code R16. The account
571
+ * at the receiving bank was frozen per the Office of Foreign Assets Control.
572
+ * - `credit_entry_refused_by_receiver` - Code R23. The receiving bank account
573
+ * refused a credit transfer.
574
+ * - `unauthorized_debit_to_consumer_account_using_corporate_sec_code` - Code R05.
575
+ * The receiving bank rejected because of an incorrect Standard Entry Class code.
576
+ * - `corporate_customer_advised_not_authorized` - Code R29. The corporate customer
577
+ * at the receiving bank reversed the transfer.
578
+ * - `payment_stopped` - Code R08. The receiving bank stopped payment on this
579
+ * transfer.
580
+ * - `non_transaction_account` - Code R20. The receiving bank account does not
581
+ * perform transfers.
582
+ * - `uncollected_funds` - Code R09. The receiving bank account does not have
583
+ * enough available balance for the transfer.
584
+ * - `routing_number_check_digit_error` - Code R28. The routing number is
585
+ * incorrect.
586
+ * - `customer_advised_unauthorized_improper_ineligible_or_incomplete` - Code R10.
587
+ * The customer at the receiving bank reversed the transfer.
588
+ * - `amount_field_error` - Code R19. The amount field is incorrect or too large.
589
+ * - `authorization_revoked_by_customer` - Code R07. The customer at the receiving
590
+ * institution informed their bank that they have revoked authorization for a
591
+ * previously authorized transfer.
592
+ * - `invalid_ach_routing_number` - Code R13. The routing number is invalid.
593
+ * - `file_record_edit_criteria` - Code R17. The receiving bank is unable to
594
+ * process a field in the transfer.
595
+ * - `enr_invalid_individual_name` - Code R45. The individual name field was
596
+ * invalid.
597
+ * - `returned_per_odfi_request` - Code R06. The originating financial institution
598
+ * asked for this transfer to be returned. The receiving bank is complying with
599
+ * the request.
600
+ * - `limited_participation_dfi` - Code R34. The receiving bank's regulatory
601
+ * supervisor has limited their participation in the ACH network.
602
+ * - `incorrectly_coded_outbound_international_payment` - Code R85. The outbound
603
+ * international ACH transfer was incorrect.
604
+ * - `account_sold_to_another_dfi` - Code R12. A rare return reason. The account
605
+ * was sold to another bank.
606
+ * - `addenda_error` - Code R25. The addenda record is incorrect or missing.
607
+ * - `beneficiary_or_account_holder_deceased` - Code R15. A rare return reason. The
608
+ * account holder is deceased.
609
+ * - `customer_advised_not_within_authorization_terms` - Code R11. A rare return
610
+ * reason. The customer authorized some payment to the sender, but this payment
611
+ * was not in error.
612
+ * - `corrected_return` - Code R74. A rare return reason. Sent in response to a
613
+ * return that was returned with code `field_error`. The latest return should
614
+ * include the corrected field(s).
615
+ * - `duplicate_entry` - Code R24. A rare return reason. The receiving bank
616
+ * received an exact duplicate entry with the same trace number and amount.
617
+ * - `duplicate_return` - Code R67. A rare return reason. The return this message
618
+ * refers to was a duplicate.
619
+ * - `enr_duplicate_enrollment` - Code R47. A rare return reason. Only used for US
620
+ * Government agency non-monetary automatic enrollment messages.
621
+ * - `enr_invalid_dfi_account_number` - Code R43. A rare return reason. Only used
622
+ * for US Government agency non-monetary automatic enrollment messages.
623
+ * - `enr_invalid_individual_id_number` - Code R44. A rare return reason. Only used
624
+ * for US Government agency non-monetary automatic enrollment messages.
625
+ * - `enr_invalid_representative_payee_indicator` - Code R46. A rare return reason.
626
+ * Only used for US Government agency non-monetary automatic enrollment messages.
627
+ * - `enr_invalid_transaction_code` - Code R41. A rare return reason. Only used for
628
+ * US Government agency non-monetary automatic enrollment messages.
629
+ * - `enr_return_of_enr_entry` - Code R40. A rare return reason. Only used for US
630
+ * Government agency non-monetary automatic enrollment messages.
631
+ * - `enr_routing_number_check_digit_error` - Code R42. A rare return reason. Only
632
+ * used for US Government agency non-monetary automatic enrollment messages.
633
+ * - `entry_not_processed_by_gateway` - Code R84. A rare return reason. The
634
+ * International ACH Transfer cannot be processed by the gateway.
635
+ * - `field_error` - Code R69. A rare return reason. One or more of the fields in
636
+ * the ACH were malformed.
637
+ * - `foreign_receiving_dfi_unable_to_settle` - Code R83. A rare return reason. The
638
+ * Foreign receiving bank was unable to settle this ACH transfer.
639
+ * - `iat_entry_coding_error` - Code R80. A rare return reason. The International
640
+ * ACH Transfer is malformed.
641
+ * - `improper_effective_entry_date` - Code R18. A rare return reason. The ACH has
642
+ * an improper effective entry date field.
643
+ * - `improper_source_document_source_document_presented` - Code R39. A rare return
644
+ * reason. The source document related to this ACH, usually an ACH check
645
+ * conversion, was presented to the bank.
646
+ * - `invalid_company_id` - Code R21. A rare return reason. The Company ID field of
647
+ * the ACH was invalid.
648
+ * - `invalid_foreign_receiving_dfi_identification` - Code R82. A rare return
649
+ * reason. The foreign receiving bank identifier for an International ACH
650
+ * Transfer was invalid.
651
+ * - `invalid_individual_id_number` - Code R22. A rare return reason. The
652
+ * Individual ID number field of the ACH was invalid.
653
+ * - `item_and_rck_entry_presented_for_payment` - Code R53. A rare return reason.
654
+ * Both the Represented Check ("RCK") entry and the original check were presented
655
+ * to the bank.
656
+ * - `item_related_to_rck_entry_is_ineligible` - Code R51. A rare return reason.
657
+ * The Represented Check ("RCK") entry is ineligible.
658
+ * - `mandatory_field_error` - Code R26. A rare return reason. The ACH is missing a
659
+ * required field.
660
+ * - `misrouted_dishonored_return` - Code R71. A rare return reason. The receiving
661
+ * bank does not recognize the routing number in a dishonored return entry.
662
+ * - `misrouted_return` - Code R61. A rare return reason. The receiving bank does
663
+ * not recognize the routing number in a return entry.
664
+ * - `no_errors_found` - Code R76. A rare return reason. Sent in response to a
665
+ * return, the bank does not find the errors alleged by the returning bank.
666
+ * - `non_acceptance_of_r62_dishonored_return` - Code R77. A rare return reason.
667
+ * The receiving bank does not accept the return of the erroneous debit. The
668
+ * funds are not available at the receiving bank.
669
+ * - `non_participant_in_iat_program` - Code R81. A rare return reason. The
670
+ * receiving bank does not accept International ACH Transfers.
671
+ * - `permissible_return_entry` - Code R31. A rare return reason. A return that has
672
+ * been agreed to be accepted by the receiving bank, despite falling outside of
673
+ * the usual return timeframe.
674
+ * - `permissible_return_entry_not_accepted` - Code R70. A rare return reason. The
675
+ * receiving bank had not approved this return.
676
+ * - `rdfi_non_settlement` - Code R32. A rare return reason. The receiving bank
677
+ * could not settle this transaction.
678
+ * - `rdfi_participant_in_check_truncation_program` - Code R30. A rare return
679
+ * reason. The receiving bank does not accept Check Truncation ACH transfers.
680
+ * - `representative_payee_deceased_or_unable_to_continue_in_that_capacity` - Code
681
+ * R14. A rare return reason. The payee is deceased.
682
+ * - `return_not_a_duplicate` - Code R75. A rare return reason. The originating
683
+ * bank disputes that an earlier `duplicate_entry` return was actually a
684
+ * duplicate.
685
+ * - `return_of_erroneous_or_reversing_debit` - Code R62. A rare return reason. The
686
+ * originating financial institution made a mistake and this return corrects it.
687
+ * - `return_of_improper_credit_entry` - Code R36. A rare return reason. Return of
688
+ * a malformed credit entry.
689
+ * - `return_of_improper_debit_entry` - Code R35. A rare return reason. Return of a
690
+ * malformed debit entry.
691
+ * - `return_of_xck_entry` - Code R33. A rare return reason. Return of a Destroyed
692
+ * Check ("XKC") entry.
693
+ * - `source_document_presented_for_payment` - Code R37. A rare return reason. The
694
+ * source document related to this ACH, usually an ACH check conversion, was
695
+ * presented to the bank.
696
+ * - `state_law_affecting_rck_acceptance` - Code R50. A rare return reason. State
697
+ * law prevents the bank from accepting the Represented Check ("RCK") entry.
698
+ * - `stop_payment_on_item_related_to_rck_entry` - Code R52. A rare return reason.
699
+ * A stop payment was issued on a Represented Check ("RCK") entry.
700
+ * - `stop_payment_on_source_document` - Code R38. A rare return reason. The source
701
+ * attached to the ACH, usually an ACH check conversion, includes a stop payment.
702
+ * - `timely_original_return` - Code R73. A rare return reason. The bank receiving
703
+ * an `untimely_return` believes it was on time.
704
+ * - `trace_number_error` - Code R27. A rare return reason. An ACH return's trace
705
+ * number does not match an originated ACH.
706
+ * - `untimely_dishonored_return` - Code R72. A rare return reason. The dishonored
707
+ * return was sent too late.
708
+ * - `untimely_return` - Code R68. A rare return reason. The return was sent too
709
+ * late.
710
+ */
711
+ return_reason_code: 'insufficient_fund' | 'no_account' | 'account_closed' | 'invalid_account_number_structure' | 'account_frozen_entry_returned_per_ofac_instruction' | 'credit_entry_refused_by_receiver' | 'unauthorized_debit_to_consumer_account_using_corporate_sec_code' | 'corporate_customer_advised_not_authorized' | 'payment_stopped' | 'non_transaction_account' | 'uncollected_funds' | 'routing_number_check_digit_error' | 'customer_advised_unauthorized_improper_ineligible_or_incomplete' | 'amount_field_error' | 'authorization_revoked_by_customer' | 'invalid_ach_routing_number' | 'file_record_edit_criteria' | 'enr_invalid_individual_name' | 'returned_per_odfi_request' | 'limited_participation_dfi' | 'incorrectly_coded_outbound_international_payment' | 'account_sold_to_another_dfi' | 'addenda_error' | 'beneficiary_or_account_holder_deceased' | 'customer_advised_not_within_authorization_terms' | 'corrected_return' | 'duplicate_entry' | 'duplicate_return' | 'enr_duplicate_enrollment' | 'enr_invalid_dfi_account_number' | 'enr_invalid_individual_id_number' | 'enr_invalid_representative_payee_indicator' | 'enr_invalid_transaction_code' | 'enr_return_of_enr_entry' | 'enr_routing_number_check_digit_error' | 'entry_not_processed_by_gateway' | 'field_error' | 'foreign_receiving_dfi_unable_to_settle' | 'iat_entry_coding_error' | 'improper_effective_entry_date' | 'improper_source_document_source_document_presented' | 'invalid_company_id' | 'invalid_foreign_receiving_dfi_identification' | 'invalid_individual_id_number' | 'item_and_rck_entry_presented_for_payment' | 'item_related_to_rck_entry_is_ineligible' | 'mandatory_field_error' | 'misrouted_dishonored_return' | 'misrouted_return' | 'no_errors_found' | 'non_acceptance_of_r62_dishonored_return' | 'non_participant_in_iat_program' | 'permissible_return_entry' | 'permissible_return_entry_not_accepted' | 'rdfi_non_settlement' | 'rdfi_participant_in_check_truncation_program' | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity' | 'return_not_a_duplicate' | 'return_of_erroneous_or_reversing_debit' | 'return_of_improper_credit_entry' | 'return_of_improper_debit_entry' | 'return_of_xck_entry' | 'source_document_presented_for_payment' | 'state_law_affecting_rck_acceptance' | 'stop_payment_on_item_related_to_rck_entry' | 'stop_payment_on_source_document' | 'timely_original_return' | 'trace_number_error' | 'untimely_dishonored_return' | 'untimely_return';
712
+ /**
713
+ * A 15 digit number that was generated by the bank that initiated the return. The
714
+ * trace number of the return is different than that of the original transfer. ACH
715
+ * trace numbers are not unique, but along with the amount and date this number can
716
+ * be used to identify the ACH return at the bank that initiated it.
717
+ */
718
+ trace_number: string;
719
+ /**
720
+ * The identifier of the Transaction associated with this return.
721
+ */
722
+ transaction_id: string;
723
+ /**
724
+ * The identifier of the ACH Transfer associated with this return.
725
+ */
726
+ transfer_id: string;
727
+ [k: string]: unknown;
728
+ }
729
+ /**
730
+ * A Legacy Card Dispute Acceptance object. This field will be present in the JSON
731
+ * response if and only if `category` is equal to `card_dispute_acceptance`.
732
+ * Contains the details of a successful Card Dispute.
733
+ */
734
+ interface CardDisputeAcceptance {
735
+ /**
736
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
737
+ * the Card Dispute was accepted.
738
+ */
739
+ accepted_at: string;
740
+ /**
741
+ * The identifier of the Transaction that was created to return the disputed funds
742
+ * to your account.
743
+ */
744
+ transaction_id: string;
745
+ [k: string]: unknown;
746
+ }
747
+ /**
748
+ * A Card Dispute Financial object. This field will be present in the JSON response
749
+ * if and only if `category` is equal to `card_dispute_financial`. Financial event
750
+ * related to a Card Dispute.
751
+ */
752
+ interface CardDisputeFinancial {
753
+ /**
754
+ * The amount of the financial event.
755
+ */
756
+ amount: number;
757
+ /**
758
+ * The network that the Card Dispute is associated with.
759
+ *
760
+ * - `visa` - Visa: details will be under the `visa` object.
761
+ * - `pulse` - Pulse: details will be under the `pulse` object.
762
+ */
763
+ network: 'visa' | 'pulse';
764
+ /**
765
+ * The identifier of the Transaction that was created to credit or debit the
766
+ * disputed funds to or from your account.
767
+ */
768
+ transaction_id: string;
769
+ /**
770
+ * Information for events related to card dispute for card payments processed over
771
+ * Visa's network. This field will be present in the JSON response if and only if
772
+ * `network` is equal to `visa`.
773
+ */
774
+ visa: CardDisputeFinancial.Visa | null;
775
+ [k: string]: unknown;
776
+ }
777
+ namespace CardDisputeFinancial {
778
+ /**
779
+ * Information for events related to card dispute for card payments processed over
780
+ * Visa's network. This field will be present in the JSON response if and only if
781
+ * `network` is equal to `visa`.
782
+ */
783
+ interface Visa {
784
+ /**
785
+ * The type of card dispute financial event.
786
+ *
787
+ * - `chargeback_submitted` - The user's chargeback was submitted.
788
+ * - `merchant_prearbitration_decline_submitted` - The user declined the merchant's
789
+ * pre-arbitration submission.
790
+ * - `merchant_prearbitration_received` - The merchant's pre-arbitration submission
791
+ * was received.
792
+ * - `represented` - The transaction was re-presented by the merchant.
793
+ * - `user_prearbitration_decline_received` - The user's pre-arbitration was
794
+ * declined by the merchant.
795
+ * - `user_prearbitration_submitted` - The user's pre-arbitration was submitted.
796
+ * - `user_withdrawal_submitted` - The user withdrew from the dispute.
797
+ */
798
+ event_type: 'chargeback_submitted' | 'merchant_prearbitration_decline_submitted' | 'merchant_prearbitration_received' | 'represented' | 'user_prearbitration_decline_received' | 'user_prearbitration_submitted' | 'user_withdrawal_submitted';
799
+ }
800
+ }
801
+ /**
802
+ * A Legacy Card Dispute Loss object. This field will be present in the JSON
803
+ * response if and only if `category` is equal to `card_dispute_loss`. Contains the
804
+ * details of a lost Card Dispute.
805
+ */
806
+ interface CardDisputeLoss {
807
+ /**
808
+ * Why the Card Dispute was lost.
809
+ */
810
+ explanation: string;
811
+ /**
812
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
813
+ * the Card Dispute was lost.
814
+ */
815
+ lost_at: string;
816
+ /**
817
+ * The identifier of the Transaction that was created to debit the disputed funds
818
+ * from your account.
819
+ */
820
+ transaction_id: string;
821
+ [k: string]: unknown;
822
+ }
823
+ /**
824
+ * A Card Financial object. This field will be present in the JSON response if and
825
+ * only if `category` is equal to `card_financial`. Card Financials are temporary
826
+ * holds placed on a customers funds with the intent to later clear a transaction.
827
+ */
828
+ interface CardFinancial {
829
+ /**
830
+ * The Card Financial identifier.
831
+ */
832
+ id: string;
833
+ /**
834
+ * Whether this financial was approved by Increase, the card network through
835
+ * stand-in processing, or the user through a real-time decision.
836
+ *
837
+ * - `user` - This object was actioned by the user through a real-time decision.
838
+ * - `increase` - This object was actioned by Increase without user intervention.
839
+ * - `network` - This object was actioned by the network, through stand-in
840
+ * processing.
841
+ */
842
+ actioner: 'user' | 'increase' | 'network';
843
+ /**
844
+ * Additional amounts associated with the card authorization, such as ATM
845
+ * surcharges fees. These are usually a subset of the `amount` field and are used
846
+ * to provide more detailed information about the transaction.
847
+ */
848
+ additional_amounts: CardFinancial.AdditionalAmounts;
849
+ /**
850
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
851
+ * for example, this is cents.
852
+ */
853
+ amount: number;
854
+ /**
855
+ * The ID of the Card Payment this transaction belongs to.
856
+ */
857
+ card_payment_id: string;
858
+ /**
859
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
860
+ * transaction's currency.
861
+ *
862
+ * - `USD` - US Dollar (USD)
863
+ */
864
+ currency: 'USD';
865
+ /**
866
+ * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
867
+ * purchase), the identifier of the token that was used.
868
+ */
869
+ digital_wallet_token_id: string | null;
870
+ /**
871
+ * The direction describes the direction the funds will move, either from the
872
+ * cardholder to the merchant or from the merchant to the cardholder.
873
+ *
874
+ * - `settlement` - A regular card authorization where funds are debited from the
875
+ * cardholder.
876
+ * - `refund` - A refund card authorization, sometimes referred to as a credit
877
+ * voucher authorization, where funds are credited to the cardholder.
878
+ */
879
+ direction: 'settlement' | 'refund';
880
+ /**
881
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
882
+ * is transacting with.
883
+ */
884
+ merchant_acceptor_id: string;
885
+ /**
886
+ * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
887
+ * card is transacting with.
888
+ */
889
+ merchant_category_code: string;
890
+ /**
891
+ * The city the merchant resides in.
892
+ */
893
+ merchant_city: string | null;
894
+ /**
895
+ * The country the merchant resides in.
896
+ */
897
+ merchant_country: string;
898
+ /**
899
+ * The merchant descriptor of the merchant the card is transacting with.
900
+ */
901
+ merchant_descriptor: string;
902
+ /**
903
+ * The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
904
+ * ZIP code, where the first 5 and last 4 are separated by a dash.
905
+ */
906
+ merchant_postal_code: string | null;
907
+ /**
908
+ * The state the merchant resides in.
909
+ */
910
+ merchant_state: string | null;
911
+ /**
912
+ * Fields specific to the `network`.
913
+ */
914
+ network_details: CardFinancial.NetworkDetails;
915
+ /**
916
+ * Network-specific identifiers for a specific request or transaction.
917
+ */
918
+ network_identifiers: CardFinancial.NetworkIdentifiers;
919
+ /**
920
+ * The risk score generated by the card network. For Visa this is the Visa Advanced
921
+ * Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
922
+ * score is from 0 to 999, where 999 is the riskiest.
923
+ */
924
+ network_risk_score: number | null;
925
+ /**
926
+ * If the authorization was made in-person with a physical card, the Physical Card
927
+ * that was used.
928
+ */
929
+ physical_card_id: string | null;
930
+ /**
931
+ * The pending amount in the minor unit of the transaction's presentment currency.
932
+ */
933
+ presentment_amount: number;
934
+ /**
935
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
936
+ * transaction's presentment currency.
937
+ */
938
+ presentment_currency: string;
939
+ /**
940
+ * The processing category describes the intent behind the financial, such as
941
+ * whether it was used for bill payments or an automatic fuel dispenser.
942
+ *
943
+ * - `account_funding` - Account funding transactions are transactions used to
944
+ * e.g., fund an account or transfer funds between accounts.
945
+ * - `automatic_fuel_dispenser` - Automatic fuel dispenser authorizations occur
946
+ * when a card is used at a gas pump, prior to the actual transaction amount
947
+ * being known. They are followed by an advice message that updates the amount of
948
+ * the pending transaction.
949
+ * - `bill_payment` - A transaction used to pay a bill.
950
+ * - `original_credit` - Original credit transactions are used to send money to a
951
+ * cardholder.
952
+ * - `purchase` - A regular purchase.
953
+ * - `quasi_cash` - Quasi-cash transactions represent purchases of items which may
954
+ * be convertible to cash.
955
+ * - `refund` - A refund card authorization, sometimes referred to as a credit
956
+ * voucher authorization, where funds are credited to the cardholder.
957
+ * - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
958
+ * from an ATM or a point of sale.
959
+ * - `unknown` - The processing category is unknown.
960
+ */
961
+ processing_category: 'account_funding' | 'automatic_fuel_dispenser' | 'bill_payment' | 'original_credit' | 'purchase' | 'quasi_cash' | 'refund' | 'cash_disbursement' | 'unknown';
962
+ /**
963
+ * The identifier of the Real-Time Decision sent to approve or decline this
964
+ * transaction.
965
+ */
966
+ real_time_decision_id: string | null;
967
+ /**
968
+ * The terminal identifier (commonly abbreviated as TID) of the terminal the card
969
+ * is transacting with.
970
+ */
971
+ terminal_id: string | null;
972
+ /**
973
+ * The identifier of the Transaction associated with this Transaction.
974
+ */
975
+ transaction_id: string;
976
+ /**
977
+ * A constant representing the object's type. For this resource it will always be
978
+ * `card_financial`.
979
+ */
980
+ type: 'card_financial';
981
+ /**
982
+ * Fields related to verification of cardholder-provided values.
983
+ */
984
+ verification: CardFinancial.Verification;
985
+ [k: string]: unknown;
986
+ }
987
+ namespace CardFinancial {
988
+ /**
989
+ * Additional amounts associated with the card authorization, such as ATM
990
+ * surcharges fees. These are usually a subset of the `amount` field and are used
991
+ * to provide more detailed information about the transaction.
992
+ */
993
+ interface AdditionalAmounts {
994
+ /**
995
+ * The part of this transaction amount that was for clinic-related services.
996
+ */
997
+ clinic: AdditionalAmounts.Clinic | null;
998
+ /**
999
+ * The part of this transaction amount that was for dental-related services.
1000
+ */
1001
+ dental: AdditionalAmounts.Dental | null;
1002
+ /**
1003
+ * The original pre-authorized amount.
1004
+ */
1005
+ original: AdditionalAmounts.Original | null;
1006
+ /**
1007
+ * The part of this transaction amount that was for healthcare prescriptions.
1008
+ */
1009
+ prescription: AdditionalAmounts.Prescription | null;
1010
+ /**
1011
+ * The surcharge amount charged for this transaction by the merchant.
1012
+ */
1013
+ surcharge: AdditionalAmounts.Surcharge | null;
1014
+ /**
1015
+ * The total amount of a series of incremental authorizations, optionally provided.
1016
+ */
1017
+ total_cumulative: AdditionalAmounts.TotalCumulative | null;
1018
+ /**
1019
+ * The total amount of healthcare-related additional amounts.
1020
+ */
1021
+ total_healthcare: AdditionalAmounts.TotalHealthcare | null;
1022
+ /**
1023
+ * The part of this transaction amount that was for transit-related services.
1024
+ */
1025
+ transit: AdditionalAmounts.Transit | null;
1026
+ /**
1027
+ * An unknown additional amount.
1028
+ */
1029
+ unknown: AdditionalAmounts.Unknown | null;
1030
+ /**
1031
+ * The part of this transaction amount that was for vision-related services.
1032
+ */
1033
+ vision: AdditionalAmounts.Vision | null;
1034
+ }
1035
+ namespace AdditionalAmounts {
1036
+ /**
1037
+ * The part of this transaction amount that was for clinic-related services.
1038
+ */
1039
+ interface Clinic {
1040
+ /**
1041
+ * The amount in minor units of the `currency` field. The amount is positive if it
1042
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1043
+ * subtracted from the amount (such as a discount).
1044
+ */
1045
+ amount: number;
1046
+ /**
1047
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1048
+ * amount's currency.
1049
+ */
1050
+ currency: string;
1051
+ }
1052
+ /**
1053
+ * The part of this transaction amount that was for dental-related services.
1054
+ */
1055
+ interface Dental {
1056
+ /**
1057
+ * The amount in minor units of the `currency` field. The amount is positive if it
1058
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1059
+ * subtracted from the amount (such as a discount).
1060
+ */
1061
+ amount: number;
1062
+ /**
1063
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1064
+ * amount's currency.
1065
+ */
1066
+ currency: string;
1067
+ }
1068
+ /**
1069
+ * The original pre-authorized amount.
1070
+ */
1071
+ interface Original {
1072
+ /**
1073
+ * The amount in minor units of the `currency` field. The amount is positive if it
1074
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1075
+ * subtracted from the amount (such as a discount).
1076
+ */
1077
+ amount: number;
1078
+ /**
1079
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1080
+ * amount's currency.
1081
+ */
1082
+ currency: string;
1083
+ }
1084
+ /**
1085
+ * The part of this transaction amount that was for healthcare prescriptions.
1086
+ */
1087
+ interface Prescription {
1088
+ /**
1089
+ * The amount in minor units of the `currency` field. The amount is positive if it
1090
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1091
+ * subtracted from the amount (such as a discount).
1092
+ */
1093
+ amount: number;
1094
+ /**
1095
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1096
+ * amount's currency.
1097
+ */
1098
+ currency: string;
1099
+ }
1100
+ /**
1101
+ * The surcharge amount charged for this transaction by the merchant.
1102
+ */
1103
+ interface Surcharge {
1104
+ /**
1105
+ * The amount in minor units of the `currency` field. The amount is positive if it
1106
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1107
+ * subtracted from the amount (such as a discount).
1108
+ */
1109
+ amount: number;
1110
+ /**
1111
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1112
+ * amount's currency.
1113
+ */
1114
+ currency: string;
1115
+ }
1116
+ /**
1117
+ * The total amount of a series of incremental authorizations, optionally provided.
1118
+ */
1119
+ interface TotalCumulative {
1120
+ /**
1121
+ * The amount in minor units of the `currency` field. The amount is positive if it
1122
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1123
+ * subtracted from the amount (such as a discount).
1124
+ */
1125
+ amount: number;
1126
+ /**
1127
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1128
+ * amount's currency.
1129
+ */
1130
+ currency: string;
1131
+ }
1132
+ /**
1133
+ * The total amount of healthcare-related additional amounts.
1134
+ */
1135
+ interface TotalHealthcare {
1136
+ /**
1137
+ * The amount in minor units of the `currency` field. The amount is positive if it
1138
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1139
+ * subtracted from the amount (such as a discount).
1140
+ */
1141
+ amount: number;
1142
+ /**
1143
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1144
+ * amount's currency.
1145
+ */
1146
+ currency: string;
1147
+ }
1148
+ /**
1149
+ * The part of this transaction amount that was for transit-related services.
1150
+ */
1151
+ interface Transit {
1152
+ /**
1153
+ * The amount in minor units of the `currency` field. The amount is positive if it
1154
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1155
+ * subtracted from the amount (such as a discount).
1156
+ */
1157
+ amount: number;
1158
+ /**
1159
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1160
+ * amount's currency.
1161
+ */
1162
+ currency: string;
1163
+ }
1164
+ /**
1165
+ * An unknown additional amount.
1166
+ */
1167
+ interface Unknown {
1168
+ /**
1169
+ * The amount in minor units of the `currency` field. The amount is positive if it
1170
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1171
+ * subtracted from the amount (such as a discount).
1172
+ */
1173
+ amount: number;
1174
+ /**
1175
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1176
+ * amount's currency.
1177
+ */
1178
+ currency: string;
1179
+ }
1180
+ /**
1181
+ * The part of this transaction amount that was for vision-related services.
1182
+ */
1183
+ interface Vision {
1184
+ /**
1185
+ * The amount in minor units of the `currency` field. The amount is positive if it
1186
+ * is added to the amount (such as an ATM surcharge fee) and negative if it is
1187
+ * subtracted from the amount (such as a discount).
1188
+ */
1189
+ amount: number;
1190
+ /**
1191
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1192
+ * amount's currency.
1193
+ */
1194
+ currency: string;
1195
+ }
1196
+ }
1197
+ /**
1198
+ * Fields specific to the `network`.
1199
+ */
1200
+ interface NetworkDetails {
1201
+ /**
1202
+ * The payment network used to process this card authorization.
1203
+ *
1204
+ * - `visa` - Visa
1205
+ * - `pulse` - Pulse
1206
+ */
1207
+ category: 'visa' | 'pulse';
1208
+ /**
1209
+ * Fields specific to the `pulse` network.
1210
+ */
1211
+ pulse: NetworkDetails.Pulse | null;
1212
+ /**
1213
+ * Fields specific to the `visa` network.
1214
+ */
1215
+ visa: NetworkDetails.Visa | null;
1216
+ }
1217
+ namespace NetworkDetails {
1218
+ /**
1219
+ * Fields specific to the `pulse` network.
1220
+ */
1221
+ interface Pulse {
1222
+ }
1223
+ /**
1224
+ * Fields specific to the `visa` network.
1225
+ */
1226
+ interface Visa {
1227
+ /**
1228
+ * For electronic commerce transactions, this identifies the level of security used
1229
+ * in obtaining the customer's payment credential. For mail or telephone order
1230
+ * transactions, identifies the type of mail or telephone order.
1231
+ *
1232
+ * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
1233
+ * that the transaction is a mail/phone order purchase, not a recurring
1234
+ * transaction or installment payment. For domestic transactions in the US
1235
+ * region, this value may also indicate one bill payment transaction in the
1236
+ * card-present or card-absent environments.
1237
+ * - `recurring` - Recurring transaction: Payment indicator used to indicate a
1238
+ * recurring transaction that originates from an acquirer in the US region.
1239
+ * - `installment` - Installment payment: Payment indicator used to indicate one
1240
+ * purchase of goods or services that is billed to the account in multiple
1241
+ * charges over a period of time agreed upon by the cardholder and merchant from
1242
+ * transactions that originate from an acquirer in the US region.
1243
+ * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
1244
+ * indicate that the type of mail/telephone order is unknown.
1245
+ * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
1246
+ * indicate that the electronic commerce transaction has been authenticated using
1247
+ * e.g., 3-D Secure
1248
+ * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
1249
+ * Non-authenticated security transaction at a 3-D Secure-capable merchant, and
1250
+ * merchant attempted to authenticate the cardholder using 3-D Secure: Use to
1251
+ * identify an electronic commerce transaction where the merchant attempted to
1252
+ * authenticate the cardholder using 3-D Secure, but was unable to complete the
1253
+ * authentication because the issuer or cardholder does not participate in the
1254
+ * 3-D Secure program.
1255
+ * - `non_authenticated_security_transaction` - Non-authenticated security
1256
+ * transaction: Use to identify an electronic commerce transaction that uses data
1257
+ * encryption for security however, cardholder authentication is not performed
1258
+ * using 3-D Secure.
1259
+ * - `non_secure_transaction` - Non-secure transaction: Use to identify an
1260
+ * electronic commerce transaction that has no data protection.
1261
+ */
1262
+ electronic_commerce_indicator: 'mail_phone_order' | 'recurring' | 'installment' | 'unknown_mail_phone_order' | 'secure_electronic_commerce' | 'non_authenticated_security_transaction_at_3ds_capable_merchant' | 'non_authenticated_security_transaction' | 'non_secure_transaction' | null;
1263
+ /**
1264
+ * The method used to enter the cardholder's primary account number and card
1265
+ * expiration date.
1266
+ *
1267
+ * - `unknown` - Unknown
1268
+ * - `manual` - Manual key entry
1269
+ * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
1270
+ * value
1271
+ * - `optical_code` - Optical code
1272
+ * - `integrated_circuit_card` - Contact chip card
1273
+ * - `contactless` - Contactless read of chip card
1274
+ * - `credential_on_file` - Transaction initiated using a credential that has
1275
+ * previously been stored on file
1276
+ * - `magnetic_stripe` - Magnetic stripe read
1277
+ * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
1278
+ * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
1279
+ * verification value
1280
+ */
1281
+ point_of_service_entry_mode: 'unknown' | 'manual' | 'magnetic_stripe_no_cvv' | 'optical_code' | 'integrated_circuit_card' | 'contactless' | 'credential_on_file' | 'magnetic_stripe' | 'contactless_magnetic_stripe' | 'integrated_circuit_card_no_cvv' | null;
1282
+ /**
1283
+ * Only present when `actioner: network`. Describes why a card authorization was
1284
+ * approved or declined by Visa through stand-in processing.
1285
+ *
1286
+ * - `issuer_error` - Increase failed to process the authorization in a timely
1287
+ * manner.
1288
+ * - `invalid_physical_card` - The physical card read had an invalid CVV, dCVV, or
1289
+ * authorization request cryptogram.
1290
+ * - `invalid_cardholder_authentication_verification_value` - The 3DS cardholder
1291
+ * authentication verification value was invalid.
1292
+ * - `internal_visa_error` - An internal Visa error occurred. Visa uses this reason
1293
+ * code for certain expected occurrences as well, such as Application Transaction
1294
+ * Counter (ATC) replays.
1295
+ * - `merchant_transaction_advisory_service_authentication_required` - The merchant
1296
+ * has enabled Visa's Transaction Advisory Service and requires further
1297
+ * authentication to perform the transaction. In practice this is often utilized
1298
+ * at fuel pumps to tell the cardholder to see the cashier.
1299
+ * - `payment_fraud_disruption_acquirer_block` - The transaction was blocked by
1300
+ * Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior,
1301
+ * such as card testing.
1302
+ * - `other` - An unspecific reason for stand-in processing.
1303
+ */
1304
+ stand_in_processing_reason: 'issuer_error' | 'invalid_physical_card' | 'invalid_cardholder_authentication_verification_value' | 'internal_visa_error' | 'merchant_transaction_advisory_service_authentication_required' | 'payment_fraud_disruption_acquirer_block' | 'other' | null;
1305
+ }
1306
+ }
1307
+ /**
1308
+ * Network-specific identifiers for a specific request or transaction.
1309
+ */
1310
+ interface NetworkIdentifiers {
1311
+ /**
1312
+ * The randomly generated 6-character Authorization Identification Response code
1313
+ * sent back to the acquirer in an approved response.
1314
+ */
1315
+ authorization_identification_response: string | null;
1316
+ /**
1317
+ * A life-cycle identifier used across e.g., an authorization and a reversal.
1318
+ * Expected to be unique per acquirer within a window of time. For some card
1319
+ * networks the retrieval reference number includes the trace counter.
1320
+ */
1321
+ retrieval_reference_number: string | null;
1322
+ /**
1323
+ * A counter used to verify an individual authorization. Expected to be unique per
1324
+ * acquirer within a window of time.
1325
+ */
1326
+ trace_number: string | null;
1327
+ /**
1328
+ * A globally unique transaction identifier provided by the card network, used
1329
+ * across multiple life-cycle requests.
1330
+ */
1331
+ transaction_id: string | null;
1332
+ }
1333
+ /**
1334
+ * Fields related to verification of cardholder-provided values.
1335
+ */
1336
+ interface Verification {
1337
+ /**
1338
+ * Fields related to verification of the Card Verification Code, a 3-digit code on
1339
+ * the back of the card.
1340
+ */
1341
+ card_verification_code: Verification.CardVerificationCode;
1342
+ /**
1343
+ * Cardholder address provided in the authorization request and the address on file
1344
+ * we verified it against.
1345
+ */
1346
+ cardholder_address: Verification.CardholderAddress;
1347
+ }
1348
+ namespace Verification {
1349
+ /**
1350
+ * Fields related to verification of the Card Verification Code, a 3-digit code on
1351
+ * the back of the card.
1352
+ */
1353
+ interface CardVerificationCode {
1354
+ /**
1355
+ * The result of verifying the Card Verification Code.
1356
+ *
1357
+ * - `not_checked` - No card verification code was provided in the authorization
1358
+ * request.
1359
+ * - `match` - The card verification code matched the one on file.
1360
+ * - `no_match` - The card verification code did not match the one on file.
1361
+ */
1362
+ result: 'not_checked' | 'match' | 'no_match';
1363
+ }
1364
+ /**
1365
+ * Cardholder address provided in the authorization request and the address on file
1366
+ * we verified it against.
1367
+ */
1368
+ interface CardholderAddress {
1369
+ /**
1370
+ * Line 1 of the address on file for the cardholder.
1371
+ */
1372
+ actual_line1: string | null;
1373
+ /**
1374
+ * The postal code of the address on file for the cardholder.
1375
+ */
1376
+ actual_postal_code: string | null;
1377
+ /**
1378
+ * The cardholder address line 1 provided for verification in the authorization
1379
+ * request.
1380
+ */
1381
+ provided_line1: string | null;
1382
+ /**
1383
+ * The postal code provided for verification in the authorization request.
1384
+ */
1385
+ provided_postal_code: string | null;
1386
+ /**
1387
+ * The address verification result returned to the card network.
1388
+ *
1389
+ * - `not_checked` - No address information was provided in the authorization
1390
+ * request.
1391
+ * - `postal_code_match_address_no_match` - Postal code matches, but the street
1392
+ * address does not match or was not provided.
1393
+ * - `postal_code_no_match_address_match` - Postal code does not match, but the
1394
+ * street address matches or was not provided.
1395
+ * - `match` - Postal code and street address match.
1396
+ * - `no_match` - Postal code and street address do not match.
1397
+ * - `postal_code_match_address_not_checked` - Postal code matches, but the street
1398
+ * address was not verified. (deprecated)
1399
+ */
1400
+ result: 'not_checked' | 'postal_code_match_address_no_match' | 'postal_code_no_match_address_match' | 'match' | 'no_match' | 'postal_code_match_address_not_checked';
1401
+ }
1402
+ }
1403
+ }
1404
+ /**
1405
+ * A Card Push Transfer Acceptance object. This field will be present in the JSON
1406
+ * response if and only if `category` is equal to `card_push_transfer_acceptance`.
1407
+ * A Card Push Transfer Acceptance is created when an Outbound Card Push Transfer
1408
+ * sent from Increase is accepted by the receiving bank.
1409
+ */
1410
+ interface CardPushTransferAcceptance {
1411
+ /**
1412
+ * The transfer amount in USD cents.
1413
+ */
1414
+ settlement_amount: number;
1415
+ /**
1416
+ * The identifier of the Card Push Transfer that led to this Transaction.
1417
+ */
1418
+ transfer_id: string;
1419
+ [k: string]: unknown;
1420
+ }
1421
+ /**
1422
+ * A Card Refund object. This field will be present in the JSON response if and
1423
+ * only if `category` is equal to `card_refund`. Card Refunds move money back to
1424
+ * the cardholder. While they are usually connected to a Card Settlement an
1425
+ * acquirer can also refund money directly to a card without relation to a
1426
+ * transaction.
1427
+ */
1428
+ interface CardRefund {
1429
+ /**
1430
+ * The Card Refund identifier.
1431
+ */
1432
+ id: string;
1433
+ /**
1434
+ * The amount in the minor unit of the transaction's settlement currency. For
1435
+ * dollars, for example, this is cents.
1436
+ */
1437
+ amount: number;
1438
+ /**
1439
+ * The ID of the Card Payment this transaction belongs to.
1440
+ */
1441
+ card_payment_id: string;
1442
+ /**
1443
+ * Cashback debited for this transaction, if eligible. Cashback is paid out in
1444
+ * aggregate, monthly.
1445
+ */
1446
+ cashback: CardRefund.Cashback | null;
1447
+ /**
1448
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1449
+ * transaction's settlement currency.
1450
+ *
1451
+ * - `USD` - US Dollar (USD)
1452
+ */
1453
+ currency: 'USD';
1454
+ /**
1455
+ * Interchange assessed as a part of this transaciton.
1456
+ */
1457
+ interchange: CardRefund.Interchange | null;
1458
+ /**
1459
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
1460
+ * is transacting with.
1461
+ */
1462
+ merchant_acceptor_id: string;
1463
+ /**
1464
+ * The 4-digit MCC describing the merchant's business.
1465
+ */
1466
+ merchant_category_code: string;
1467
+ /**
1468
+ * The city the merchant resides in.
1469
+ */
1470
+ merchant_city: string;
1471
+ /**
1472
+ * The country the merchant resides in.
1473
+ */
1474
+ merchant_country: string;
1475
+ /**
1476
+ * The name of the merchant.
1477
+ */
1478
+ merchant_name: string;
1479
+ /**
1480
+ * The merchant's postal code. For US merchants this is always a 5-digit ZIP code.
1481
+ */
1482
+ merchant_postal_code: string | null;
1483
+ /**
1484
+ * The state the merchant resides in.
1485
+ */
1486
+ merchant_state: string | null;
1487
+ /**
1488
+ * Network-specific identifiers for this refund.
1489
+ */
1490
+ network_identifiers: CardRefund.NetworkIdentifiers;
1491
+ /**
1492
+ * The amount in the minor unit of the transaction's presentment currency.
1493
+ */
1494
+ presentment_amount: number;
1495
+ /**
1496
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1497
+ * transaction's presentment currency.
1498
+ */
1499
+ presentment_currency: string;
1500
+ /**
1501
+ * Additional details about the card purchase, such as tax and industry-specific
1502
+ * fields.
1503
+ */
1504
+ purchase_details: CardRefund.PurchaseDetails | null;
1505
+ /**
1506
+ * The identifier of the Transaction associated with this Transaction.
1507
+ */
1508
+ transaction_id: string;
1509
+ /**
1510
+ * A constant representing the object's type. For this resource it will always be
1511
+ * `card_refund`.
1512
+ */
1513
+ type: 'card_refund';
1514
+ [k: string]: unknown;
1515
+ }
1516
+ namespace CardRefund {
1517
+ /**
1518
+ * Cashback debited for this transaction, if eligible. Cashback is paid out in
1519
+ * aggregate, monthly.
1520
+ */
1521
+ interface Cashback {
1522
+ /**
1523
+ * The cashback amount given as a string containing a decimal number. The amount is
1524
+ * a positive number if it will be credited to you (e.g., settlements) and a
1525
+ * negative number if it will be debited (e.g., refunds).
1526
+ */
1527
+ amount: string;
1528
+ /**
1529
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
1530
+ *
1531
+ * - `USD` - US Dollar (USD)
1532
+ */
1533
+ currency: 'USD';
1534
+ }
1535
+ /**
1536
+ * Interchange assessed as a part of this transaciton.
1537
+ */
1538
+ interface Interchange {
1539
+ /**
1540
+ * The interchange amount given as a string containing a decimal number in major
1541
+ * units (so e.g., "3.14" for $3.14). The amount is a positive number if it is
1542
+ * credited to Increase (e.g., settlements) and a negative number if it is debited
1543
+ * (e.g., refunds).
1544
+ */
1545
+ amount: string;
1546
+ /**
1547
+ * The card network specific interchange code.
1548
+ */
1549
+ code: string | null;
1550
+ /**
1551
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange
1552
+ * reimbursement.
1553
+ *
1554
+ * - `USD` - US Dollar (USD)
1555
+ */
1556
+ currency: 'USD';
1557
+ }
1558
+ /**
1559
+ * Network-specific identifiers for this refund.
1560
+ */
1561
+ interface NetworkIdentifiers {
1562
+ /**
1563
+ * A network assigned business ID that identifies the acquirer that processed this
1564
+ * transaction.
1565
+ */
1566
+ acquirer_business_id: string;
1567
+ /**
1568
+ * A globally unique identifier for this settlement.
1569
+ */
1570
+ acquirer_reference_number: string;
1571
+ /**
1572
+ * The randomly generated 6-character Authorization Identification Response code
1573
+ * sent back to the acquirer in an approved response.
1574
+ */
1575
+ authorization_identification_response: string | null;
1576
+ /**
1577
+ * A globally unique transaction identifier provided by the card network, used
1578
+ * across multiple life-cycle requests.
1579
+ */
1580
+ transaction_id: string | null;
1581
+ }
1582
+ /**
1583
+ * Additional details about the card purchase, such as tax and industry-specific
1584
+ * fields.
1585
+ */
1586
+ interface PurchaseDetails {
1587
+ /**
1588
+ * Fields specific to car rentals.
1589
+ */
1590
+ car_rental: PurchaseDetails.CarRental | null;
1591
+ /**
1592
+ * An identifier from the merchant for the customer or consumer.
1593
+ */
1594
+ customer_reference_identifier: string | null;
1595
+ /**
1596
+ * The state or provincial tax amount in minor units.
1597
+ */
1598
+ local_tax_amount: number | null;
1599
+ /**
1600
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1601
+ * assessed.
1602
+ */
1603
+ local_tax_currency: string | null;
1604
+ /**
1605
+ * Fields specific to lodging.
1606
+ */
1607
+ lodging: PurchaseDetails.Lodging | null;
1608
+ /**
1609
+ * The national tax amount in minor units.
1610
+ */
1611
+ national_tax_amount: number | null;
1612
+ /**
1613
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1614
+ * assessed.
1615
+ */
1616
+ national_tax_currency: string | null;
1617
+ /**
1618
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
1619
+ */
1620
+ purchase_identifier: string | null;
1621
+ /**
1622
+ * The format of the purchase identifier.
1623
+ *
1624
+ * - `free_text` - Free text
1625
+ * - `order_number` - Order number
1626
+ * - `rental_agreement_number` - Rental agreement number
1627
+ * - `hotel_folio_number` - Hotel folio number
1628
+ * - `invoice_number` - Invoice number
1629
+ */
1630
+ purchase_identifier_format: 'free_text' | 'order_number' | 'rental_agreement_number' | 'hotel_folio_number' | 'invoice_number' | null;
1631
+ /**
1632
+ * Fields specific to travel.
1633
+ */
1634
+ travel: PurchaseDetails.Travel | null;
1635
+ }
1636
+ namespace PurchaseDetails {
1637
+ /**
1638
+ * Fields specific to car rentals.
1639
+ */
1640
+ interface CarRental {
1641
+ /**
1642
+ * Code indicating the vehicle's class.
1643
+ */
1644
+ car_class_code: string | null;
1645
+ /**
1646
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
1647
+ * transaction, the scheduled pick up date.
1648
+ */
1649
+ checkout_date: string | null;
1650
+ /**
1651
+ * Daily rate being charged for the vehicle.
1652
+ */
1653
+ daily_rental_rate_amount: number | null;
1654
+ /**
1655
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
1656
+ * rate.
1657
+ */
1658
+ daily_rental_rate_currency: string | null;
1659
+ /**
1660
+ * Number of days the vehicle was rented.
1661
+ */
1662
+ days_rented: number | null;
1663
+ /**
1664
+ * Additional charges (gas, late fee, etc.) being billed.
1665
+ *
1666
+ * - `no_extra_charge` - No extra charge
1667
+ * - `gas` - Gas
1668
+ * - `extra_mileage` - Extra mileage
1669
+ * - `late_return` - Late return
1670
+ * - `one_way_service_fee` - One way service fee
1671
+ * - `parking_violation` - Parking violation
1672
+ */
1673
+ extra_charges: 'no_extra_charge' | 'gas' | 'extra_mileage' | 'late_return' | 'one_way_service_fee' | 'parking_violation' | null;
1674
+ /**
1675
+ * Fuel charges for the vehicle.
1676
+ */
1677
+ fuel_charges_amount: number | null;
1678
+ /**
1679
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
1680
+ * assessed.
1681
+ */
1682
+ fuel_charges_currency: string | null;
1683
+ /**
1684
+ * Any insurance being charged for the vehicle.
1685
+ */
1686
+ insurance_charges_amount: number | null;
1687
+ /**
1688
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
1689
+ * charges assessed.
1690
+ */
1691
+ insurance_charges_currency: string | null;
1692
+ /**
1693
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
1694
+ * not actually rented (that is, a "no-show" charge).
1695
+ *
1696
+ * - `not_applicable` - Not applicable
1697
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
1698
+ */
1699
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
1700
+ /**
1701
+ * Charges for returning the vehicle at a different location than where it was
1702
+ * picked up.
1703
+ */
1704
+ one_way_drop_off_charges_amount: number | null;
1705
+ /**
1706
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
1707
+ * drop-off charges assessed.
1708
+ */
1709
+ one_way_drop_off_charges_currency: string | null;
1710
+ /**
1711
+ * Name of the person renting the vehicle.
1712
+ */
1713
+ renter_name: string | null;
1714
+ /**
1715
+ * Weekly rate being charged for the vehicle.
1716
+ */
1717
+ weekly_rental_rate_amount: number | null;
1718
+ /**
1719
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
1720
+ * rental rate.
1721
+ */
1722
+ weekly_rental_rate_currency: string | null;
1723
+ }
1724
+ /**
1725
+ * Fields specific to lodging.
1726
+ */
1727
+ interface Lodging {
1728
+ /**
1729
+ * Date the customer checked in.
1730
+ */
1731
+ check_in_date: string | null;
1732
+ /**
1733
+ * Daily rate being charged for the room.
1734
+ */
1735
+ daily_room_rate_amount: number | null;
1736
+ /**
1737
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
1738
+ * rate.
1739
+ */
1740
+ daily_room_rate_currency: string | null;
1741
+ /**
1742
+ * Additional charges (phone, late check-out, etc.) being billed.
1743
+ *
1744
+ * - `no_extra_charge` - No extra charge
1745
+ * - `restaurant` - Restaurant
1746
+ * - `gift_shop` - Gift shop
1747
+ * - `mini_bar` - Mini bar
1748
+ * - `telephone` - Telephone
1749
+ * - `other` - Other
1750
+ * - `laundry` - Laundry
1751
+ */
1752
+ extra_charges: 'no_extra_charge' | 'restaurant' | 'gift_shop' | 'mini_bar' | 'telephone' | 'other' | 'laundry' | null;
1753
+ /**
1754
+ * Folio cash advances for the room.
1755
+ */
1756
+ folio_cash_advances_amount: number | null;
1757
+ /**
1758
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
1759
+ * advances.
1760
+ */
1761
+ folio_cash_advances_currency: string | null;
1762
+ /**
1763
+ * Food and beverage charges for the room.
1764
+ */
1765
+ food_beverage_charges_amount: number | null;
1766
+ /**
1767
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
1768
+ * beverage charges.
1769
+ */
1770
+ food_beverage_charges_currency: string | null;
1771
+ /**
1772
+ * Indicator that the cardholder is being billed for a reserved room that was not
1773
+ * actually used.
1774
+ *
1775
+ * - `not_applicable` - Not applicable
1776
+ * - `no_show` - No show
1777
+ */
1778
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
1779
+ /**
1780
+ * Prepaid expenses being charged for the room.
1781
+ */
1782
+ prepaid_expenses_amount: number | null;
1783
+ /**
1784
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
1785
+ * expenses.
1786
+ */
1787
+ prepaid_expenses_currency: string | null;
1788
+ /**
1789
+ * Number of nights the room was rented.
1790
+ */
1791
+ room_nights: number | null;
1792
+ /**
1793
+ * Total room tax being charged.
1794
+ */
1795
+ total_room_tax_amount: number | null;
1796
+ /**
1797
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
1798
+ * tax.
1799
+ */
1800
+ total_room_tax_currency: string | null;
1801
+ /**
1802
+ * Total tax being charged for the room.
1803
+ */
1804
+ total_tax_amount: number | null;
1805
+ /**
1806
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
1807
+ * assessed.
1808
+ */
1809
+ total_tax_currency: string | null;
1810
+ }
1811
+ /**
1812
+ * Fields specific to travel.
1813
+ */
1814
+ interface Travel {
1815
+ /**
1816
+ * Ancillary purchases in addition to the airfare.
1817
+ */
1818
+ ancillary: Travel.Ancillary | null;
1819
+ /**
1820
+ * Indicates the computerized reservation system used to book the ticket.
1821
+ */
1822
+ computerized_reservation_system: string | null;
1823
+ /**
1824
+ * Indicates the reason for a credit to the cardholder.
1825
+ *
1826
+ * - `no_credit` - No credit
1827
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1828
+ * ancillary purchase cancellation
1829
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1830
+ * Airline ticket and passenger transport ancillary purchase cancellation
1831
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
1832
+ * - `other` - Other
1833
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
1834
+ */
1835
+ credit_reason_indicator: 'no_credit' | 'passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_cancellation' | 'other' | 'partial_refund_of_airline_ticket' | null;
1836
+ /**
1837
+ * Date of departure.
1838
+ */
1839
+ departure_date: string | null;
1840
+ /**
1841
+ * Code for the originating city or airport.
1842
+ */
1843
+ origination_city_airport_code: string | null;
1844
+ /**
1845
+ * Name of the passenger.
1846
+ */
1847
+ passenger_name: string | null;
1848
+ /**
1849
+ * Indicates whether this ticket is non-refundable.
1850
+ *
1851
+ * - `no_restrictions` - No restrictions
1852
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
1853
+ */
1854
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
1855
+ /**
1856
+ * Indicates why a ticket was changed.
1857
+ *
1858
+ * - `none` - None
1859
+ * - `change_to_existing_ticket` - Change to existing ticket
1860
+ * - `new_ticket` - New ticket
1861
+ */
1862
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
1863
+ /**
1864
+ * Ticket number.
1865
+ */
1866
+ ticket_number: string | null;
1867
+ /**
1868
+ * Code for the travel agency if the ticket was issued by a travel agency.
1869
+ */
1870
+ travel_agency_code: string | null;
1871
+ /**
1872
+ * Name of the travel agency if the ticket was issued by a travel agency.
1873
+ */
1874
+ travel_agency_name: string | null;
1875
+ /**
1876
+ * Fields specific to each leg of the journey.
1877
+ */
1878
+ trip_legs: Array<Travel.TripLeg> | null;
1879
+ }
1880
+ namespace Travel {
1881
+ /**
1882
+ * Ancillary purchases in addition to the airfare.
1883
+ */
1884
+ interface Ancillary {
1885
+ /**
1886
+ * If this purchase has a connection or relationship to another purchase, such as a
1887
+ * baggage fee for a passenger transport ticket, this field should contain the
1888
+ * ticket document number for the other purchase.
1889
+ */
1890
+ connected_ticket_document_number: string | null;
1891
+ /**
1892
+ * Indicates the reason for a credit to the cardholder.
1893
+ *
1894
+ * - `no_credit` - No credit
1895
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1896
+ * ancillary purchase cancellation
1897
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1898
+ * Airline ticket and passenger transport ancillary purchase cancellation
1899
+ * - `other` - Other
1900
+ */
1901
+ credit_reason_indicator: 'no_credit' | 'passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation' | 'other' | null;
1902
+ /**
1903
+ * Name of the passenger or description of the ancillary purchase.
1904
+ */
1905
+ passenger_name_or_description: string | null;
1906
+ /**
1907
+ * Additional travel charges, such as baggage fees.
1908
+ */
1909
+ services: Array<Ancillary.Service>;
1910
+ /**
1911
+ * Ticket document number.
1912
+ */
1913
+ ticket_document_number: string | null;
1914
+ }
1915
+ namespace Ancillary {
1916
+ interface Service {
1917
+ /**
1918
+ * Category of the ancillary service.
1919
+ *
1920
+ * - `none` - None
1921
+ * - `bundled_service` - Bundled service
1922
+ * - `baggage_fee` - Baggage fee
1923
+ * - `change_fee` - Change fee
1924
+ * - `cargo` - Cargo
1925
+ * - `carbon_offset` - Carbon offset
1926
+ * - `frequent_flyer` - Frequent flyer
1927
+ * - `gift_card` - Gift card
1928
+ * - `ground_transport` - Ground transport
1929
+ * - `in_flight_entertainment` - In-flight entertainment
1930
+ * - `lounge` - Lounge
1931
+ * - `medical` - Medical
1932
+ * - `meal_beverage` - Meal beverage
1933
+ * - `other` - Other
1934
+ * - `passenger_assist_fee` - Passenger assist fee
1935
+ * - `pets` - Pets
1936
+ * - `seat_fees` - Seat fees
1937
+ * - `standby` - Standby
1938
+ * - `service_fee` - Service fee
1939
+ * - `store` - Store
1940
+ * - `travel_service` - Travel service
1941
+ * - `unaccompanied_travel` - Unaccompanied travel
1942
+ * - `upgrades` - Upgrades
1943
+ * - `wifi` - Wi-fi
1944
+ */
1945
+ category: 'none' | 'bundled_service' | 'baggage_fee' | 'change_fee' | 'cargo' | 'carbon_offset' | 'frequent_flyer' | 'gift_card' | 'ground_transport' | 'in_flight_entertainment' | 'lounge' | 'medical' | 'meal_beverage' | 'other' | 'passenger_assist_fee' | 'pets' | 'seat_fees' | 'standby' | 'service_fee' | 'store' | 'travel_service' | 'unaccompanied_travel' | 'upgrades' | 'wifi' | null;
1946
+ /**
1947
+ * Sub-category of the ancillary service, free-form.
1948
+ */
1949
+ sub_category: string | null;
1950
+ }
1951
+ }
1952
+ interface TripLeg {
1953
+ /**
1954
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
1955
+ */
1956
+ carrier_code: string | null;
1957
+ /**
1958
+ * Code for the destination city or airport.
1959
+ */
1960
+ destination_city_airport_code: string | null;
1961
+ /**
1962
+ * Fare basis code.
1963
+ */
1964
+ fare_basis_code: string | null;
1965
+ /**
1966
+ * Flight number.
1967
+ */
1968
+ flight_number: string | null;
1969
+ /**
1970
+ * Service class (e.g., first class, business class, etc.).
1971
+ */
1972
+ service_class: string | null;
1973
+ /**
1974
+ * Indicates whether a stopover is allowed on this ticket.
1975
+ *
1976
+ * - `none` - None
1977
+ * - `stop_over_allowed` - Stop over allowed
1978
+ * - `stop_over_not_allowed` - Stop over not allowed
1979
+ */
1980
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
1981
+ }
1982
+ }
1983
+ }
1984
+ }
1985
+ /**
1986
+ * A Card Revenue Payment object. This field will be present in the JSON response
1987
+ * if and only if `category` is equal to `card_revenue_payment`. Card Revenue
1988
+ * Payments reflect earnings from fees on card transactions.
1989
+ */
1990
+ interface CardRevenuePayment {
1991
+ /**
1992
+ * The amount in the minor unit of the transaction's currency. For dollars, for
1993
+ * example, this is cents.
1994
+ */
1995
+ amount: number;
1996
+ /**
1997
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
1998
+ * currency.
1999
+ *
2000
+ * - `USD` - US Dollar (USD)
2001
+ */
2002
+ currency: 'USD';
2003
+ /**
2004
+ * The end of the period for which this transaction paid interest.
2005
+ */
2006
+ period_end: string;
2007
+ /**
2008
+ * The start of the period for which this transaction paid interest.
2009
+ */
2010
+ period_start: string;
2011
+ /**
2012
+ * The account the card belonged to.
2013
+ */
2014
+ transacted_on_account_id: string | null;
2015
+ [k: string]: unknown;
2016
+ }
2017
+ /**
2018
+ * A Card Settlement object. This field will be present in the JSON response if and
2019
+ * only if `category` is equal to `card_settlement`. Card Settlements are card
2020
+ * transactions that have cleared and settled. While a settlement is usually
2021
+ * preceded by an authorization, an acquirer can also directly clear a transaction
2022
+ * without first authorizing it.
2023
+ */
2024
+ interface CardSettlement {
2025
+ /**
2026
+ * The Card Settlement identifier.
2027
+ */
2028
+ id: string;
2029
+ /**
2030
+ * The amount in the minor unit of the transaction's settlement currency. For
2031
+ * dollars, for example, this is cents.
2032
+ */
2033
+ amount: number;
2034
+ /**
2035
+ * The Card Authorization that was created prior to this Card Settlement, if one
2036
+ * exists.
2037
+ */
2038
+ card_authorization: string | null;
2039
+ /**
2040
+ * The ID of the Card Payment this transaction belongs to.
2041
+ */
2042
+ card_payment_id: string;
2043
+ /**
2044
+ * Cashback earned on this transaction, if eligible. Cashback is paid out in
2045
+ * aggregate, monthly.
2046
+ */
2047
+ cashback: CardSettlement.Cashback | null;
2048
+ /**
2049
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
2050
+ * transaction's settlement currency.
2051
+ *
2052
+ * - `USD` - US Dollar (USD)
2053
+ */
2054
+ currency: 'USD';
2055
+ /**
2056
+ * Interchange assessed as a part of this transaction.
2057
+ */
2058
+ interchange: CardSettlement.Interchange | null;
2059
+ /**
2060
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
2061
+ * is transacting with.
2062
+ */
2063
+ merchant_acceptor_id: string;
2064
+ /**
2065
+ * The 4-digit MCC describing the merchant's business.
2066
+ */
2067
+ merchant_category_code: string;
2068
+ /**
2069
+ * The city the merchant resides in.
2070
+ */
2071
+ merchant_city: string;
2072
+ /**
2073
+ * The country the merchant resides in.
2074
+ */
2075
+ merchant_country: string;
2076
+ /**
2077
+ * The name of the merchant.
2078
+ */
2079
+ merchant_name: string;
2080
+ /**
2081
+ * The merchant's postal code. For US merchants this is always a 5-digit ZIP code.
2082
+ */
2083
+ merchant_postal_code: string | null;
2084
+ /**
2085
+ * The state the merchant resides in.
2086
+ */
2087
+ merchant_state: string | null;
2088
+ /**
2089
+ * The card network on which this transaction was processed.
2090
+ *
2091
+ * - `visa` - Visa
2092
+ * - `pulse` - Pulse
2093
+ */
2094
+ network: 'visa' | 'pulse';
2095
+ /**
2096
+ * Network-specific identifiers for this refund.
2097
+ */
2098
+ network_identifiers: CardSettlement.NetworkIdentifiers;
2099
+ /**
2100
+ * The identifier of the Pending Transaction associated with this Transaction.
2101
+ */
2102
+ pending_transaction_id: string | null;
2103
+ /**
2104
+ * The amount in the minor unit of the transaction's presentment currency.
2105
+ */
2106
+ presentment_amount: number;
2107
+ /**
2108
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
2109
+ * transaction's presentment currency.
2110
+ */
2111
+ presentment_currency: string;
2112
+ /**
2113
+ * Additional details about the card purchase, such as tax and industry-specific
2114
+ * fields.
2115
+ */
2116
+ purchase_details: CardSettlement.PurchaseDetails | null;
2117
+ /**
2118
+ * Surcharge amount details, if applicable. The amount is positive if the surcharge
2119
+ * is added to to the overall transaction amount (surcharge), and negative if the
2120
+ * surcharge is deducted from the overall transaction amount (discount).
2121
+ */
2122
+ surcharge: CardSettlement.Surcharge | null;
2123
+ /**
2124
+ * The identifier of the Transaction associated with this Transaction.
2125
+ */
2126
+ transaction_id: string;
2127
+ /**
2128
+ * A constant representing the object's type. For this resource it will always be
2129
+ * `card_settlement`.
2130
+ */
2131
+ type: 'card_settlement';
2132
+ [k: string]: unknown;
2133
+ }
2134
+ namespace CardSettlement {
2135
+ /**
2136
+ * Cashback earned on this transaction, if eligible. Cashback is paid out in
2137
+ * aggregate, monthly.
2138
+ */
2139
+ interface Cashback {
2140
+ /**
2141
+ * The cashback amount given as a string containing a decimal number. The amount is
2142
+ * a positive number if it will be credited to you (e.g., settlements) and a
2143
+ * negative number if it will be debited (e.g., refunds).
2144
+ */
2145
+ amount: string;
2146
+ /**
2147
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
2148
+ *
2149
+ * - `USD` - US Dollar (USD)
2150
+ */
2151
+ currency: 'USD';
2152
+ }
2153
+ /**
2154
+ * Interchange assessed as a part of this transaction.
2155
+ */
2156
+ interface Interchange {
2157
+ /**
2158
+ * The interchange amount given as a string containing a decimal number in major
2159
+ * units (so e.g., "3.14" for $3.14). The amount is a positive number if it is
2160
+ * credited to Increase (e.g., settlements) and a negative number if it is debited
2161
+ * (e.g., refunds).
2162
+ */
2163
+ amount: string;
2164
+ /**
2165
+ * The card network specific interchange code.
2166
+ */
2167
+ code: string | null;
2168
+ /**
2169
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange
2170
+ * reimbursement.
2171
+ *
2172
+ * - `USD` - US Dollar (USD)
2173
+ */
2174
+ currency: 'USD';
2175
+ }
2176
+ /**
2177
+ * Network-specific identifiers for this refund.
2178
+ */
2179
+ interface NetworkIdentifiers {
2180
+ /**
2181
+ * A network assigned business ID that identifies the acquirer that processed this
2182
+ * transaction.
2183
+ */
2184
+ acquirer_business_id: string;
2185
+ /**
2186
+ * A globally unique identifier for this settlement.
2187
+ */
2188
+ acquirer_reference_number: string;
2189
+ /**
2190
+ * The randomly generated 6-character Authorization Identification Response code
2191
+ * sent back to the acquirer in an approved response.
2192
+ */
2193
+ authorization_identification_response: string | null;
2194
+ /**
2195
+ * A globally unique transaction identifier provided by the card network, used
2196
+ * across multiple life-cycle requests.
2197
+ */
2198
+ transaction_id: string | null;
2199
+ }
2200
+ /**
2201
+ * Additional details about the card purchase, such as tax and industry-specific
2202
+ * fields.
2203
+ */
2204
+ interface PurchaseDetails {
2205
+ /**
2206
+ * Fields specific to car rentals.
2207
+ */
2208
+ car_rental: PurchaseDetails.CarRental | null;
2209
+ /**
2210
+ * An identifier from the merchant for the customer or consumer.
2211
+ */
2212
+ customer_reference_identifier: string | null;
2213
+ /**
2214
+ * The state or provincial tax amount in minor units.
2215
+ */
2216
+ local_tax_amount: number | null;
2217
+ /**
2218
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
2219
+ * assessed.
2220
+ */
2221
+ local_tax_currency: string | null;
2222
+ /**
2223
+ * Fields specific to lodging.
2224
+ */
2225
+ lodging: PurchaseDetails.Lodging | null;
2226
+ /**
2227
+ * The national tax amount in minor units.
2228
+ */
2229
+ national_tax_amount: number | null;
2230
+ /**
2231
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
2232
+ * assessed.
2233
+ */
2234
+ national_tax_currency: string | null;
2235
+ /**
2236
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
2237
+ */
2238
+ purchase_identifier: string | null;
2239
+ /**
2240
+ * The format of the purchase identifier.
2241
+ *
2242
+ * - `free_text` - Free text
2243
+ * - `order_number` - Order number
2244
+ * - `rental_agreement_number` - Rental agreement number
2245
+ * - `hotel_folio_number` - Hotel folio number
2246
+ * - `invoice_number` - Invoice number
2247
+ */
2248
+ purchase_identifier_format: 'free_text' | 'order_number' | 'rental_agreement_number' | 'hotel_folio_number' | 'invoice_number' | null;
2249
+ /**
2250
+ * Fields specific to travel.
2251
+ */
2252
+ travel: PurchaseDetails.Travel | null;
2253
+ }
2254
+ namespace PurchaseDetails {
2255
+ /**
2256
+ * Fields specific to car rentals.
2257
+ */
2258
+ interface CarRental {
2259
+ /**
2260
+ * Code indicating the vehicle's class.
2261
+ */
2262
+ car_class_code: string | null;
2263
+ /**
2264
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
2265
+ * transaction, the scheduled pick up date.
2266
+ */
2267
+ checkout_date: string | null;
2268
+ /**
2269
+ * Daily rate being charged for the vehicle.
2270
+ */
2271
+ daily_rental_rate_amount: number | null;
2272
+ /**
2273
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
2274
+ * rate.
2275
+ */
2276
+ daily_rental_rate_currency: string | null;
2277
+ /**
2278
+ * Number of days the vehicle was rented.
2279
+ */
2280
+ days_rented: number | null;
2281
+ /**
2282
+ * Additional charges (gas, late fee, etc.) being billed.
2283
+ *
2284
+ * - `no_extra_charge` - No extra charge
2285
+ * - `gas` - Gas
2286
+ * - `extra_mileage` - Extra mileage
2287
+ * - `late_return` - Late return
2288
+ * - `one_way_service_fee` - One way service fee
2289
+ * - `parking_violation` - Parking violation
2290
+ */
2291
+ extra_charges: 'no_extra_charge' | 'gas' | 'extra_mileage' | 'late_return' | 'one_way_service_fee' | 'parking_violation' | null;
2292
+ /**
2293
+ * Fuel charges for the vehicle.
2294
+ */
2295
+ fuel_charges_amount: number | null;
2296
+ /**
2297
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
2298
+ * assessed.
2299
+ */
2300
+ fuel_charges_currency: string | null;
2301
+ /**
2302
+ * Any insurance being charged for the vehicle.
2303
+ */
2304
+ insurance_charges_amount: number | null;
2305
+ /**
2306
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
2307
+ * charges assessed.
2308
+ */
2309
+ insurance_charges_currency: string | null;
2310
+ /**
2311
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
2312
+ * not actually rented (that is, a "no-show" charge).
2313
+ *
2314
+ * - `not_applicable` - Not applicable
2315
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
2316
+ */
2317
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
2318
+ /**
2319
+ * Charges for returning the vehicle at a different location than where it was
2320
+ * picked up.
2321
+ */
2322
+ one_way_drop_off_charges_amount: number | null;
2323
+ /**
2324
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
2325
+ * drop-off charges assessed.
2326
+ */
2327
+ one_way_drop_off_charges_currency: string | null;
2328
+ /**
2329
+ * Name of the person renting the vehicle.
2330
+ */
2331
+ renter_name: string | null;
2332
+ /**
2333
+ * Weekly rate being charged for the vehicle.
2334
+ */
2335
+ weekly_rental_rate_amount: number | null;
2336
+ /**
2337
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
2338
+ * rental rate.
2339
+ */
2340
+ weekly_rental_rate_currency: string | null;
2341
+ }
2342
+ /**
2343
+ * Fields specific to lodging.
2344
+ */
2345
+ interface Lodging {
2346
+ /**
2347
+ * Date the customer checked in.
2348
+ */
2349
+ check_in_date: string | null;
2350
+ /**
2351
+ * Daily rate being charged for the room.
2352
+ */
2353
+ daily_room_rate_amount: number | null;
2354
+ /**
2355
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
2356
+ * rate.
2357
+ */
2358
+ daily_room_rate_currency: string | null;
2359
+ /**
2360
+ * Additional charges (phone, late check-out, etc.) being billed.
2361
+ *
2362
+ * - `no_extra_charge` - No extra charge
2363
+ * - `restaurant` - Restaurant
2364
+ * - `gift_shop` - Gift shop
2365
+ * - `mini_bar` - Mini bar
2366
+ * - `telephone` - Telephone
2367
+ * - `other` - Other
2368
+ * - `laundry` - Laundry
2369
+ */
2370
+ extra_charges: 'no_extra_charge' | 'restaurant' | 'gift_shop' | 'mini_bar' | 'telephone' | 'other' | 'laundry' | null;
2371
+ /**
2372
+ * Folio cash advances for the room.
2373
+ */
2374
+ folio_cash_advances_amount: number | null;
2375
+ /**
2376
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
2377
+ * advances.
2378
+ */
2379
+ folio_cash_advances_currency: string | null;
2380
+ /**
2381
+ * Food and beverage charges for the room.
2382
+ */
2383
+ food_beverage_charges_amount: number | null;
2384
+ /**
2385
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
2386
+ * beverage charges.
2387
+ */
2388
+ food_beverage_charges_currency: string | null;
2389
+ /**
2390
+ * Indicator that the cardholder is being billed for a reserved room that was not
2391
+ * actually used.
2392
+ *
2393
+ * - `not_applicable` - Not applicable
2394
+ * - `no_show` - No show
2395
+ */
2396
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
2397
+ /**
2398
+ * Prepaid expenses being charged for the room.
2399
+ */
2400
+ prepaid_expenses_amount: number | null;
2401
+ /**
2402
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
2403
+ * expenses.
2404
+ */
2405
+ prepaid_expenses_currency: string | null;
2406
+ /**
2407
+ * Number of nights the room was rented.
2408
+ */
2409
+ room_nights: number | null;
2410
+ /**
2411
+ * Total room tax being charged.
2412
+ */
2413
+ total_room_tax_amount: number | null;
2414
+ /**
2415
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
2416
+ * tax.
2417
+ */
2418
+ total_room_tax_currency: string | null;
2419
+ /**
2420
+ * Total tax being charged for the room.
2421
+ */
2422
+ total_tax_amount: number | null;
2423
+ /**
2424
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
2425
+ * assessed.
2426
+ */
2427
+ total_tax_currency: string | null;
2428
+ }
2429
+ /**
2430
+ * Fields specific to travel.
2431
+ */
2432
+ interface Travel {
2433
+ /**
2434
+ * Ancillary purchases in addition to the airfare.
2435
+ */
2436
+ ancillary: Travel.Ancillary | null;
2437
+ /**
2438
+ * Indicates the computerized reservation system used to book the ticket.
2439
+ */
2440
+ computerized_reservation_system: string | null;
2441
+ /**
2442
+ * Indicates the reason for a credit to the cardholder.
2443
+ *
2444
+ * - `no_credit` - No credit
2445
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
2446
+ * ancillary purchase cancellation
2447
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
2448
+ * Airline ticket and passenger transport ancillary purchase cancellation
2449
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
2450
+ * - `other` - Other
2451
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
2452
+ */
2453
+ credit_reason_indicator: 'no_credit' | 'passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_cancellation' | 'other' | 'partial_refund_of_airline_ticket' | null;
2454
+ /**
2455
+ * Date of departure.
2456
+ */
2457
+ departure_date: string | null;
2458
+ /**
2459
+ * Code for the originating city or airport.
2460
+ */
2461
+ origination_city_airport_code: string | null;
2462
+ /**
2463
+ * Name of the passenger.
2464
+ */
2465
+ passenger_name: string | null;
2466
+ /**
2467
+ * Indicates whether this ticket is non-refundable.
2468
+ *
2469
+ * - `no_restrictions` - No restrictions
2470
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
2471
+ */
2472
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
2473
+ /**
2474
+ * Indicates why a ticket was changed.
2475
+ *
2476
+ * - `none` - None
2477
+ * - `change_to_existing_ticket` - Change to existing ticket
2478
+ * - `new_ticket` - New ticket
2479
+ */
2480
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
2481
+ /**
2482
+ * Ticket number.
2483
+ */
2484
+ ticket_number: string | null;
2485
+ /**
2486
+ * Code for the travel agency if the ticket was issued by a travel agency.
2487
+ */
2488
+ travel_agency_code: string | null;
2489
+ /**
2490
+ * Name of the travel agency if the ticket was issued by a travel agency.
2491
+ */
2492
+ travel_agency_name: string | null;
2493
+ /**
2494
+ * Fields specific to each leg of the journey.
2495
+ */
2496
+ trip_legs: Array<Travel.TripLeg> | null;
2497
+ }
2498
+ namespace Travel {
2499
+ /**
2500
+ * Ancillary purchases in addition to the airfare.
2501
+ */
2502
+ interface Ancillary {
2503
+ /**
2504
+ * If this purchase has a connection or relationship to another purchase, such as a
2505
+ * baggage fee for a passenger transport ticket, this field should contain the
2506
+ * ticket document number for the other purchase.
2507
+ */
2508
+ connected_ticket_document_number: string | null;
2509
+ /**
2510
+ * Indicates the reason for a credit to the cardholder.
2511
+ *
2512
+ * - `no_credit` - No credit
2513
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
2514
+ * ancillary purchase cancellation
2515
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
2516
+ * Airline ticket and passenger transport ancillary purchase cancellation
2517
+ * - `other` - Other
2518
+ */
2519
+ credit_reason_indicator: 'no_credit' | 'passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation' | 'other' | null;
2520
+ /**
2521
+ * Name of the passenger or description of the ancillary purchase.
2522
+ */
2523
+ passenger_name_or_description: string | null;
2524
+ /**
2525
+ * Additional travel charges, such as baggage fees.
2526
+ */
2527
+ services: Array<Ancillary.Service>;
2528
+ /**
2529
+ * Ticket document number.
2530
+ */
2531
+ ticket_document_number: string | null;
2532
+ }
2533
+ namespace Ancillary {
2534
+ interface Service {
2535
+ /**
2536
+ * Category of the ancillary service.
2537
+ *
2538
+ * - `none` - None
2539
+ * - `bundled_service` - Bundled service
2540
+ * - `baggage_fee` - Baggage fee
2541
+ * - `change_fee` - Change fee
2542
+ * - `cargo` - Cargo
2543
+ * - `carbon_offset` - Carbon offset
2544
+ * - `frequent_flyer` - Frequent flyer
2545
+ * - `gift_card` - Gift card
2546
+ * - `ground_transport` - Ground transport
2547
+ * - `in_flight_entertainment` - In-flight entertainment
2548
+ * - `lounge` - Lounge
2549
+ * - `medical` - Medical
2550
+ * - `meal_beverage` - Meal beverage
2551
+ * - `other` - Other
2552
+ * - `passenger_assist_fee` - Passenger assist fee
2553
+ * - `pets` - Pets
2554
+ * - `seat_fees` - Seat fees
2555
+ * - `standby` - Standby
2556
+ * - `service_fee` - Service fee
2557
+ * - `store` - Store
2558
+ * - `travel_service` - Travel service
2559
+ * - `unaccompanied_travel` - Unaccompanied travel
2560
+ * - `upgrades` - Upgrades
2561
+ * - `wifi` - Wi-fi
2562
+ */
2563
+ category: 'none' | 'bundled_service' | 'baggage_fee' | 'change_fee' | 'cargo' | 'carbon_offset' | 'frequent_flyer' | 'gift_card' | 'ground_transport' | 'in_flight_entertainment' | 'lounge' | 'medical' | 'meal_beverage' | 'other' | 'passenger_assist_fee' | 'pets' | 'seat_fees' | 'standby' | 'service_fee' | 'store' | 'travel_service' | 'unaccompanied_travel' | 'upgrades' | 'wifi' | null;
2564
+ /**
2565
+ * Sub-category of the ancillary service, free-form.
2566
+ */
2567
+ sub_category: string | null;
2568
+ }
2569
+ }
2570
+ interface TripLeg {
2571
+ /**
2572
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
2573
+ */
2574
+ carrier_code: string | null;
2575
+ /**
2576
+ * Code for the destination city or airport.
2577
+ */
2578
+ destination_city_airport_code: string | null;
2579
+ /**
2580
+ * Fare basis code.
2581
+ */
2582
+ fare_basis_code: string | null;
2583
+ /**
2584
+ * Flight number.
2585
+ */
2586
+ flight_number: string | null;
2587
+ /**
2588
+ * Service class (e.g., first class, business class, etc.).
2589
+ */
2590
+ service_class: string | null;
2591
+ /**
2592
+ * Indicates whether a stopover is allowed on this ticket.
2593
+ *
2594
+ * - `none` - None
2595
+ * - `stop_over_allowed` - Stop over allowed
2596
+ * - `stop_over_not_allowed` - Stop over not allowed
2597
+ */
2598
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
2599
+ }
2600
+ }
2601
+ }
2602
+ /**
2603
+ * Surcharge amount details, if applicable. The amount is positive if the surcharge
2604
+ * is added to to the overall transaction amount (surcharge), and negative if the
2605
+ * surcharge is deducted from the overall transaction amount (discount).
2606
+ */
2607
+ interface Surcharge {
2608
+ /**
2609
+ * The surcharge amount in the minor unit of the transaction's settlement currency.
2610
+ */
2611
+ amount: number;
2612
+ /**
2613
+ * The surcharge amount in the minor unit of the transaction's presentment
2614
+ * currency.
2615
+ */
2616
+ presentment_amount: number;
2617
+ }
2618
+ }
2619
+ /**
2620
+ * A Cashback Payment object. This field will be present in the JSON response if
2621
+ * and only if `category` is equal to `cashback_payment`. A Cashback Payment
2622
+ * represents the cashback paid to a cardholder for a given period. Cashback is
2623
+ * usually paid monthly for the prior month's transactions.
2624
+ */
2625
+ interface CashbackPayment {
2626
+ /**
2627
+ * The card on which the cashback was accrued.
2628
+ */
2629
+ accrued_on_card_id: string | null;
2630
+ /**
2631
+ * The amount in the minor unit of the transaction's currency. For dollars, for
2632
+ * example, this is cents.
2633
+ */
2634
+ amount: number;
2635
+ /**
2636
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
2637
+ * currency.
2638
+ *
2639
+ * - `USD` - US Dollar (USD)
2640
+ */
2641
+ currency: 'USD';
2642
+ /**
2643
+ * The end of the period for which this transaction paid cashback.
2644
+ */
2645
+ period_end: string;
2646
+ /**
2647
+ * The start of the period for which this transaction paid cashback.
2648
+ */
2649
+ period_start: string;
2650
+ [k: string]: unknown;
2651
+ }
2652
+ /**
2653
+ * A Check Deposit Acceptance object. This field will be present in the JSON
2654
+ * response if and only if `category` is equal to `check_deposit_acceptance`. A
2655
+ * Check Deposit Acceptance is created when a Check Deposit is processed and its
2656
+ * details confirmed. Check Deposits may be returned by the receiving bank, which
2657
+ * will appear as a Check Deposit Return.
2658
+ */
2659
+ interface CheckDepositAcceptance {
2660
+ /**
2661
+ * The account number printed on the check. This is an account at the bank that
2662
+ * issued the check.
2663
+ */
2664
+ account_number: string;
2665
+ /**
2666
+ * The amount to be deposited in the minor unit of the transaction's currency. For
2667
+ * dollars, for example, this is cents.
2668
+ */
2669
+ amount: number;
2670
+ /**
2671
+ * An additional line of metadata printed on the check. This typically includes the
2672
+ * check number for business checks.
2673
+ */
2674
+ auxiliary_on_us: string | null;
2675
+ /**
2676
+ * The ID of the Check Deposit that was accepted.
2677
+ */
2678
+ check_deposit_id: string;
2679
+ /**
2680
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
2681
+ * transaction's currency.
2682
+ *
2683
+ * - `USD` - US Dollar (USD)
2684
+ */
2685
+ currency: 'USD';
2686
+ /**
2687
+ * The routing number printed on the check. This is a routing number for the bank
2688
+ * that issued the check.
2689
+ */
2690
+ routing_number: string;
2691
+ /**
2692
+ * The check serial number, if present, for consumer checks. For business checks,
2693
+ * the serial number is usually in the `auxiliary_on_us` field.
2694
+ */
2695
+ serial_number: string | null;
2696
+ [k: string]: unknown;
2697
+ }
2698
+ /**
2699
+ * A Check Deposit Return object. This field will be present in the JSON response
2700
+ * if and only if `category` is equal to `check_deposit_return`. A Check Deposit
2701
+ * Return is created when a Check Deposit is returned by the bank holding the
2702
+ * account it was drawn against. Check Deposits may be returned for a variety of
2703
+ * reasons, including insufficient funds or a mismatched account number. Usually,
2704
+ * checks are returned within the first 7 days after the deposit is made.
2705
+ */
2706
+ interface CheckDepositReturn {
2707
+ /**
2708
+ * The returned amount in USD cents.
2709
+ */
2710
+ amount: number;
2711
+ /**
2712
+ * The identifier of the Check Deposit that was returned.
2713
+ */
2714
+ check_deposit_id: string;
2715
+ /**
2716
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
2717
+ * transaction's currency.
2718
+ *
2719
+ * - `USD` - US Dollar (USD)
2720
+ */
2721
+ currency: 'USD';
2722
+ /**
2723
+ * Why this check was returned by the bank holding the account it was drawn
2724
+ * against.
2725
+ *
2726
+ * - `ach_conversion_not_supported` - The check doesn't allow ACH conversion.
2727
+ * - `closed_account` - The account is closed. (Check21 return code `D`)
2728
+ * - `duplicate_submission` - The check has already been deposited. (Check21 return
2729
+ * code `Y`)
2730
+ * - `insufficient_funds` - Insufficient funds (Check21 return code `A`)
2731
+ * - `no_account` - No account was found matching the check details. (Check21
2732
+ * return code `E`)
2733
+ * - `not_authorized` - The check was not authorized. (Check21 return code `Q`)
2734
+ * - `stale_dated` - The check is too old. (Check21 return code `G`)
2735
+ * - `stop_payment` - The payment has been stopped by the account holder. (Check21
2736
+ * return code `C`)
2737
+ * - `unknown_reason` - The reason for the return is unknown.
2738
+ * - `unmatched_details` - The image doesn't match the details submitted.
2739
+ * - `unreadable_image` - The image could not be read. (Check21 return code `U`)
2740
+ * - `endorsement_irregular` - The check endorsement was irregular. (Check21 return
2741
+ * code `J`)
2742
+ * - `altered_or_fictitious_item` - The check present was either altered or fake.
2743
+ * (Check21 return code `N`)
2744
+ * - `frozen_or_blocked_account` - The account this check is drawn on is frozen.
2745
+ * (Check21 return code `F`)
2746
+ * - `post_dated` - The check is post dated. (Check21 return code `H`)
2747
+ * - `endorsement_missing` - The endorsement was missing. (Check21 return code `I`)
2748
+ * - `signature_missing` - The check signature was missing. (Check21 return code
2749
+ * `K`)
2750
+ * - `stop_payment_suspect` - The bank suspects a stop payment will be placed.
2751
+ * (Check21 return code `T`)
2752
+ * - `unusable_image` - The bank cannot read the image. (Check21 return code `U`)
2753
+ * - `image_fails_security_check` - The check image fails the bank's security
2754
+ * check. (Check21 return code `V`)
2755
+ * - `cannot_determine_amount` - The bank cannot determine the amount. (Check21
2756
+ * return code `W`)
2757
+ * - `signature_irregular` - The signature is inconsistent with prior signatures.
2758
+ * (Check21 return code `L`)
2759
+ * - `non_cash_item` - The check is a non-cash item and cannot be drawn against the
2760
+ * account. (Check21 return code `M`)
2761
+ * - `unable_to_process` - The bank is unable to process this check. (Check21
2762
+ * return code `O`)
2763
+ * - `item_exceeds_dollar_limit` - The check exceeds the bank or customer's limit.
2764
+ * (Check21 return code `P`)
2765
+ * - `branch_or_account_sold` - The bank sold this account and no longer services
2766
+ * this customer. (Check21 return code `R`)
2767
+ */
2768
+ return_reason: 'ach_conversion_not_supported' | 'closed_account' | 'duplicate_submission' | 'insufficient_funds' | 'no_account' | 'not_authorized' | 'stale_dated' | 'stop_payment' | 'unknown_reason' | 'unmatched_details' | 'unreadable_image' | 'endorsement_irregular' | 'altered_or_fictitious_item' | 'frozen_or_blocked_account' | 'post_dated' | 'endorsement_missing' | 'signature_missing' | 'stop_payment_suspect' | 'unusable_image' | 'image_fails_security_check' | 'cannot_determine_amount' | 'signature_irregular' | 'non_cash_item' | 'unable_to_process' | 'item_exceeds_dollar_limit' | 'branch_or_account_sold';
2769
+ /**
2770
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
2771
+ * the check deposit was returned.
2772
+ */
2773
+ returned_at: string;
2774
+ /**
2775
+ * The identifier of the transaction that reversed the original check deposit
2776
+ * transaction.
2777
+ */
2778
+ transaction_id: string;
2779
+ [k: string]: unknown;
2780
+ }
2781
+ /**
2782
+ * A Check Transfer Deposit object. This field will be present in the JSON response
2783
+ * if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check
2784
+ * is a check drawn on an Increase account that has been deposited by an external
2785
+ * bank account. These types of checks are not pre-registered.
2786
+ */
2787
+ interface CheckTransferDeposit {
2788
+ /**
2789
+ * The identifier of the API File object containing an image of the back of the
2790
+ * deposited check.
2791
+ */
2792
+ back_image_file_id: string | null;
2793
+ /**
2794
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
2795
+ * bank depositing this check. In some rare cases, this is not transmitted via
2796
+ * Check21 and the value will be null.
2797
+ */
2798
+ bank_of_first_deposit_routing_number: string | null;
2799
+ /**
2800
+ * When the check was deposited.
2801
+ */
2802
+ deposited_at: string;
2803
+ /**
2804
+ * The identifier of the API File object containing an image of the front of the
2805
+ * deposited check.
2806
+ */
2807
+ front_image_file_id: string | null;
2808
+ /**
2809
+ * The identifier of the Inbound Check Deposit object associated with this
2810
+ * transaction.
2811
+ */
2812
+ inbound_check_deposit_id: string | null;
2813
+ /**
2814
+ * The identifier of the Transaction object created when the check was deposited.
2815
+ */
2816
+ transaction_id: string | null;
2817
+ /**
2818
+ * The identifier of the Check Transfer object that was deposited.
2819
+ */
2820
+ transfer_id: string | null;
2821
+ /**
2822
+ * A constant representing the object's type. For this resource it will always be
2823
+ * `check_transfer_deposit`.
2824
+ */
2825
+ type: 'check_transfer_deposit';
2826
+ [k: string]: unknown;
2827
+ }
2828
+ /**
2829
+ * A FedNow Transfer Acknowledgement object. This field will be present in the JSON
2830
+ * response if and only if `category` is equal to
2831
+ * `fednow_transfer_acknowledgement`. A FedNow Transfer Acknowledgement is created
2832
+ * when a FedNow Transfer sent from Increase is acknowledged by the receiving bank.
2833
+ */
2834
+ interface FednowTransferAcknowledgement {
2835
+ /**
2836
+ * The identifier of the FedNow Transfer that led to this Transaction.
2837
+ */
2838
+ transfer_id: string;
2839
+ [k: string]: unknown;
2840
+ }
2841
+ /**
2842
+ * A Fee Payment object. This field will be present in the JSON response if and
2843
+ * only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
2844
+ * made to Increase.
2845
+ */
2846
+ interface FeePayment {
2847
+ /**
2848
+ * The amount in the minor unit of the transaction's currency. For dollars, for
2849
+ * example, this is cents.
2850
+ */
2851
+ amount: number;
2852
+ /**
2853
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
2854
+ * currency.
2855
+ *
2856
+ * - `USD` - US Dollar (USD)
2857
+ */
2858
+ currency: 'USD';
2859
+ /**
2860
+ * The start of this payment's fee period, usually the first day of a month.
2861
+ */
2862
+ fee_period_start: string;
2863
+ /**
2864
+ * The Program for which this fee was incurred.
2865
+ */
2866
+ program_id: string | null;
2867
+ [k: string]: unknown;
2868
+ }
2869
+ /**
2870
+ * An Inbound ACH Transfer Intention object. This field will be present in the JSON
2871
+ * response if and only if `category` is equal to `inbound_ach_transfer`. An
2872
+ * Inbound ACH Transfer Intention is created when an ACH transfer is initiated at
2873
+ * another bank and received by Increase.
2874
+ */
2875
+ interface InboundACHTransfer {
2876
+ /**
2877
+ * Additional information sent from the originator.
2878
+ */
2879
+ addenda: InboundACHTransfer.Addenda | null;
2880
+ /**
2881
+ * The transfer amount in USD cents.
2882
+ */
2883
+ amount: number;
2884
+ /**
2885
+ * The description of the date of the transfer, usually in the format `YYMMDD`.
2886
+ */
2887
+ originator_company_descriptive_date: string | null;
2888
+ /**
2889
+ * Data set by the originator.
2890
+ */
2891
+ originator_company_discretionary_data: string | null;
2892
+ /**
2893
+ * An informational description of the transfer.
2894
+ */
2895
+ originator_company_entry_description: string;
2896
+ /**
2897
+ * An identifier for the originating company. This is generally, but not always, a
2898
+ * stable identifier across multiple transfers.
2899
+ */
2900
+ originator_company_id: string;
2901
+ /**
2902
+ * A name set by the originator to identify themselves.
2903
+ */
2904
+ originator_company_name: string;
2905
+ /**
2906
+ * The originator's identifier for the transfer recipient.
2907
+ */
2908
+ receiver_id_number: string | null;
2909
+ /**
2910
+ * The name of the transfer recipient. This value is informational and not verified
2911
+ * by Increase.
2912
+ */
2913
+ receiver_name: string | null;
2914
+ /**
2915
+ * A 15 digit number recorded in the Nacha file and available to both the
2916
+ * originating and receiving bank. Along with the amount, date, and originating
2917
+ * routing number, this can be used to identify the ACH transfer at either bank.
2918
+ * ACH trace numbers are not unique, but are
2919
+ * [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).
2920
+ */
2921
+ trace_number: string;
2922
+ /**
2923
+ * The Inbound ACH Transfer's identifier.
2924
+ */
2925
+ transfer_id: string;
2926
+ [k: string]: unknown;
2927
+ }
2928
+ namespace InboundACHTransfer {
2929
+ /**
2930
+ * Additional information sent from the originator.
2931
+ */
2932
+ interface Addenda {
2933
+ /**
2934
+ * The type of addendum.
2935
+ *
2936
+ * - `freeform` - Unstructured addendum.
2937
+ */
2938
+ category: 'freeform';
2939
+ /**
2940
+ * Unstructured `payment_related_information` passed through by the originator.
2941
+ */
2942
+ freeform: Addenda.Freeform | null;
2943
+ }
2944
+ namespace Addenda {
2945
+ /**
2946
+ * Unstructured `payment_related_information` passed through by the originator.
2947
+ */
2948
+ interface Freeform {
2949
+ /**
2950
+ * Each entry represents an addendum received from the originator.
2951
+ */
2952
+ entries: Array<Freeform.Entry>;
2953
+ }
2954
+ namespace Freeform {
2955
+ interface Entry {
2956
+ /**
2957
+ * The payment related information passed in the addendum.
2958
+ */
2959
+ payment_related_information: string;
2960
+ }
2961
+ }
2962
+ }
2963
+ }
2964
+ /**
2965
+ * An Inbound ACH Transfer Return Intention object. This field will be present in
2966
+ * the JSON response if and only if `category` is equal to
2967
+ * `inbound_ach_transfer_return_intention`. An Inbound ACH Transfer Return
2968
+ * Intention is created when an ACH transfer is initiated at another bank and
2969
+ * returned by Increase.
2970
+ */
2971
+ interface InboundACHTransferReturnIntention {
2972
+ /**
2973
+ * The ID of the Inbound ACH Transfer that is being returned.
2974
+ */
2975
+ inbound_ach_transfer_id: string;
2976
+ [k: string]: unknown;
2977
+ }
2978
+ /**
2979
+ * An Inbound Check Adjustment object. This field will be present in the JSON
2980
+ * response if and only if `category` is equal to `inbound_check_adjustment`. An
2981
+ * Inbound Check Adjustment is created when Increase receives an adjustment for a
2982
+ * check or return deposited through Check21.
2983
+ */
2984
+ interface InboundCheckAdjustment {
2985
+ /**
2986
+ * The ID of the transaction that was adjusted.
2987
+ */
2988
+ adjusted_transaction_id: string;
2989
+ /**
2990
+ * The amount of the check adjustment.
2991
+ */
2992
+ amount: number;
2993
+ /**
2994
+ * The reason for the adjustment.
2995
+ *
2996
+ * - `late_return` - The return was initiated too late and the receiving
2997
+ * institution has responded with a Late Return Claim.
2998
+ * - `wrong_payee_credit` - The check was deposited to the wrong payee and the
2999
+ * depositing institution has reimbursed the funds with a Wrong Payee Credit.
3000
+ * - `adjusted_amount` - The check was deposited with a different amount than what
3001
+ * was written on the check.
3002
+ * - `non_conforming_item` - The recipient was not able to process the check. This
3003
+ * usually happens for e.g., low quality images.
3004
+ * - `paid` - The check has already been deposited elsewhere and so this is a
3005
+ * duplicate.
3006
+ */
3007
+ reason: 'late_return' | 'wrong_payee_credit' | 'adjusted_amount' | 'non_conforming_item' | 'paid';
3008
+ [k: string]: unknown;
3009
+ }
3010
+ /**
3011
+ * An Inbound Check Deposit Return Intention object. This field will be present in
3012
+ * the JSON response if and only if `category` is equal to
3013
+ * `inbound_check_deposit_return_intention`. An Inbound Check Deposit Return
3014
+ * Intention is created when Increase receives an Inbound Check and the User
3015
+ * requests that it be returned.
3016
+ */
3017
+ interface InboundCheckDepositReturnIntention {
3018
+ /**
3019
+ * The ID of the Inbound Check Deposit that is being returned.
3020
+ */
3021
+ inbound_check_deposit_id: string;
3022
+ /**
3023
+ * The identifier of the Check Transfer object that was deposited.
3024
+ */
3025
+ transfer_id: string | null;
3026
+ [k: string]: unknown;
3027
+ }
3028
+ /**
3029
+ * An Inbound FedNow Transfer Confirmation object. This field will be present in
3030
+ * the JSON response if and only if `category` is equal to
3031
+ * `inbound_fednow_transfer_confirmation`. An Inbound FedNow Transfer Confirmation
3032
+ * is created when a FedNow transfer is initiated at another bank and received by
3033
+ * Increase.
3034
+ */
3035
+ interface InboundFednowTransferConfirmation {
3036
+ /**
3037
+ * The identifier of the FedNow Transfer that led to this Transaction.
3038
+ */
3039
+ transfer_id: string;
3040
+ [k: string]: unknown;
3041
+ }
3042
+ /**
3043
+ * An Inbound Real-Time Payments Transfer Confirmation object. This field will be
3044
+ * present in the JSON response if and only if `category` is equal to
3045
+ * `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time
3046
+ * Payments Transfer Confirmation is created when a Real-Time Payments transfer is
3047
+ * initiated at another bank and received by Increase.
3048
+ */
3049
+ interface InboundRealTimePaymentsTransferConfirmation {
3050
+ /**
3051
+ * The amount in the minor unit of the transfer's currency. For dollars, for
3052
+ * example, this is cents.
3053
+ */
3054
+ amount: number;
3055
+ /**
3056
+ * The name the sender of the transfer specified as the recipient of the transfer.
3057
+ */
3058
+ creditor_name: string;
3059
+ /**
3060
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
3061
+ * currency. This will always be "USD" for a Real-Time Payments transfer.
3062
+ *
3063
+ * - `USD` - US Dollar (USD)
3064
+ */
3065
+ currency: 'USD';
3066
+ /**
3067
+ * The account number of the account that sent the transfer.
3068
+ */
3069
+ debtor_account_number: string;
3070
+ /**
3071
+ * The name provided by the sender of the transfer.
3072
+ */
3073
+ debtor_name: string;
3074
+ /**
3075
+ * The routing number of the account that sent the transfer.
3076
+ */
3077
+ debtor_routing_number: string;
3078
+ /**
3079
+ * Additional information included with the transfer.
3080
+ */
3081
+ remittance_information: string | null;
3082
+ /**
3083
+ * The Real-Time Payments network identification of the transfer.
3084
+ */
3085
+ transaction_identification: string;
3086
+ /**
3087
+ * The identifier of the Real-Time Payments Transfer that led to this Transaction.
3088
+ */
3089
+ transfer_id: string;
3090
+ [k: string]: unknown;
3091
+ }
3092
+ /**
3093
+ * An Inbound Wire Reversal object. This field will be present in the JSON response
3094
+ * if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire
3095
+ * Reversal represents a reversal of a wire transfer that was initiated via
3096
+ * Increase. The other bank is sending the money back. This most often happens when
3097
+ * the original destination account details were incorrect.
3098
+ */
3099
+ interface InboundWireReversal {
3100
+ /**
3101
+ * The amount that was reversed in USD cents.
3102
+ */
3103
+ amount: number;
3104
+ /**
3105
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
3106
+ * the reversal was created.
3107
+ */
3108
+ created_at: string;
3109
+ /**
3110
+ * The debtor's routing number.
3111
+ */
3112
+ debtor_routing_number: string | null;
3113
+ /**
3114
+ * The description on the reversal message from Fedwire, set by the reversing bank.
3115
+ */
3116
+ description: string;
3117
+ /**
3118
+ * The Fedwire cycle date for the wire reversal. The "Fedwire day" begins at 9:00
3119
+ * PM Eastern Time on the evening before the `cycle date`.
3120
+ */
3121
+ input_cycle_date: string;
3122
+ /**
3123
+ * The Fedwire transaction identifier.
3124
+ */
3125
+ input_message_accountability_data: string;
3126
+ /**
3127
+ * The Fedwire sequence number.
3128
+ */
3129
+ input_sequence_number: string;
3130
+ /**
3131
+ * The Fedwire input source identifier.
3132
+ */
3133
+ input_source: string;
3134
+ /**
3135
+ * The sending bank's identifier for the reversal.
3136
+ */
3137
+ instruction_identification: string | null;
3138
+ /**
3139
+ * Additional information about the reason for the reversal.
3140
+ */
3141
+ return_reason_additional_information: string | null;
3142
+ /**
3143
+ * A code provided by the sending bank giving a reason for the reversal. It will
3144
+ * generally be one of the codes defined in the ISO20022
3145
+ * `ExternalReturnReason1Code` code set, but this is not enforced by the network.
3146
+ */
3147
+ return_reason_code: string | null;
3148
+ /**
3149
+ * An Increase-generated description of the `return_reason_code`.
3150
+ */
3151
+ return_reason_code_description: string | null;
3152
+ /**
3153
+ * The ID for the Transaction associated with the transfer reversal.
3154
+ */
3155
+ transaction_id: string;
3156
+ /**
3157
+ * The ID for the Wire Transfer that is being reversed.
3158
+ */
3159
+ wire_transfer_id: string;
3160
+ [k: string]: unknown;
3161
+ }
3162
+ /**
3163
+ * An Inbound Wire Transfer Intention object. This field will be present in the
3164
+ * JSON response if and only if `category` is equal to `inbound_wire_transfer`. An
3165
+ * Inbound Wire Transfer Intention is created when a wire transfer is initiated at
3166
+ * another bank and received by Increase.
3167
+ */
3168
+ interface InboundWireTransfer {
3169
+ /**
3170
+ * The amount in USD cents.
3171
+ */
3172
+ amount: number;
3173
+ /**
3174
+ * A free-form address field set by the sender.
3175
+ */
3176
+ creditor_address_line1: string | null;
3177
+ /**
3178
+ * A free-form address field set by the sender.
3179
+ */
3180
+ creditor_address_line2: string | null;
3181
+ /**
3182
+ * A free-form address field set by the sender.
3183
+ */
3184
+ creditor_address_line3: string | null;
3185
+ /**
3186
+ * A name set by the sender.
3187
+ */
3188
+ creditor_name: string | null;
3189
+ /**
3190
+ * A free-form address field set by the sender.
3191
+ */
3192
+ debtor_address_line1: string | null;
3193
+ /**
3194
+ * A free-form address field set by the sender.
3195
+ */
3196
+ debtor_address_line2: string | null;
3197
+ /**
3198
+ * A free-form address field set by the sender.
3199
+ */
3200
+ debtor_address_line3: string | null;
3201
+ /**
3202
+ * A name set by the sender.
3203
+ */
3204
+ debtor_name: string | null;
3205
+ /**
3206
+ * An Increase-constructed description of the transfer.
3207
+ */
3208
+ description: string;
3209
+ /**
3210
+ * A free-form reference string set by the sender, to help identify the transfer.
3211
+ */
3212
+ end_to_end_identification: string | null;
3213
+ /**
3214
+ * A unique identifier available to the originating and receiving banks, commonly
3215
+ * abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
3216
+ * service and is helpful when debugging wires with the originating bank.
3217
+ */
3218
+ input_message_accountability_data: string | null;
3219
+ /**
3220
+ * The American Banking Association (ABA) routing number of the bank that sent the
3221
+ * wire.
3222
+ */
3223
+ instructing_agent_routing_number: string | null;
3224
+ /**
3225
+ * The sending bank's identifier for the wire transfer.
3226
+ */
3227
+ instruction_identification: string | null;
3228
+ /**
3229
+ * The ID of the Inbound Wire Transfer object that resulted in this Transaction.
3230
+ */
3231
+ transfer_id: string;
3232
+ /**
3233
+ * The Unique End-to-end Transaction Reference
3234
+ * ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
3235
+ * of the transfer.
3236
+ */
3237
+ unique_end_to_end_transaction_reference: string | null;
3238
+ /**
3239
+ * A free-form message set by the sender.
3240
+ */
3241
+ unstructured_remittance_information: string | null;
3242
+ [k: string]: unknown;
3243
+ }
3244
+ /**
3245
+ * An Inbound Wire Transfer Reversal Intention object. This field will be present
3246
+ * in the JSON response if and only if `category` is equal to
3247
+ * `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal Intention is
3248
+ * created when Increase has received a wire and the User requests that it be
3249
+ * reversed.
3250
+ */
3251
+ interface InboundWireTransferReversal {
3252
+ /**
3253
+ * The ID of the Inbound Wire Transfer that is being reversed.
3254
+ */
3255
+ inbound_wire_transfer_id: string;
3256
+ [k: string]: unknown;
3257
+ }
3258
+ /**
3259
+ * An Interest Payment object. This field will be present in the JSON response if
3260
+ * and only if `category` is equal to `interest_payment`. An Interest Payment
3261
+ * represents a payment of interest on an account. Interest is usually paid
3262
+ * monthly.
3263
+ */
3264
+ interface InterestPayment {
3265
+ /**
3266
+ * The account on which the interest was accrued.
3267
+ */
3268
+ accrued_on_account_id: string;
3269
+ /**
3270
+ * The amount in the minor unit of the transaction's currency. For dollars, for
3271
+ * example, this is cents.
3272
+ */
3273
+ amount: number;
3274
+ /**
3275
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
3276
+ * currency.
3277
+ *
3278
+ * - `USD` - US Dollar (USD)
3279
+ */
3280
+ currency: 'USD';
3281
+ /**
3282
+ * The end of the period for which this transaction paid interest.
3283
+ */
3284
+ period_end: string;
3285
+ /**
3286
+ * The start of the period for which this transaction paid interest.
3287
+ */
3288
+ period_start: string;
3289
+ [k: string]: unknown;
3290
+ }
3291
+ /**
3292
+ * An Internal Source object. This field will be present in the JSON response if
3293
+ * and only if `category` is equal to `internal_source`. A transaction between the
3294
+ * user and Increase. See the `reason` attribute for more information.
3295
+ */
3296
+ interface InternalSource {
3297
+ /**
3298
+ * The amount in the minor unit of the transaction's currency. For dollars, for
3299
+ * example, this is cents.
3300
+ */
3301
+ amount: number;
3302
+ /**
3303
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
3304
+ * currency.
3305
+ *
3306
+ * - `USD` - US Dollar (USD)
3307
+ */
3308
+ currency: 'USD';
3309
+ /**
3310
+ * An Internal Source is a transaction between you and Increase. This describes the
3311
+ * reason for the transaction.
3312
+ *
3313
+ * - `account_closure` - Account closure
3314
+ * - `account_revenue_payment_distribution` - Account revenue payment distribution
3315
+ * - `bank_drawn_check` - Bank-drawn check
3316
+ * - `bank_drawn_check_credit` - Bank-drawn check credit
3317
+ * - `bank_migration` - Bank migration
3318
+ * - `check_adjustment` - Check adjustment
3319
+ * - `collection_payment` - Collection payment
3320
+ * - `collection_receivable` - Collection receivable
3321
+ * - `dishonored_ach_return` - Dishonored ACH return
3322
+ * - `empyreal_adjustment` - Empyreal adjustment
3323
+ * - `error` - Error
3324
+ * - `error_correction` - Error correction
3325
+ * - `fees` - Fees
3326
+ * - `interest` - Interest
3327
+ * - `negative_balance_forgiveness` - Negative balance forgiveness
3328
+ * - `sample_funds` - Sample funds
3329
+ * - `sample_funds_return` - Sample funds return
3330
+ */
3331
+ reason: 'account_closure' | 'account_revenue_payment_distribution' | 'bank_drawn_check' | 'bank_drawn_check_credit' | 'bank_migration' | 'check_adjustment' | 'collection_payment' | 'collection_receivable' | 'dishonored_ach_return' | 'empyreal_adjustment' | 'error' | 'error_correction' | 'fees' | 'interest' | 'negative_balance_forgiveness' | 'sample_funds' | 'sample_funds_return';
3332
+ [k: string]: unknown;
3333
+ }
3334
+ /**
3335
+ * If the category of this Transaction source is equal to `other`, this field will
3336
+ * contain an empty object, otherwise it will contain null.
3337
+ */
3338
+ interface Other {
3339
+ }
3340
+ /**
3341
+ * A Real-Time Payments Transfer Acknowledgement object. This field will be present
3342
+ * in the JSON response if and only if `category` is equal to
3343
+ * `real_time_payments_transfer_acknowledgement`. A Real-Time Payments Transfer
3344
+ * Acknowledgement is created when a Real-Time Payments Transfer sent from Increase
3345
+ * is acknowledged by the receiving bank.
3346
+ */
3347
+ interface RealTimePaymentsTransferAcknowledgement {
3348
+ /**
3349
+ * The transfer amount in USD cents.
3350
+ */
3351
+ amount: number;
3352
+ /**
3353
+ * The destination account number.
3354
+ */
3355
+ destination_account_number: string;
3356
+ /**
3357
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN).
3358
+ */
3359
+ destination_routing_number: string;
3360
+ /**
3361
+ * Unstructured information that will show on the recipient's bank statement.
3362
+ */
3363
+ remittance_information: string;
3364
+ /**
3365
+ * The identifier of the Real-Time Payments Transfer that led to this Transaction.
3366
+ */
3367
+ transfer_id: string;
3368
+ [k: string]: unknown;
3369
+ }
3370
+ /**
3371
+ * A Sample Funds object. This field will be present in the JSON response if and
3372
+ * only if `category` is equal to `sample_funds`. Sample funds for testing
3373
+ * purposes.
3374
+ */
3375
+ interface SampleFunds {
3376
+ /**
3377
+ * Where the sample funds came from.
3378
+ */
3379
+ originator: string;
3380
+ [k: string]: unknown;
3381
+ }
3382
+ /**
3383
+ * A Swift Transfer Intention object. This field will be present in the JSON
3384
+ * response if and only if `category` is equal to `swift_transfer_intention`. A
3385
+ * Swift Transfer initiated via Increase.
3386
+ */
3387
+ interface SwiftTransferIntention {
3388
+ /**
3389
+ * The identifier of the Swift Transfer that led to this Transaction.
3390
+ */
3391
+ transfer_id: string;
3392
+ [k: string]: unknown;
3393
+ }
3394
+ /**
3395
+ * A Swift Transfer Return object. This field will be present in the JSON response
3396
+ * if and only if `category` is equal to `swift_transfer_return`. A Swift Transfer
3397
+ * Return is created when a Swift Transfer is returned by the receiving bank.
3398
+ */
3399
+ interface SwiftTransferReturn {
3400
+ /**
3401
+ * The identifier of the Swift Transfer that led to this Transaction.
3402
+ */
3403
+ transfer_id: string;
3404
+ [k: string]: unknown;
3405
+ }
3406
+ /**
3407
+ * A Wire Transfer Intention object. This field will be present in the JSON
3408
+ * response if and only if `category` is equal to `wire_transfer_intention`. A Wire
3409
+ * Transfer initiated via Increase and sent to a different bank.
3410
+ */
3411
+ interface WireTransferIntention {
3412
+ /**
3413
+ * The destination account number.
3414
+ */
3415
+ account_number: string;
3416
+ /**
3417
+ * The transfer amount in USD cents.
3418
+ */
3419
+ amount: number;
3420
+ /**
3421
+ * The message that will show on the recipient's bank statement.
3422
+ */
3423
+ message_to_recipient: string;
3424
+ /**
3425
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN).
3426
+ */
3427
+ routing_number: string;
3428
+ /**
3429
+ * The identifier of the Wire Transfer that led to this Transaction.
3430
+ */
3431
+ transfer_id: string;
3432
+ [k: string]: unknown;
3433
+ }
3434
+ }
3435
+ }
3436
+ export interface TransactionListParams extends PageParams {
3437
+ /**
3438
+ * Filter Transactions for those belonging to the specified Account.
3439
+ */
3440
+ account_id?: string;
3441
+ category?: TransactionListParams.Category;
3442
+ created_at?: TransactionListParams.CreatedAt;
3443
+ /**
3444
+ * Filter Transactions for those belonging to the specified route. This could be a
3445
+ * Card ID or an Account Number ID.
3446
+ */
3447
+ route_id?: string;
3448
+ }
3449
+ export declare namespace TransactionListParams {
3450
+ interface Category {
3451
+ /**
3452
+ * Return results whose value is in the provided list. For GET requests, this
3453
+ * should be encoded as a comma-delimited string, such as `?in=one,two,three`.
3454
+ */
3455
+ in?: Array<'account_transfer_intention' | 'ach_transfer_intention' | 'ach_transfer_rejection' | 'ach_transfer_return' | 'cashback_payment' | 'card_dispute_acceptance' | 'card_dispute_financial' | 'card_dispute_loss' | 'card_refund' | 'card_settlement' | 'card_financial' | 'card_revenue_payment' | 'check_deposit_acceptance' | 'check_deposit_return' | 'fednow_transfer_acknowledgement' | 'check_transfer_deposit' | 'fee_payment' | 'inbound_ach_transfer' | 'inbound_ach_transfer_return_intention' | 'inbound_check_deposit_return_intention' | 'inbound_check_adjustment' | 'inbound_fednow_transfer_confirmation' | 'inbound_real_time_payments_transfer_confirmation' | 'inbound_wire_reversal' | 'inbound_wire_transfer' | 'inbound_wire_transfer_reversal' | 'interest_payment' | 'internal_source' | 'real_time_payments_transfer_acknowledgement' | 'sample_funds' | 'wire_transfer_intention' | 'swift_transfer_intention' | 'swift_transfer_return' | 'card_push_transfer_acceptance' | 'account_revenue_payment' | 'other'>;
3456
+ }
3457
+ interface CreatedAt {
3458
+ /**
3459
+ * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
3460
+ * timestamp.
3461
+ */
3462
+ after?: string;
3463
+ /**
3464
+ * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
3465
+ * timestamp.
3466
+ */
3467
+ before?: string;
3468
+ /**
3469
+ * Return results on or after this
3470
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
3471
+ */
3472
+ on_or_after?: string;
3473
+ /**
3474
+ * Return results on or before this
3475
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
3476
+ */
3477
+ on_or_before?: string;
3478
+ }
3479
+ }
3480
+ export declare namespace Transactions {
3481
+ export { type Transaction as Transaction, type TransactionsPage as TransactionsPage, type TransactionListParams as TransactionListParams, };
3482
+ }
3483
+ //# sourceMappingURL=transactions.d.mts.map