increase 0.2.0 → 0.4.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 (554) hide show
  1. package/.prettierignore +1 -0
  2. package/.release-please-manifest.json +3 -0
  3. package/.stats.yml +1 -1
  4. package/CHANGELOG.md +130 -0
  5. package/README.md +19 -5
  6. package/api.md +99 -0
  7. package/bin/check-release-environment +25 -0
  8. package/bin/publish-npm +6 -0
  9. package/check-version.ts +4 -1
  10. package/core.ts +32 -126
  11. package/dist/cjs/check-version.d.ts +1 -0
  12. package/dist/cjs/check-version.d.ts.map +1 -0
  13. package/dist/cjs/check-version.js +3 -1
  14. package/dist/cjs/check-version.js.map +1 -1
  15. package/dist/cjs/core.d.ts +25 -55
  16. package/dist/cjs/core.d.ts.map +1 -0
  17. package/dist/cjs/core.js +43 -168
  18. package/dist/cjs/core.js.map +1 -1
  19. package/dist/cjs/error.d.ts +208 -0
  20. package/dist/cjs/error.d.ts.map +1 -0
  21. package/dist/cjs/error.js +326 -0
  22. package/dist/cjs/error.js.map +1 -0
  23. package/dist/cjs/examples/api-error.d.ts +3 -0
  24. package/dist/cjs/examples/api-error.d.ts.map +1 -0
  25. package/dist/cjs/examples/api-error.js +92 -0
  26. package/dist/cjs/examples/api-error.js.map +1 -0
  27. package/dist/cjs/fetch-polyfill.d.ts +1 -0
  28. package/dist/cjs/fetch-polyfill.d.ts.map +1 -0
  29. package/dist/cjs/fetch-polyfill.js +2 -2
  30. package/dist/cjs/fetch-polyfill.js.map +1 -1
  31. package/dist/cjs/index.d.ts +81 -22
  32. package/dist/cjs/index.d.ts.map +1 -0
  33. package/dist/cjs/index.js +80 -26
  34. package/dist/cjs/index.js.map +1 -1
  35. package/dist/cjs/pagination.d.ts +4 -0
  36. package/dist/cjs/pagination.d.ts.map +1 -0
  37. package/dist/cjs/pagination.js.map +1 -1
  38. package/dist/cjs/resource.d.ts +1 -0
  39. package/dist/cjs/resource.d.ts.map +1 -0
  40. package/dist/cjs/resources/account-numbers.d.ts +26 -0
  41. package/dist/cjs/resources/account-numbers.d.ts.map +1 -0
  42. package/dist/cjs/resources/account-numbers.js.map +1 -1
  43. package/dist/cjs/resources/account-statements.d.ts +1 -0
  44. package/dist/cjs/resources/account-statements.d.ts.map +1 -0
  45. package/dist/cjs/resources/account-statements.js.map +1 -1
  46. package/dist/cjs/resources/account-transfers.d.ts +20 -11
  47. package/dist/cjs/resources/account-transfers.d.ts.map +1 -0
  48. package/dist/cjs/resources/account-transfers.js.map +1 -1
  49. package/dist/cjs/resources/accounts.d.ts +41 -19
  50. package/dist/cjs/resources/accounts.d.ts.map +1 -0
  51. package/dist/cjs/resources/accounts.js.map +1 -1
  52. package/dist/cjs/resources/ach-prenotifications.d.ts +4 -0
  53. package/dist/cjs/resources/ach-prenotifications.d.ts.map +1 -0
  54. package/dist/cjs/resources/ach-prenotifications.js.map +1 -1
  55. package/dist/cjs/resources/ach-transfers.d.ts +89 -9
  56. package/dist/cjs/resources/ach-transfers.d.ts.map +1 -0
  57. package/dist/cjs/resources/ach-transfers.js.map +1 -1
  58. package/dist/cjs/resources/balance-lookups.d.ts +47 -0
  59. package/dist/cjs/resources/balance-lookups.d.ts.map +1 -0
  60. package/dist/cjs/resources/balance-lookups.js +15 -0
  61. package/dist/cjs/resources/balance-lookups.js.map +1 -0
  62. package/dist/cjs/resources/bookkeeping-accounts.d.ts +71 -0
  63. package/dist/cjs/resources/bookkeeping-accounts.d.ts.map +1 -0
  64. package/dist/cjs/resources/bookkeeping-accounts.js +29 -0
  65. package/dist/cjs/resources/bookkeeping-accounts.js.map +1 -0
  66. package/dist/cjs/resources/bookkeeping-entries.d.ts +43 -0
  67. package/dist/cjs/resources/bookkeeping-entries.d.ts.map +1 -0
  68. package/dist/cjs/resources/bookkeeping-entries.js +19 -0
  69. package/dist/cjs/resources/bookkeeping-entries.js.map +1 -0
  70. package/dist/cjs/resources/bookkeeping-entry-sets.d.ts +83 -0
  71. package/dist/cjs/resources/bookkeeping-entry-sets.d.ts.map +1 -0
  72. package/dist/cjs/resources/bookkeeping-entry-sets.js +15 -0
  73. package/dist/cjs/resources/bookkeeping-entry-sets.js.map +1 -0
  74. package/dist/cjs/resources/card-disputes.d.ts +13 -3
  75. package/dist/cjs/resources/card-disputes.d.ts.map +1 -0
  76. package/dist/cjs/resources/card-disputes.js.map +1 -1
  77. package/dist/cjs/resources/card-profiles.d.ts +18 -2
  78. package/dist/cjs/resources/card-profiles.d.ts.map +1 -0
  79. package/dist/cjs/resources/card-profiles.js.map +1 -1
  80. package/dist/cjs/resources/cards.d.ts +31 -2
  81. package/dist/cjs/resources/cards.d.ts.map +1 -0
  82. package/dist/cjs/resources/cards.js.map +1 -1
  83. package/dist/cjs/resources/check-deposits.d.ts +16 -1
  84. package/dist/cjs/resources/check-deposits.d.ts.map +1 -0
  85. package/dist/cjs/resources/check-deposits.js.map +1 -1
  86. package/dist/cjs/resources/check-transfers.d.ts +104 -5
  87. package/dist/cjs/resources/check-transfers.d.ts.map +1 -0
  88. package/dist/cjs/resources/check-transfers.js.map +1 -1
  89. package/dist/cjs/resources/declined-transactions.d.ts +85 -23
  90. package/dist/cjs/resources/declined-transactions.d.ts.map +1 -0
  91. package/dist/cjs/resources/declined-transactions.js.map +1 -1
  92. package/dist/cjs/resources/digital-wallet-tokens.d.ts +1 -0
  93. package/dist/cjs/resources/digital-wallet-tokens.d.ts.map +1 -0
  94. package/dist/cjs/resources/digital-wallet-tokens.js.map +1 -1
  95. package/dist/cjs/resources/documents.d.ts +105 -4
  96. package/dist/cjs/resources/documents.d.ts.map +1 -0
  97. package/dist/cjs/resources/documents.js.map +1 -1
  98. package/dist/cjs/resources/entities/entities.d.ts +363 -136
  99. package/dist/cjs/resources/entities/entities.d.ts.map +1 -0
  100. package/dist/cjs/resources/entities/entities.js +1 -1
  101. package/dist/cjs/resources/entities/entities.js.map +1 -1
  102. package/dist/cjs/resources/entities/index.d.ts +7 -1
  103. package/dist/cjs/resources/entities/index.d.ts.map +1 -0
  104. package/dist/cjs/resources/entities/index.js +8 -1
  105. package/dist/cjs/resources/entities/index.js.map +1 -1
  106. package/dist/cjs/resources/entities/supplemental-documents.d.ts +36 -0
  107. package/dist/cjs/resources/entities/supplemental-documents.d.ts.map +1 -0
  108. package/dist/cjs/resources/entities/supplemental-documents.js +14 -1
  109. package/dist/cjs/resources/entities/supplemental-documents.js.map +1 -1
  110. package/dist/cjs/resources/event-subscriptions.d.ts +5 -0
  111. package/dist/cjs/resources/event-subscriptions.d.ts.map +1 -0
  112. package/dist/cjs/resources/event-subscriptions.js.map +1 -1
  113. package/dist/cjs/resources/events.d.ts +30 -24
  114. package/dist/cjs/resources/events.d.ts.map +1 -0
  115. package/dist/cjs/resources/events.js.map +1 -1
  116. package/dist/cjs/resources/exports.d.ts +162 -0
  117. package/dist/cjs/resources/exports.d.ts.map +1 -0
  118. package/dist/cjs/resources/exports.js +31 -0
  119. package/dist/cjs/resources/exports.js.map +1 -0
  120. package/dist/cjs/resources/external-accounts.d.ts +4 -2
  121. package/dist/cjs/resources/external-accounts.d.ts.map +1 -0
  122. package/dist/cjs/resources/external-accounts.js.map +1 -1
  123. package/dist/cjs/resources/files.d.ts +10 -4
  124. package/dist/cjs/resources/files.d.ts.map +1 -0
  125. package/dist/cjs/resources/files.js.map +1 -1
  126. package/dist/cjs/resources/groups.d.ts +1 -0
  127. package/dist/cjs/resources/groups.d.ts.map +1 -0
  128. package/dist/cjs/resources/inbound-ach-transfer-returns.d.ts +4 -0
  129. package/dist/cjs/resources/inbound-ach-transfer-returns.d.ts.map +1 -0
  130. package/dist/cjs/resources/inbound-ach-transfer-returns.js.map +1 -1
  131. package/dist/cjs/resources/inbound-wire-drawdown-requests.d.ts +1 -0
  132. package/dist/cjs/resources/inbound-wire-drawdown-requests.d.ts.map +1 -0
  133. package/dist/cjs/resources/inbound-wire-drawdown-requests.js.map +1 -1
  134. package/dist/cjs/resources/index.d.ts +29 -0
  135. package/dist/cjs/resources/index.d.ts.map +1 -0
  136. package/dist/cjs/resources/index.js +100 -9
  137. package/dist/cjs/resources/index.js.map +1 -1
  138. package/dist/cjs/resources/limits.d.ts +1 -0
  139. package/dist/cjs/resources/limits.d.ts.map +1 -0
  140. package/dist/cjs/resources/limits.js.map +1 -1
  141. package/dist/cjs/resources/oauth-connections.d.ts +1 -0
  142. package/dist/cjs/resources/oauth-connections.d.ts.map +1 -0
  143. package/dist/cjs/resources/oauth-connections.js.map +1 -1
  144. package/dist/cjs/resources/pending-transactions.d.ts +115 -36
  145. package/dist/cjs/resources/pending-transactions.d.ts.map +1 -0
  146. package/dist/cjs/resources/pending-transactions.js.map +1 -1
  147. package/dist/cjs/resources/programs.d.ts +48 -0
  148. package/dist/cjs/resources/programs.d.ts.map +1 -0
  149. package/dist/cjs/resources/programs.js +25 -0
  150. package/dist/cjs/resources/programs.js.map +1 -0
  151. package/dist/cjs/resources/real-time-decisions.d.ts +43 -7
  152. package/dist/cjs/resources/real-time-decisions.d.ts.map +1 -0
  153. package/dist/cjs/resources/real-time-payments-transfers.d.ts +287 -0
  154. package/dist/cjs/resources/real-time-payments-transfers.d.ts.map +1 -0
  155. package/dist/cjs/resources/real-time-payments-transfers.js +35 -0
  156. package/dist/cjs/resources/real-time-payments-transfers.js.map +1 -0
  157. package/dist/cjs/resources/routing-numbers.d.ts +1 -0
  158. package/dist/cjs/resources/routing-numbers.d.ts.map +1 -0
  159. package/dist/cjs/resources/shared.d.ts +1 -0
  160. package/dist/cjs/resources/shared.d.ts.map +1 -0
  161. package/dist/cjs/resources/simulations/account-statements.d.ts +1 -0
  162. package/dist/cjs/resources/simulations/account-statements.d.ts.map +1 -0
  163. package/dist/cjs/resources/simulations/account-transfers.d.ts +1 -0
  164. package/dist/cjs/resources/simulations/account-transfers.d.ts.map +1 -0
  165. package/dist/cjs/resources/simulations/ach-transfers.d.ts +470 -157
  166. package/dist/cjs/resources/simulations/ach-transfers.d.ts.map +1 -0
  167. package/dist/cjs/resources/simulations/card-disputes.d.ts +1 -0
  168. package/dist/cjs/resources/simulations/card-disputes.d.ts.map +1 -0
  169. package/dist/cjs/resources/simulations/card-refunds.d.ts +1 -0
  170. package/dist/cjs/resources/simulations/card-refunds.d.ts.map +1 -0
  171. package/dist/cjs/resources/simulations/cards.d.ts +188 -56
  172. package/dist/cjs/resources/simulations/cards.d.ts.map +1 -0
  173. package/dist/cjs/resources/simulations/check-deposits.d.ts +1 -0
  174. package/dist/cjs/resources/simulations/check-deposits.d.ts.map +1 -0
  175. package/dist/cjs/resources/simulations/check-transfers.d.ts +16 -0
  176. package/dist/cjs/resources/simulations/check-transfers.d.ts.map +1 -0
  177. package/dist/cjs/resources/simulations/check-transfers.js +10 -0
  178. package/dist/cjs/resources/simulations/check-transfers.js.map +1 -1
  179. package/dist/cjs/resources/simulations/digital-wallet-token-requests.d.ts +1 -0
  180. package/dist/cjs/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -0
  181. package/dist/cjs/resources/simulations/documents.d.ts +1 -0
  182. package/dist/cjs/resources/simulations/documents.d.ts.map +1 -0
  183. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.d.ts +1 -0
  184. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -0
  185. package/dist/cjs/resources/simulations/index.d.ts +5 -0
  186. package/dist/cjs/resources/simulations/index.d.ts.map +1 -0
  187. package/dist/cjs/resources/simulations/interest-payments.d.ts +1237 -0
  188. package/dist/cjs/resources/simulations/interest-payments.d.ts.map +1 -0
  189. package/dist/cjs/resources/simulations/interest-payments.js +16 -0
  190. package/dist/cjs/resources/simulations/interest-payments.js.map +1 -0
  191. package/dist/cjs/resources/simulations/programs.d.ts +21 -0
  192. package/dist/cjs/resources/simulations/programs.d.ts.map +1 -0
  193. package/dist/cjs/resources/simulations/programs.js +17 -0
  194. package/dist/cjs/resources/simulations/programs.js.map +1 -0
  195. package/dist/cjs/resources/simulations/real-time-payments-transfers.d.ts +470 -155
  196. package/dist/cjs/resources/simulations/real-time-payments-transfers.d.ts.map +1 -0
  197. package/dist/cjs/resources/simulations/real-time-payments-transfers.js +11 -0
  198. package/dist/cjs/resources/simulations/real-time-payments-transfers.js.map +1 -1
  199. package/dist/cjs/resources/simulations/simulations.d.ts +5 -0
  200. package/dist/cjs/resources/simulations/simulations.d.ts.map +1 -0
  201. package/dist/cjs/resources/simulations/simulations.js +4 -0
  202. package/dist/cjs/resources/simulations/simulations.js.map +1 -1
  203. package/dist/cjs/resources/simulations/wire-transfers.d.ts +332 -133
  204. package/dist/cjs/resources/simulations/wire-transfers.d.ts.map +1 -0
  205. package/dist/cjs/resources/transactions.d.ts +353 -165
  206. package/dist/cjs/resources/transactions.d.ts.map +1 -0
  207. package/dist/cjs/resources/transactions.js.map +1 -1
  208. package/dist/cjs/resources/wire-drawdown-requests.d.ts +5 -0
  209. package/dist/cjs/resources/wire-drawdown-requests.d.ts.map +1 -0
  210. package/dist/cjs/resources/wire-drawdown-requests.js.map +1 -1
  211. package/dist/cjs/resources/wire-transfers.d.ts +39 -4
  212. package/dist/cjs/resources/wire-transfers.d.ts.map +1 -0
  213. package/dist/cjs/resources/wire-transfers.js.map +1 -1
  214. package/dist/cjs/streaming.d.ts +13 -0
  215. package/dist/cjs/streaming.d.ts.map +1 -0
  216. package/dist/cjs/streaming.js +282 -0
  217. package/dist/cjs/streaming.js.map +1 -0
  218. package/dist/cjs/tests/api-resources/account-numbers.test.d.ts +1 -0
  219. package/dist/cjs/tests/api-resources/account-numbers.test.d.ts.map +1 -0
  220. package/dist/cjs/tests/api-resources/account-numbers.test.js +25 -28
  221. package/dist/cjs/tests/api-resources/account-numbers.test.js.map +1 -1
  222. package/dist/cjs/tests/api-resources/account-statements.test.d.ts +1 -0
  223. package/dist/cjs/tests/api-resources/account-statements.test.d.ts.map +1 -0
  224. package/dist/cjs/tests/api-resources/account-statements.test.js +7 -20
  225. package/dist/cjs/tests/api-resources/account-statements.test.js.map +1 -1
  226. package/dist/cjs/tests/api-resources/account-transfers.test.d.ts +1 -0
  227. package/dist/cjs/tests/api-resources/account-transfers.test.d.ts.map +1 -0
  228. package/dist/cjs/tests/api-resources/account-transfers.test.js +16 -29
  229. package/dist/cjs/tests/api-resources/account-transfers.test.js.map +1 -1
  230. package/dist/cjs/tests/api-resources/accounts.test.d.ts +1 -0
  231. package/dist/cjs/tests/api-resources/accounts.test.d.ts.map +1 -0
  232. package/dist/cjs/tests/api-resources/accounts.test.js +22 -23
  233. package/dist/cjs/tests/api-resources/accounts.test.js.map +1 -1
  234. package/dist/cjs/tests/api-resources/ach-prenotifications.test.d.ts +1 -0
  235. package/dist/cjs/tests/api-resources/ach-prenotifications.test.d.ts.map +1 -0
  236. package/dist/cjs/tests/api-resources/ach-prenotifications.test.js +12 -24
  237. package/dist/cjs/tests/api-resources/ach-prenotifications.test.js.map +1 -1
  238. package/dist/cjs/tests/api-resources/ach-transfers.test.d.ts +1 -0
  239. package/dist/cjs/tests/api-resources/ach-transfers.test.d.ts.map +1 -0
  240. package/dist/cjs/tests/api-resources/ach-transfers.test.js +17 -31
  241. package/dist/cjs/tests/api-resources/ach-transfers.test.js.map +1 -1
  242. package/dist/cjs/tests/api-resources/balance-lookups.test.d.ts +2 -0
  243. package/dist/cjs/tests/api-resources/balance-lookups.test.d.ts.map +1 -0
  244. package/dist/cjs/tests/api-resources/balance-lookups.test.js +55 -0
  245. package/dist/cjs/tests/api-resources/balance-lookups.test.js.map +1 -0
  246. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.d.ts +2 -0
  247. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.d.ts.map +1 -0
  248. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.js +78 -0
  249. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.js.map +1 -0
  250. package/dist/cjs/tests/api-resources/bookkeeping-entries.test.d.ts +2 -0
  251. package/dist/cjs/tests/api-resources/bookkeeping-entries.test.d.ts.map +1 -0
  252. package/dist/cjs/tests/api-resources/bookkeeping-entries.test.js +65 -0
  253. package/dist/cjs/tests/api-resources/bookkeeping-entries.test.js.map +1 -0
  254. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.d.ts +2 -0
  255. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.d.ts.map +1 -0
  256. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.js +66 -0
  257. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.js.map +1 -0
  258. package/dist/cjs/tests/api-resources/card-disputes.test.d.ts +1 -0
  259. package/dist/cjs/tests/api-resources/card-disputes.test.d.ts.map +1 -0
  260. package/dist/cjs/tests/api-resources/card-disputes.test.js +18 -24
  261. package/dist/cjs/tests/api-resources/card-disputes.test.js.map +1 -1
  262. package/dist/cjs/tests/api-resources/card-profiles.test.d.ts +1 -0
  263. package/dist/cjs/tests/api-resources/card-profiles.test.d.ts.map +1 -0
  264. package/dist/cjs/tests/api-resources/card-profiles.test.js +28 -19
  265. package/dist/cjs/tests/api-resources/card-profiles.test.js.map +1 -1
  266. package/dist/cjs/tests/api-resources/cards.test.d.ts +1 -0
  267. package/dist/cjs/tests/api-resources/cards.test.d.ts.map +1 -0
  268. package/dist/cjs/tests/api-resources/cards.test.js +13 -35
  269. package/dist/cjs/tests/api-resources/cards.test.js.map +1 -1
  270. package/dist/cjs/tests/api-resources/check-deposits.test.d.ts +1 -0
  271. package/dist/cjs/tests/api-resources/check-deposits.test.d.ts.map +1 -0
  272. package/dist/cjs/tests/api-resources/check-deposits.test.js +24 -27
  273. package/dist/cjs/tests/api-resources/check-deposits.test.js.map +1 -1
  274. package/dist/cjs/tests/api-resources/check-transfers.test.d.ts +1 -0
  275. package/dist/cjs/tests/api-resources/check-transfers.test.d.ts.map +1 -0
  276. package/dist/cjs/tests/api-resources/check-transfers.test.js +27 -40
  277. package/dist/cjs/tests/api-resources/check-transfers.test.js.map +1 -1
  278. package/dist/cjs/tests/api-resources/declined-transactions.test.d.ts +1 -0
  279. package/dist/cjs/tests/api-resources/declined-transactions.test.d.ts.map +1 -0
  280. package/dist/cjs/tests/api-resources/declined-transactions.test.js +9 -23
  281. package/dist/cjs/tests/api-resources/declined-transactions.test.js.map +1 -1
  282. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.d.ts +1 -0
  283. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.d.ts.map +1 -0
  284. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.js +8 -21
  285. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.js.map +1 -1
  286. package/dist/cjs/tests/api-resources/documents.test.d.ts +1 -0
  287. package/dist/cjs/tests/api-resources/documents.test.d.ts.map +1 -0
  288. package/dist/cjs/tests/api-resources/documents.test.js +15 -23
  289. package/dist/cjs/tests/api-resources/documents.test.js.map +1 -1
  290. package/dist/cjs/tests/api-resources/entities/entities.test.d.ts +1 -0
  291. package/dist/cjs/tests/api-resources/entities/entities.test.d.ts.map +1 -0
  292. package/dist/cjs/tests/api-resources/entities/entities.test.js +40 -31
  293. package/dist/cjs/tests/api-resources/entities/entities.test.js.map +1 -1
  294. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.d.ts +1 -0
  295. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.d.ts.map +1 -0
  296. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.js +25 -6
  297. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.js.map +1 -1
  298. package/dist/cjs/tests/api-resources/event-subscriptions.test.d.ts +1 -0
  299. package/dist/cjs/tests/api-resources/event-subscriptions.test.d.ts.map +1 -0
  300. package/dist/cjs/tests/api-resources/event-subscriptions.test.js +10 -20
  301. package/dist/cjs/tests/api-resources/event-subscriptions.test.js.map +1 -1
  302. package/dist/cjs/tests/api-resources/events.test.d.ts +1 -0
  303. package/dist/cjs/tests/api-resources/events.test.d.ts.map +1 -0
  304. package/dist/cjs/tests/api-resources/events.test.js +8 -22
  305. package/dist/cjs/tests/api-resources/events.test.js.map +1 -1
  306. package/dist/cjs/tests/api-resources/exports.test.d.ts +2 -0
  307. package/dist/cjs/tests/api-resources/exports.test.d.ts.map +1 -0
  308. package/dist/cjs/tests/api-resources/exports.test.js +101 -0
  309. package/dist/cjs/tests/api-resources/exports.test.js.map +1 -0
  310. package/dist/cjs/tests/api-resources/external-accounts.test.d.ts +1 -0
  311. package/dist/cjs/tests/api-resources/external-accounts.test.d.ts.map +1 -0
  312. package/dist/cjs/tests/api-resources/external-accounts.test.js +13 -27
  313. package/dist/cjs/tests/api-resources/external-accounts.test.js.map +1 -1
  314. package/dist/cjs/tests/api-resources/files.test.d.ts +1 -0
  315. package/dist/cjs/tests/api-resources/files.test.d.ts.map +1 -0
  316. package/dist/cjs/tests/api-resources/files.test.js +8 -21
  317. package/dist/cjs/tests/api-resources/files.test.js.map +1 -1
  318. package/dist/cjs/tests/api-resources/groups.test.d.ts +1 -0
  319. package/dist/cjs/tests/api-resources/groups.test.d.ts.map +1 -0
  320. package/dist/cjs/tests/api-resources/groups.test.js +6 -5
  321. package/dist/cjs/tests/api-resources/groups.test.js.map +1 -1
  322. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.d.ts +1 -0
  323. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.d.ts.map +1 -0
  324. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.js +16 -12
  325. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.js.map +1 -1
  326. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.d.ts +1 -0
  327. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.d.ts.map +1 -0
  328. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.js +6 -9
  329. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.js.map +1 -1
  330. package/dist/cjs/tests/api-resources/limits.test.d.ts +1 -0
  331. package/dist/cjs/tests/api-resources/limits.test.d.ts.map +1 -0
  332. package/dist/cjs/tests/api-resources/limits.test.js +14 -17
  333. package/dist/cjs/tests/api-resources/limits.test.js.map +1 -1
  334. package/dist/cjs/tests/api-resources/oauth-connections.test.d.ts +1 -0
  335. package/dist/cjs/tests/api-resources/oauth-connections.test.d.ts.map +1 -0
  336. package/dist/cjs/tests/api-resources/oauth-connections.test.js +6 -9
  337. package/dist/cjs/tests/api-resources/oauth-connections.test.js.map +1 -1
  338. package/dist/cjs/tests/api-resources/pending-transactions.test.d.ts +1 -0
  339. package/dist/cjs/tests/api-resources/pending-transactions.test.d.ts.map +1 -0
  340. package/dist/cjs/tests/api-resources/pending-transactions.test.js +13 -17
  341. package/dist/cjs/tests/api-resources/pending-transactions.test.js.map +1 -1
  342. package/dist/cjs/tests/api-resources/programs.test.d.ts +2 -0
  343. package/dist/cjs/tests/api-resources/programs.test.d.ts.map +1 -0
  344. package/dist/cjs/tests/api-resources/programs.test.js +73 -0
  345. package/dist/cjs/tests/api-resources/programs.test.js.map +1 -0
  346. package/dist/cjs/tests/api-resources/real-time-decisions.test.d.ts +1 -0
  347. package/dist/cjs/tests/api-resources/real-time-decisions.test.d.ts.map +1 -0
  348. package/dist/cjs/tests/api-resources/real-time-decisions.test.js +6 -16
  349. package/dist/cjs/tests/api-resources/real-time-decisions.test.js.map +1 -1
  350. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.d.ts +2 -0
  351. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.d.ts.map +1 -0
  352. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.js +113 -0
  353. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.js.map +1 -0
  354. package/dist/cjs/tests/api-resources/routing-numbers.test.d.ts +1 -0
  355. package/dist/cjs/tests/api-resources/routing-numbers.test.d.ts.map +1 -0
  356. package/dist/cjs/tests/api-resources/routing-numbers.test.js +6 -5
  357. package/dist/cjs/tests/api-resources/routing-numbers.test.js.map +1 -1
  358. package/dist/cjs/tests/api-resources/simulations/account-statements.test.d.ts +1 -0
  359. package/dist/cjs/tests/api-resources/simulations/account-statements.test.d.ts.map +1 -0
  360. package/dist/cjs/tests/api-resources/simulations/account-statements.test.js +11 -8
  361. package/dist/cjs/tests/api-resources/simulations/account-statements.test.js.map +1 -1
  362. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.d.ts +1 -0
  363. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.d.ts.map +1 -0
  364. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.js +5 -4
  365. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.js.map +1 -1
  366. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.d.ts +1 -0
  367. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.d.ts.map +1 -0
  368. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.js +13 -19
  369. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.js.map +1 -1
  370. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.d.ts +1 -0
  371. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.d.ts.map +1 -0
  372. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.js +8 -7
  373. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.js.map +1 -1
  374. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.d.ts +1 -0
  375. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.d.ts.map +1 -0
  376. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.js +11 -8
  377. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.js.map +1 -1
  378. package/dist/cjs/tests/api-resources/simulations/cards.test.d.ts +1 -0
  379. package/dist/cjs/tests/api-resources/simulations/cards.test.d.ts.map +1 -0
  380. package/dist/cjs/tests/api-resources/simulations/cards.test.js +12 -10
  381. package/dist/cjs/tests/api-resources/simulations/cards.test.js.map +1 -1
  382. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.d.ts +1 -0
  383. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.d.ts.map +1 -0
  384. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.js +5 -4
  385. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.js.map +1 -1
  386. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.d.ts +1 -0
  387. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.d.ts.map +1 -0
  388. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.js +23 -4
  389. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.js.map +1 -1
  390. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.d.ts +1 -0
  391. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.d.ts.map +1 -0
  392. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.js +11 -8
  393. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.js.map +1 -1
  394. package/dist/cjs/tests/api-resources/simulations/documents.test.d.ts +1 -0
  395. package/dist/cjs/tests/api-resources/simulations/documents.test.d.ts.map +1 -0
  396. package/dist/cjs/tests/api-resources/simulations/documents.test.js +10 -7
  397. package/dist/cjs/tests/api-resources/simulations/documents.test.js.map +1 -1
  398. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.d.ts +1 -0
  399. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.d.ts.map +1 -0
  400. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.js +29 -28
  401. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.js.map +1 -1
  402. package/dist/cjs/tests/api-resources/simulations/interest-payments.test.d.ts +2 -0
  403. package/dist/cjs/tests/api-resources/simulations/interest-payments.test.d.ts.map +1 -0
  404. package/dist/cjs/tests/api-resources/simulations/interest-payments.test.js +58 -0
  405. package/dist/cjs/tests/api-resources/simulations/interest-payments.test.js.map +1 -0
  406. package/dist/cjs/tests/api-resources/simulations/programs.test.d.ts +2 -0
  407. package/dist/cjs/tests/api-resources/simulations/programs.test.d.ts.map +1 -0
  408. package/dist/cjs/tests/api-resources/simulations/programs.test.js +52 -0
  409. package/dist/cjs/tests/api-resources/simulations/programs.test.js.map +1 -0
  410. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.d.ts +1 -0
  411. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.d.ts.map +1 -0
  412. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.js +20 -12
  413. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.js.map +1 -1
  414. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.d.ts +1 -0
  415. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.d.ts.map +1 -0
  416. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.js +11 -10
  417. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.js.map +1 -1
  418. package/dist/cjs/tests/api-resources/transactions.test.d.ts +1 -0
  419. package/dist/cjs/tests/api-resources/transactions.test.d.ts.map +1 -0
  420. package/dist/cjs/tests/api-resources/transactions.test.js +11 -28
  421. package/dist/cjs/tests/api-resources/transactions.test.js.map +1 -1
  422. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.d.ts +1 -0
  423. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.d.ts.map +1 -0
  424. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.js +20 -23
  425. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.js.map +1 -1
  426. package/dist/cjs/tests/api-resources/wire-transfers.test.d.ts +1 -0
  427. package/dist/cjs/tests/api-resources/wire-transfers.test.d.ts.map +1 -0
  428. package/dist/cjs/tests/api-resources/wire-transfers.test.js +22 -36
  429. package/dist/cjs/tests/api-resources/wire-transfers.test.js.map +1 -1
  430. package/dist/cjs/tests/form.test.d.ts +1 -0
  431. package/dist/cjs/tests/form.test.d.ts.map +1 -0
  432. package/dist/cjs/tests/form.test.js +4 -3
  433. package/dist/cjs/tests/index.test.d.ts +1 -0
  434. package/dist/cjs/tests/index.test.d.ts.map +1 -0
  435. package/dist/cjs/tests/index.test.js +36 -4
  436. package/dist/cjs/tests/index.test.js.map +1 -1
  437. package/dist/cjs/tests/responses.test.d.ts +1 -0
  438. package/dist/cjs/tests/responses.test.d.ts.map +1 -0
  439. package/dist/cjs/tests/responses.test.js +4 -3
  440. package/dist/cjs/version.d.ts +2 -1
  441. package/dist/cjs/version.d.ts.map +1 -0
  442. package/dist/cjs/version.js +1 -1
  443. package/dist/cjs/version.js.map +1 -1
  444. package/error.ts +505 -0
  445. package/examples/api-error.ts +21 -0
  446. package/fetch-polyfill.ts +2 -2
  447. package/index.ts +90 -20
  448. package/package.json +2 -2
  449. package/pagination.ts +3 -0
  450. package/release-please-config.json +61 -0
  451. package/resources/account-numbers.ts +30 -1
  452. package/resources/account-statements.ts +0 -1
  453. package/resources/account-transfers.ts +21 -13
  454. package/resources/accounts.ts +48 -23
  455. package/resources/ach-prenotifications.ts +3 -1
  456. package/resources/ach-transfers.ts +92 -11
  457. package/resources/balance-lookups.ts +57 -0
  458. package/resources/bookkeeping-accounts.ts +98 -0
  459. package/resources/bookkeeping-entries.ts +62 -0
  460. package/resources/bookkeeping-entry-sets.ts +100 -0
  461. package/resources/card-disputes.ts +12 -4
  462. package/resources/card-profiles.ts +17 -3
  463. package/resources/cards.ts +30 -3
  464. package/resources/check-deposits.ts +15 -2
  465. package/resources/check-transfers.ts +117 -7
  466. package/resources/declined-transactions.ts +96 -27
  467. package/resources/digital-wallet-tokens.ts +0 -1
  468. package/resources/documents.ts +104 -5
  469. package/resources/entities/entities.ts +443 -212
  470. package/resources/entities/index.ts +6 -1
  471. package/resources/entities/supplemental-documents.ts +46 -0
  472. package/resources/event-subscriptions.ts +4 -1
  473. package/resources/events.ts +33 -29
  474. package/resources/exports.ts +204 -0
  475. package/resources/external-accounts.ts +3 -3
  476. package/resources/files.ts +9 -5
  477. package/resources/inbound-ach-transfer-returns.ts +3 -1
  478. package/resources/inbound-wire-drawdown-requests.ts +0 -1
  479. package/resources/index.ts +28 -0
  480. package/resources/limits.ts +0 -1
  481. package/resources/oauth-connections.ts +0 -1
  482. package/resources/pending-transactions.ts +126 -48
  483. package/resources/programs.ts +70 -0
  484. package/resources/real-time-decisions.ts +43 -8
  485. package/resources/real-time-payments-transfers.ts +351 -0
  486. package/resources/simulations/ach-transfers.ts +504 -192
  487. package/resources/simulations/cards.ts +206 -69
  488. package/resources/simulations/check-transfers.ts +19 -0
  489. package/resources/simulations/index.ts +4 -0
  490. package/resources/simulations/interest-payments.ts +1501 -0
  491. package/resources/simulations/programs.ts +26 -0
  492. package/resources/simulations/real-time-payments-transfers.ts +512 -190
  493. package/resources/simulations/simulations.ts +4 -0
  494. package/resources/simulations/wire-transfers.ts +354 -165
  495. package/resources/transactions.ts +379 -202
  496. package/resources/wire-drawdown-requests.ts +4 -1
  497. package/resources/wire-transfers.ts +43 -6
  498. package/streaming.ts +199 -0
  499. package/tests/api-resources/account-numbers.test.ts +22 -25
  500. package/tests/api-resources/account-statements.test.ts +4 -17
  501. package/tests/api-resources/account-transfers.test.ts +13 -26
  502. package/tests/api-resources/accounts.test.ts +19 -20
  503. package/tests/api-resources/ach-prenotifications.test.ts +9 -21
  504. package/tests/api-resources/ach-transfers.test.ts +14 -28
  505. package/tests/api-resources/balance-lookups.test.ts +18 -0
  506. package/tests/api-resources/bookkeeping-accounts.test.ts +38 -0
  507. package/tests/api-resources/bookkeeping-entries.test.ts +25 -0
  508. package/tests/api-resources/bookkeeping-entry-sets.test.ts +29 -0
  509. package/tests/api-resources/card-disputes.test.ts +15 -21
  510. package/tests/api-resources/card-profiles.test.ts +25 -16
  511. package/tests/api-resources/cards.test.ts +10 -32
  512. package/tests/api-resources/check-deposits.test.ts +21 -24
  513. package/tests/api-resources/check-transfers.test.ts +24 -37
  514. package/tests/api-resources/declined-transactions.test.ts +6 -20
  515. package/tests/api-resources/digital-wallet-tokens.test.ts +5 -18
  516. package/tests/api-resources/documents.test.ts +8 -20
  517. package/tests/api-resources/entities/entities.test.ts +37 -31
  518. package/tests/api-resources/entities/supplemental-documents.test.ts +22 -3
  519. package/tests/api-resources/event-subscriptions.test.ts +7 -17
  520. package/tests/api-resources/events.test.ts +5 -19
  521. package/tests/api-resources/exports.test.ts +64 -0
  522. package/tests/api-resources/external-accounts.test.ts +10 -24
  523. package/tests/api-resources/files.test.ts +5 -19
  524. package/tests/api-resources/groups.test.ts +3 -2
  525. package/tests/api-resources/inbound-ach-transfer-returns.test.ts +13 -9
  526. package/tests/api-resources/inbound-wire-drawdown-requests.test.ts +3 -6
  527. package/tests/api-resources/limits.test.ts +11 -14
  528. package/tests/api-resources/oauth-connections.test.ts +3 -6
  529. package/tests/api-resources/pending-transactions.test.ts +10 -14
  530. package/tests/api-resources/programs.test.ts +36 -0
  531. package/tests/api-resources/real-time-decisions.test.ts +3 -13
  532. package/tests/api-resources/real-time-payments-transfers.test.ts +76 -0
  533. package/tests/api-resources/routing-numbers.test.ts +3 -2
  534. package/tests/api-resources/simulations/account-statements.test.ts +8 -5
  535. package/tests/api-resources/simulations/account-transfers.test.ts +2 -1
  536. package/tests/api-resources/simulations/ach-transfers.test.ts +10 -16
  537. package/tests/api-resources/simulations/card-disputes.test.ts +5 -4
  538. package/tests/api-resources/simulations/card-refunds.test.ts +8 -5
  539. package/tests/api-resources/simulations/cards.test.ts +9 -7
  540. package/tests/api-resources/simulations/check-deposits.test.ts +2 -1
  541. package/tests/api-resources/simulations/check-transfers.test.ts +14 -1
  542. package/tests/api-resources/simulations/digital-wallet-token-requests.test.ts +8 -5
  543. package/tests/api-resources/simulations/documents.test.ts +7 -4
  544. package/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.ts +26 -25
  545. package/tests/api-resources/simulations/interest-payments.test.ts +15 -0
  546. package/tests/api-resources/simulations/programs.test.ts +15 -0
  547. package/tests/api-resources/simulations/real-time-payments-transfers.test.ts +17 -9
  548. package/tests/api-resources/simulations/wire-transfers.test.ts +8 -7
  549. package/tests/api-resources/transactions.test.ts +8 -25
  550. package/tests/api-resources/wire-drawdown-requests.test.ts +17 -20
  551. package/tests/api-resources/wire-transfers.test.ts +19 -33
  552. package/tests/index.test.ts +30 -1
  553. package/tsconfig.json +2 -0
  554. package/version.ts +1 -1
@@ -56,7 +56,7 @@ export interface Transaction {
56
56
  /**
57
57
  * The type of the route this Transaction came through.
58
58
  */
59
- route_type: string | null;
59
+ route_type: 'account_number' | 'card' | null;
60
60
  /**
61
61
  * This is an object giving more details on the network-level event that caused the
62
62
  * Transaction. Note that for backwards compatibility reasons, additional
@@ -71,22 +71,18 @@ export interface Transaction {
71
71
  type: 'transaction';
72
72
  }
73
73
  export declare namespace Transaction {
74
+ /**
75
+ * This is an object giving more details on the network-level event that caused the
76
+ * Transaction. Note that for backwards compatibility reasons, additional
77
+ * undocumented keys may appear in this object. These should be treated as
78
+ * deprecated and will be removed in the future.
79
+ */
74
80
  interface Source {
75
81
  /**
76
82
  * A Account Transfer Intention object. This field will be present in the JSON
77
83
  * response if and only if `category` is equal to `account_transfer_intention`.
78
84
  */
79
85
  account_transfer_intention: Source.AccountTransferIntention | null;
80
- /**
81
- * A ACH Check Conversion object. This field will be present in the JSON response
82
- * if and only if `category` is equal to `ach_check_conversion`.
83
- */
84
- ach_check_conversion: Source.ACHCheckConversion | null;
85
- /**
86
- * A ACH Check Conversion Return object. This field will be present in the JSON
87
- * response if and only if `category` is equal to `ach_check_conversion_return`.
88
- */
89
- ach_check_conversion_return: Source.ACHCheckConversionReturn | null;
90
86
  /**
91
87
  * A ACH Transfer Intention object. This field will be present in the JSON response
92
88
  * if and only if `category` is equal to `ach_transfer_intention`.
@@ -113,15 +109,10 @@ export declare namespace Transaction {
113
109
  */
114
110
  card_refund: Source.CardRefund | null;
115
111
  /**
116
- * A Deprecated Card Refund object. This field will be present in the JSON response
117
- * if and only if `category` is equal to `card_route_refund`.
112
+ * A Card Revenue Payment object. This field will be present in the JSON response
113
+ * if and only if `category` is equal to `card_revenue_payment`.
118
114
  */
119
- card_route_refund: Source.CardRouteRefund | null;
120
- /**
121
- * A Deprecated Card Settlement object. This field will be present in the JSON
122
- * response if and only if `category` is equal to `card_route_settlement`.
123
- */
124
- card_route_settlement: Source.CardRouteSettlement | null;
115
+ card_revenue_payment: Source.CardRevenuePayment | null;
125
116
  /**
126
117
  * A Card Settlement object. This field will be present in the JSON response if and
127
118
  * only if `category` is equal to `card_settlement`.
@@ -134,22 +125,20 @@ export declare namespace Transaction {
134
125
  */
135
126
  category:
136
127
  | 'account_transfer_intention'
137
- | 'ach_check_conversion_return'
138
- | 'ach_check_conversion'
139
128
  | 'ach_transfer_intention'
140
129
  | 'ach_transfer_rejection'
141
130
  | 'ach_transfer_return'
142
131
  | 'card_dispute_acceptance'
143
132
  | 'card_refund'
144
133
  | 'card_settlement'
134
+ | 'card_revenue_payment'
145
135
  | 'check_deposit_acceptance'
146
136
  | 'check_deposit_return'
147
137
  | 'check_transfer_intention'
148
138
  | 'check_transfer_return'
149
139
  | 'check_transfer_rejection'
150
140
  | 'check_transfer_stop_payment_request'
151
- | 'dispute_resolution'
152
- | 'empyreal_cash_deposit'
141
+ | 'fee_payment'
153
142
  | 'inbound_ach_transfer'
154
143
  | 'inbound_ach_transfer_return_intention'
155
144
  | 'inbound_check'
@@ -160,14 +149,9 @@ export declare namespace Transaction {
160
149
  | 'inbound_wire_reversal'
161
150
  | 'inbound_wire_transfer'
162
151
  | 'interest_payment'
163
- | 'internal_general_ledger_transaction'
164
152
  | 'internal_source'
165
- | 'card_route_refund'
166
- | 'card_route_settlement'
167
153
  | 'real_time_payments_transfer_acknowledgement'
168
154
  | 'sample_funds'
169
- | 'wire_drawdown_payment_intention'
170
- | 'wire_drawdown_payment_rejection'
171
155
  | 'wire_transfer_intention'
172
156
  | 'wire_transfer_rejection'
173
157
  | 'other';
@@ -203,15 +187,10 @@ export declare namespace Transaction {
203
187
  */
204
188
  check_transfer_stop_payment_request: Source.CheckTransferStopPaymentRequest | null;
205
189
  /**
206
- * A Dispute Resolution object. This field will be present in the JSON response if
207
- * and only if `category` is equal to `dispute_resolution`.
190
+ * A Fee Payment object. This field will be present in the JSON response if and
191
+ * only if `category` is equal to `fee_payment`.
208
192
  */
209
- dispute_resolution: Source.DisputeResolution | null;
210
- /**
211
- * A Empyreal Cash Deposit object. This field will be present in the JSON response
212
- * if and only if `category` is equal to `empyreal_cash_deposit`.
213
- */
214
- empyreal_cash_deposit: Source.EmpyrealCashDeposit | null;
193
+ fee_payment: Source.FeePayment | null;
215
194
  /**
216
195
  * A Inbound ACH Transfer object. This field will be present in the JSON response
217
196
  * if and only if `category` is equal to `inbound_ach_transfer`.
@@ -265,23 +244,17 @@ export declare namespace Transaction {
265
244
  * only if `category` is equal to `internal_source`.
266
245
  */
267
246
  internal_source: Source.InternalSource | null;
247
+ /**
248
+ * A Real Time Payments Transfer Acknowledgement object. This field will be present
249
+ * in the JSON response if and only if `category` is equal to
250
+ * `real_time_payments_transfer_acknowledgement`.
251
+ */
252
+ real_time_payments_transfer_acknowledgement: Source.RealTimePaymentsTransferAcknowledgement | null;
268
253
  /**
269
254
  * A Sample Funds object. This field will be present in the JSON response if and
270
255
  * only if `category` is equal to `sample_funds`.
271
256
  */
272
257
  sample_funds: Source.SampleFunds | null;
273
- /**
274
- * A Wire Drawdown Payment Intention object. This field will be present in the JSON
275
- * response if and only if `category` is equal to
276
- * `wire_drawdown_payment_intention`.
277
- */
278
- wire_drawdown_payment_intention: Source.WireDrawdownPaymentIntention | null;
279
- /**
280
- * A Wire Drawdown Payment Rejection object. This field will be present in the JSON
281
- * response if and only if `category` is equal to
282
- * `wire_drawdown_payment_rejection`.
283
- */
284
- wire_drawdown_payment_rejection: Source.WireDrawdownPaymentRejection | null;
285
258
  /**
286
259
  * A Wire Transfer Intention object. This field will be present in the JSON
287
260
  * response if and only if `category` is equal to `wire_transfer_intention`.
@@ -294,6 +267,10 @@ export declare namespace Transaction {
294
267
  wire_transfer_rejection: Source.WireTransferRejection | null;
295
268
  }
296
269
  namespace Source {
270
+ /**
271
+ * A Account Transfer Intention object. This field will be present in the JSON
272
+ * response if and only if `category` is equal to `account_transfer_intention`.
273
+ */
297
274
  interface AccountTransferIntention {
298
275
  /**
299
276
  * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -322,28 +299,10 @@ export declare namespace Transaction {
322
299
  */
323
300
  transfer_id: string;
324
301
  }
325
- interface ACHCheckConversionReturn {
326
- /**
327
- * The amount in the minor unit of the transaction's currency. For dollars, for
328
- * example, this is cents.
329
- */
330
- amount: number;
331
- /**
332
- * Why the transfer was returned.
333
- */
334
- return_reason_code: string;
335
- }
336
- interface ACHCheckConversion {
337
- /**
338
- * The amount in the minor unit of the transaction's currency. For dollars, for
339
- * example, this is cents.
340
- */
341
- amount: number;
342
- /**
343
- * The identifier of the File containing an image of the returned check.
344
- */
345
- file_id: string;
346
- }
302
+ /**
303
+ * A ACH Transfer Intention object. This field will be present in the JSON response
304
+ * if and only if `category` is equal to `ach_transfer_intention`.
305
+ */
347
306
  interface ACHTransferIntention {
348
307
  account_number: string;
349
308
  /**
@@ -358,18 +317,30 @@ export declare namespace Transaction {
358
317
  */
359
318
  transfer_id: string;
360
319
  }
320
+ /**
321
+ * A ACH Transfer Rejection object. This field will be present in the JSON response
322
+ * if and only if `category` is equal to `ach_transfer_rejection`.
323
+ */
361
324
  interface ACHTransferRejection {
362
325
  /**
363
326
  * The identifier of the ACH Transfer that led to this Transaction.
364
327
  */
365
328
  transfer_id: string;
366
329
  }
330
+ /**
331
+ * A ACH Transfer Return object. This field will be present in the JSON response if
332
+ * and only if `category` is equal to `ach_transfer_return`.
333
+ */
367
334
  interface ACHTransferReturn {
368
335
  /**
369
336
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
370
337
  * the transfer was created.
371
338
  */
372
339
  created_at: string;
340
+ /**
341
+ * The three character ACH return code, in the range R01 to R85.
342
+ */
343
+ raw_return_reason_code: string;
373
344
  /**
374
345
  * Why the ACH Transfer was returned.
375
346
  */
@@ -393,10 +364,58 @@ export declare namespace Transaction {
393
364
  | 'file_record_edit_criteria'
394
365
  | 'enr_invalid_individual_name'
395
366
  | 'returned_per_odfi_request'
396
- | 'addenda_error'
397
367
  | 'limited_participation_dfi'
398
368
  | 'incorrectly_coded_outbound_international_payment'
399
- | 'other';
369
+ | 'other'
370
+ | 'account_sold_to_another_dfi'
371
+ | 'addenda_error'
372
+ | 'beneficiary_or_account_holder_deceased'
373
+ | 'customer_advised_not_within_authorization_terms'
374
+ | 'corrected_return'
375
+ | 'duplicate_entry'
376
+ | 'duplicate_return'
377
+ | 'enr_duplicate_enrollment'
378
+ | 'enr_invalid_dfi_account_number'
379
+ | 'enr_invalid_individual_id_number'
380
+ | 'enr_invalid_representative_payee_indicator'
381
+ | 'enr_invalid_transaction_code'
382
+ | 'enr_return_of_enr_entry'
383
+ | 'enr_routing_number_check_digit_error'
384
+ | 'entry_not_processed_by_gateway'
385
+ | 'field_error'
386
+ | 'foreign_receiving_dfi_unable_to_settle'
387
+ | 'iat_entry_coding_error'
388
+ | 'improper_effective_entry_date'
389
+ | 'improper_source_document_source_document_presented'
390
+ | 'invalid_company_id'
391
+ | 'invalid_foreign_receiving_dfi_identification'
392
+ | 'invalid_individual_id_number'
393
+ | 'item_and_rck_entry_presented_for_payment'
394
+ | 'item_related_to_rck_entry_is_ineligible'
395
+ | 'mandatory_field_error'
396
+ | 'misrouted_dishonored_return'
397
+ | 'misrouted_return'
398
+ | 'no_errors_found'
399
+ | 'non_acceptance_of_r62_dishonored_return'
400
+ | 'non_participant_in_iat_program'
401
+ | 'permissible_return_entry'
402
+ | 'permissible_return_entry_not_accepted'
403
+ | 'rdfi_non_settlement'
404
+ | 'rdfi_participant_in_check_truncation_program'
405
+ | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
406
+ | 'return_not_a_duplicate'
407
+ | 'return_of_erroneous_or_reversing_debit'
408
+ | 'return_of_improper_credit_entry'
409
+ | 'return_of_improper_debit_entry'
410
+ | 'return_of_xck_entry'
411
+ | 'source_document_presented_for_payment'
412
+ | 'state_law_affecting_rck_acceptance'
413
+ | 'stop_payment_on_item_related_to_rck_entry'
414
+ | 'stop_payment_on_source_document'
415
+ | 'timely_original_return'
416
+ | 'trace_number_error'
417
+ | 'untimely_dishonored_return'
418
+ | 'untimely_return';
400
419
  /**
401
420
  * The identifier of the Tranasaction associated with this return.
402
421
  */
@@ -406,6 +425,10 @@ export declare namespace Transaction {
406
425
  */
407
426
  transfer_id: string;
408
427
  }
428
+ /**
429
+ * A Card Dispute Acceptance object. This field will be present in the JSON
430
+ * response if and only if `category` is equal to `card_dispute_acceptance`.
431
+ */
409
432
  interface CardDisputeAcceptance {
410
433
  /**
411
434
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -420,44 +443,106 @@ export declare namespace Transaction {
420
443
  * The identifier of the Transaction that was created to return the disputed funds
421
444
  * to your account.
422
445
  */
423
- transaction_id: string | null;
446
+ transaction_id: string;
424
447
  }
448
+ /**
449
+ * A Card Refund object. This field will be present in the JSON response if and
450
+ * only if `category` is equal to `card_refund`.
451
+ */
425
452
  interface CardRefund {
426
453
  /**
427
454
  * The pending amount in the minor unit of the transaction's currency. For dollars,
428
455
  * for example, this is cents.
429
456
  */
430
457
  amount: number;
431
- /**
432
- * The identifier for the Transaction this refunds, if any.
433
- */
434
- card_settlement_transaction_id: string | null;
435
458
  /**
436
459
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
437
460
  * transaction's currency.
438
461
  */
439
462
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
463
+ /**
464
+ * The Card Refund identifier.
465
+ */
466
+ id: string;
467
+ /**
468
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
469
+ * is transacting with.
470
+ */
471
+ merchant_acceptor_id: string | null;
472
+ /**
473
+ * The 4-digit MCC describing the merchant's business.
474
+ */
475
+ merchant_category_code: string;
476
+ /**
477
+ * The city the merchant resides in.
478
+ */
479
+ merchant_city: string | null;
480
+ /**
481
+ * The country the merchant resides in.
482
+ */
483
+ merchant_country: string;
484
+ /**
485
+ * The name of the merchant.
486
+ */
487
+ merchant_name: string | null;
488
+ /**
489
+ * The state the merchant resides in.
490
+ */
491
+ merchant_state: string | null;
440
492
  /**
441
493
  * A constant representing the object's type. For this resource it will always be
442
494
  * `card_refund`.
443
495
  */
444
496
  type: 'card_refund';
445
497
  }
498
+ /**
499
+ * A Card Settlement object. This field will be present in the JSON response if and
500
+ * only if `category` is equal to `card_settlement`.
501
+ */
446
502
  interface CardSettlement {
447
503
  /**
448
504
  * The amount in the minor unit of the transaction's settlement currency. For
449
505
  * dollars, for example, this is cents.
450
506
  */
451
507
  amount: number;
508
+ /**
509
+ * The Card Authorization that was created prior to this Card Settlement, if on
510
+ * exists.
511
+ */
512
+ card_authorization: string | null;
452
513
  /**
453
514
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
454
515
  * transaction's settlement currency.
455
516
  */
456
517
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
518
+ /**
519
+ * The Card Settlement identifier.
520
+ */
521
+ id: string;
522
+ /**
523
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
524
+ * is transacting with.
525
+ */
526
+ merchant_acceptor_id: string | null;
527
+ /**
528
+ * The 4-digit MCC describing the merchant's business.
529
+ */
457
530
  merchant_category_code: string;
531
+ /**
532
+ * The city the merchant resides in.
533
+ */
458
534
  merchant_city: string | null;
535
+ /**
536
+ * The country the merchant resides in.
537
+ */
459
538
  merchant_country: string;
539
+ /**
540
+ * The name of the merchant.
541
+ */
460
542
  merchant_name: string | null;
543
+ /**
544
+ * The state the merchant resides in.
545
+ */
461
546
  merchant_state: string | null;
462
547
  /**
463
548
  * The identifier of the Pending Transaction associated with this Transaction.
@@ -478,6 +563,38 @@ export declare namespace Transaction {
478
563
  */
479
564
  type: 'card_settlement';
480
565
  }
566
+ /**
567
+ * A Card Revenue Payment object. This field will be present in the JSON response
568
+ * if and only if `category` is equal to `card_revenue_payment`.
569
+ */
570
+ interface CardRevenuePayment {
571
+ /**
572
+ * The amount in the minor unit of the transaction's currency. For dollars, for
573
+ * example, this is cents.
574
+ */
575
+ amount: number;
576
+ /**
577
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
578
+ * currency.
579
+ */
580
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
581
+ /**
582
+ * The end of the period for which this transaction paid interest.
583
+ */
584
+ period_end: string;
585
+ /**
586
+ * The start of the period for which this transaction paid interest.
587
+ */
588
+ period_start: string;
589
+ /**
590
+ * The account the card belonged to.
591
+ */
592
+ transacted_on_account_id: string | null;
593
+ }
594
+ /**
595
+ * A Check Deposit Acceptance object. This field will be present in the JSON
596
+ * response if and only if `category` is equal to `check_deposit_acceptance`.
597
+ */
481
598
  interface CheckDepositAcceptance {
482
599
  /**
483
600
  * The account number printed on the check.
@@ -512,6 +629,10 @@ export declare namespace Transaction {
512
629
  */
513
630
  serial_number: string | null;
514
631
  }
632
+ /**
633
+ * A Check Deposit Return object. This field will be present in the JSON response
634
+ * if and only if `category` is equal to `check_deposit_return`.
635
+ */
515
636
  interface CheckDepositReturn {
516
637
  /**
517
638
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -538,7 +659,8 @@ export declare namespace Transaction {
538
659
  | 'stop_payment'
539
660
  | 'unknown_reason'
540
661
  | 'unmatched_details'
541
- | 'unreadable_image';
662
+ | 'unreadable_image'
663
+ | 'endorsement_irregular';
542
664
  /**
543
665
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
544
666
  * the check deposit was returned.
@@ -550,6 +672,10 @@ export declare namespace Transaction {
550
672
  */
551
673
  transaction_id: string;
552
674
  }
675
+ /**
676
+ * A Check Transfer Intention object. This field will be present in the JSON
677
+ * response if and only if `category` is equal to `check_transfer_intention`.
678
+ */
553
679
  interface CheckTransferIntention {
554
680
  /**
555
681
  * The city of the check's destination.
@@ -589,22 +715,49 @@ export declare namespace Transaction {
589
715
  */
590
716
  transfer_id: string;
591
717
  }
718
+ /**
719
+ * A Check Transfer Return object. This field will be present in the JSON response
720
+ * if and only if `category` is equal to `check_transfer_return`.
721
+ */
592
722
  interface CheckTransferReturn {
593
723
  /**
594
724
  * If available, a document with additional information about the return.
595
725
  */
596
726
  file_id: string | null;
727
+ /**
728
+ * The reason why the check was returned.
729
+ */
730
+ reason: 'mail_delivery_failure' | 'refused_by_recipient' | 'returned_not_authorized';
731
+ /**
732
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
733
+ * the check was returned.
734
+ */
735
+ returned_at: string;
736
+ /**
737
+ * The identifier of the Transaction that was created to credit you for the
738
+ * returned check.
739
+ */
740
+ transaction_id: string | null;
597
741
  /**
598
742
  * The identifier of the returned Check Transfer.
599
743
  */
600
744
  transfer_id: string;
601
745
  }
746
+ /**
747
+ * A Check Transfer Rejection object. This field will be present in the JSON
748
+ * response if and only if `category` is equal to `check_transfer_rejection`.
749
+ */
602
750
  interface CheckTransferRejection {
603
751
  /**
604
752
  * The identifier of the Check Transfer that led to this Transaction.
605
753
  */
606
754
  transfer_id: string;
607
755
  }
756
+ /**
757
+ * A Check Transfer Stop Payment Request object. This field will be present in the
758
+ * JSON response if and only if `category` is equal to
759
+ * `check_transfer_stop_payment_request`.
760
+ */
608
761
  interface CheckTransferStopPaymentRequest {
609
762
  /**
610
763
  * The time the stop-payment was requested.
@@ -624,31 +777,26 @@ export declare namespace Transaction {
624
777
  */
625
778
  type: 'check_transfer_stop_payment_request';
626
779
  }
627
- interface DisputeResolution {
780
+ /**
781
+ * A Fee Payment object. This field will be present in the JSON response if and
782
+ * only if `category` is equal to `fee_payment`.
783
+ */
784
+ interface FeePayment {
628
785
  /**
629
786
  * The amount in the minor unit of the transaction's currency. For dollars, for
630
787
  * example, this is cents.
631
788
  */
632
789
  amount: number;
633
790
  /**
634
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
635
- * transaction's currency.
791
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
792
+ * currency.
636
793
  */
637
794
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
638
- /**
639
- * The identifier of the Transaction that was disputed.
640
- */
641
- disputed_transaction_id: string;
642
- }
643
- interface EmpyrealCashDeposit {
644
- /**
645
- * The amount in the minor unit of the transaction's currency. For dollars, for
646
- * example, this is cents.
647
- */
648
- amount: number;
649
- bag_id: string;
650
- deposit_date: string;
651
795
  }
796
+ /**
797
+ * A Inbound ACH Transfer object. This field will be present in the JSON response
798
+ * if and only if `category` is equal to `inbound_ach_transfer`.
799
+ */
652
800
  interface InboundACHTransfer {
653
801
  /**
654
802
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -664,6 +812,10 @@ export declare namespace Transaction {
664
812
  receiver_name: string | null;
665
813
  trace_number: string;
666
814
  }
815
+ /**
816
+ * A Inbound Check object. This field will be present in the JSON response if and
817
+ * only if `category` is equal to `inbound_check`.
818
+ */
667
819
  interface InboundCheck {
668
820
  /**
669
821
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -679,6 +831,11 @@ export declare namespace Transaction {
679
831
  */
680
832
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
681
833
  }
834
+ /**
835
+ * A Inbound International ACH Transfer object. This field will be present in the
836
+ * JSON response if and only if `category` is equal to
837
+ * `inbound_international_ach_transfer`.
838
+ */
682
839
  interface InboundInternationalACHTransfer {
683
840
  /**
684
841
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -721,6 +878,11 @@ export declare namespace Transaction {
721
878
  receiving_depository_financial_institution_name: string;
722
879
  trace_number: string;
723
880
  }
881
+ /**
882
+ * A Inbound Real Time Payments Transfer Confirmation object. This field will be
883
+ * present in the JSON response if and only if `category` is equal to
884
+ * `inbound_real_time_payments_transfer_confirmation`.
885
+ */
724
886
  interface InboundRealTimePaymentsTransferConfirmation {
725
887
  /**
726
888
  * The amount in the minor unit of the transfer's currency. For dollars, for
@@ -757,6 +919,11 @@ export declare namespace Transaction {
757
919
  */
758
920
  transaction_identification: string;
759
921
  }
922
+ /**
923
+ * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
924
+ * the JSON response if and only if `category` is equal to
925
+ * `inbound_wire_drawdown_payment_reversal`.
926
+ */
760
927
  interface InboundWireDrawdownPaymentReversal {
761
928
  /**
762
929
  * The amount that was reversed.
@@ -799,6 +966,10 @@ export declare namespace Transaction {
799
966
  */
800
967
  previous_message_input_source: string;
801
968
  }
969
+ /**
970
+ * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
971
+ * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
972
+ */
802
973
  interface InboundWireDrawdownPayment {
803
974
  /**
804
975
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -818,11 +989,20 @@ export declare namespace Transaction {
818
989
  originator_name: string | null;
819
990
  originator_to_beneficiary_information: string | null;
820
991
  }
992
+ /**
993
+ * A Inbound Wire Reversal object. This field will be present in the JSON response
994
+ * if and only if `category` is equal to `inbound_wire_reversal`.
995
+ */
821
996
  interface InboundWireReversal {
822
997
  /**
823
998
  * The amount that was reversed.
824
999
  */
825
1000
  amount: number;
1001
+ /**
1002
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1003
+ * the reversal was created.
1004
+ */
1005
+ created_at: string;
826
1006
  /**
827
1007
  * The description on the reversal message from Fedwire.
828
1008
  */
@@ -868,7 +1048,19 @@ export declare namespace Transaction {
868
1048
  * institution.
869
1049
  */
870
1050
  receiver_financial_institution_information: string | null;
1051
+ /**
1052
+ * The ID for the Transaction associated with the transfer reversal.
1053
+ */
1054
+ transaction_id: string | null;
1055
+ /**
1056
+ * The ID for the Wire Transfer that is being reversed.
1057
+ */
1058
+ wire_transfer_id: string;
871
1059
  }
1060
+ /**
1061
+ * A Inbound Wire Transfer object. This field will be present in the JSON response
1062
+ * if and only if `category` is equal to `inbound_wire_transfer`.
1063
+ */
872
1064
  interface InboundWireTransfer {
873
1065
  /**
874
1066
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -892,6 +1084,10 @@ export declare namespace Transaction {
892
1084
  originator_to_beneficiary_information_line3: string | null;
893
1085
  originator_to_beneficiary_information_line4: string | null;
894
1086
  }
1087
+ /**
1088
+ * A Interest Payment object. This field will be present in the JSON response if
1089
+ * and only if `category` is equal to `interest_payment`.
1090
+ */
895
1091
  interface InterestPayment {
896
1092
  /**
897
1093
  * The account on which the interest was accrued.
@@ -916,6 +1112,10 @@ export declare namespace Transaction {
916
1112
  */
917
1113
  period_start: string;
918
1114
  }
1115
+ /**
1116
+ * A Internal Source object. This field will be present in the JSON response if and
1117
+ * only if `category` is equal to `internal_source`.
1118
+ */
919
1119
  interface InternalSource {
920
1120
  /**
921
1121
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -928,71 +1128,60 @@ export declare namespace Transaction {
928
1128
  */
929
1129
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
930
1130
  reason:
1131
+ | 'account_closure'
931
1132
  | 'bank_migration'
932
1133
  | 'cashback'
1134
+ | 'collection_receivable'
933
1135
  | 'empyreal_adjustment'
934
1136
  | 'error'
935
1137
  | 'error_correction'
936
1138
  | 'fees'
937
1139
  | 'interest'
1140
+ | 'negative_balance_forgiveness'
938
1141
  | 'sample_funds'
939
1142
  | 'sample_funds_return';
940
1143
  }
941
- interface CardRouteRefund {
1144
+ /**
1145
+ * A Real Time Payments Transfer Acknowledgement object. This field will be present
1146
+ * in the JSON response if and only if `category` is equal to
1147
+ * `real_time_payments_transfer_acknowledgement`.
1148
+ */
1149
+ interface RealTimePaymentsTransferAcknowledgement {
942
1150
  /**
943
- * The refunded amount in the minor unit of the refunded currency. For dollars, for
944
- * example, this is cents.
1151
+ * The transfer amount in USD cents.
945
1152
  */
946
1153
  amount: number;
947
1154
  /**
948
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the refund
949
- * currency.
1155
+ * The destination account number.
950
1156
  */
951
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
952
- merchant_acceptor_id: string;
953
- merchant_category_code: string | null;
954
- merchant_city: string | null;
955
- merchant_country: string;
956
- merchant_descriptor: string;
957
- merchant_state: string | null;
958
- }
959
- interface CardRouteSettlement {
1157
+ destination_account_number: string;
960
1158
  /**
961
- * The settled amount in the minor unit of the settlement currency. For dollars,
962
- * for example, this is cents.
1159
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN).
963
1160
  */
964
- amount: number;
1161
+ destination_routing_number: string;
965
1162
  /**
966
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the settlement
967
- * currency.
1163
+ * Unstructured information that will show on the recipient's bank statement.
968
1164
  */
969
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
970
- merchant_acceptor_id: string;
971
- merchant_category_code: string | null;
972
- merchant_city: string | null;
973
- merchant_country: string | null;
974
- merchant_descriptor: string;
975
- merchant_state: string | null;
1165
+ remittance_information: string;
1166
+ /**
1167
+ * The identifier of the Real Time Payments Transfer that led to this Transaction.
1168
+ */
1169
+ transfer_id: string;
976
1170
  }
1171
+ /**
1172
+ * A Sample Funds object. This field will be present in the JSON response if and
1173
+ * only if `category` is equal to `sample_funds`.
1174
+ */
977
1175
  interface SampleFunds {
978
1176
  /**
979
1177
  * Where the sample funds came from.
980
1178
  */
981
1179
  originator: string;
982
1180
  }
983
- interface WireDrawdownPaymentIntention {
984
- account_number: string;
985
- /**
986
- * The transfer amount in USD cents.
987
- */
988
- amount: number;
989
- message_to_recipient: string;
990
- routing_number: string;
991
- transfer_id: string;
992
- }
993
- interface WireDrawdownPaymentRejection {
994
- transfer_id: string;
995
- }
1181
+ /**
1182
+ * A Wire Transfer Intention object. This field will be present in the JSON
1183
+ * response if and only if `category` is equal to `wire_transfer_intention`.
1184
+ */
996
1185
  interface WireTransferIntention {
997
1186
  /**
998
1187
  * The destination account number.
@@ -1012,6 +1201,10 @@ export declare namespace Transaction {
1012
1201
  routing_number: string;
1013
1202
  transfer_id: string;
1014
1203
  }
1204
+ /**
1205
+ * A Wire Transfer Rejection object. This field will be present in the JSON
1206
+ * response if and only if `category` is equal to `wire_transfer_rejection`.
1207
+ */
1015
1208
  interface WireTransferRejection {
1016
1209
  transfer_id: string;
1017
1210
  }
@@ -1025,33 +1218,12 @@ export interface TransactionListParams extends PageParams {
1025
1218
  category?: TransactionListParams.Category;
1026
1219
  created_at?: TransactionListParams.CreatedAt;
1027
1220
  /**
1028
- * Filter Transactions for those belonging to the specified route.
1221
+ * Filter Transactions for those belonging to the specified route. This could be a
1222
+ * Card ID or an Account Number ID.
1029
1223
  */
1030
1224
  route_id?: string;
1031
1225
  }
1032
1226
  export declare namespace TransactionListParams {
1033
- interface CreatedAt {
1034
- /**
1035
- * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
1036
- * timestamp.
1037
- */
1038
- after?: string;
1039
- /**
1040
- * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
1041
- * timestamp.
1042
- */
1043
- before?: string;
1044
- /**
1045
- * Return results on or after this
1046
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
1047
- */
1048
- on_or_after?: string;
1049
- /**
1050
- * Return results on or before this
1051
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
1052
- */
1053
- on_or_before?: string;
1054
- }
1055
1227
  interface Category {
1056
1228
  /**
1057
1229
  * Return results whose value is in the provided list. For GET requests, this
@@ -1059,22 +1231,20 @@ export declare namespace TransactionListParams {
1059
1231
  */
1060
1232
  in?: Array<
1061
1233
  | 'account_transfer_intention'
1062
- | 'ach_check_conversion_return'
1063
- | 'ach_check_conversion'
1064
1234
  | 'ach_transfer_intention'
1065
1235
  | 'ach_transfer_rejection'
1066
1236
  | 'ach_transfer_return'
1067
1237
  | 'card_dispute_acceptance'
1068
1238
  | 'card_refund'
1069
1239
  | 'card_settlement'
1240
+ | 'card_revenue_payment'
1070
1241
  | 'check_deposit_acceptance'
1071
1242
  | 'check_deposit_return'
1072
1243
  | 'check_transfer_intention'
1073
1244
  | 'check_transfer_return'
1074
1245
  | 'check_transfer_rejection'
1075
1246
  | 'check_transfer_stop_payment_request'
1076
- | 'dispute_resolution'
1077
- | 'empyreal_cash_deposit'
1247
+ | 'fee_payment'
1078
1248
  | 'inbound_ach_transfer'
1079
1249
  | 'inbound_ach_transfer_return_intention'
1080
1250
  | 'inbound_check'
@@ -1085,17 +1255,35 @@ export declare namespace TransactionListParams {
1085
1255
  | 'inbound_wire_reversal'
1086
1256
  | 'inbound_wire_transfer'
1087
1257
  | 'interest_payment'
1088
- | 'internal_general_ledger_transaction'
1089
1258
  | 'internal_source'
1090
- | 'card_route_refund'
1091
- | 'card_route_settlement'
1092
1259
  | 'real_time_payments_transfer_acknowledgement'
1093
1260
  | 'sample_funds'
1094
- | 'wire_drawdown_payment_intention'
1095
- | 'wire_drawdown_payment_rejection'
1096
1261
  | 'wire_transfer_intention'
1097
1262
  | 'wire_transfer_rejection'
1098
1263
  | 'other'
1099
1264
  >;
1100
1265
  }
1266
+ interface CreatedAt {
1267
+ /**
1268
+ * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
1269
+ * timestamp.
1270
+ */
1271
+ after?: string;
1272
+ /**
1273
+ * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
1274
+ * timestamp.
1275
+ */
1276
+ before?: string;
1277
+ /**
1278
+ * Return results on or after this
1279
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
1280
+ */
1281
+ on_or_after?: string;
1282
+ /**
1283
+ * Return results on or before this
1284
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
1285
+ */
1286
+ on_or_before?: string;
1287
+ }
1101
1288
  }
1289
+ //# sourceMappingURL=transactions.d.ts.map