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
@@ -25,7 +25,6 @@ export class Transactions extends APIResource {
25
25
  if (isRequestOptions(query)) {
26
26
  return this.list({}, query);
27
27
  }
28
-
29
28
  return this.getAPIList('/transactions', TransactionsPage, { query, ...options });
30
29
  }
31
30
  }
@@ -82,7 +81,7 @@ export interface Transaction {
82
81
  /**
83
82
  * The type of the route this Transaction came through.
84
83
  */
85
- route_type: string | null;
84
+ route_type: 'account_number' | 'card' | null;
86
85
 
87
86
  /**
88
87
  * This is an object giving more details on the network-level event that caused the
@@ -100,6 +99,12 @@ export interface Transaction {
100
99
  }
101
100
 
102
101
  export namespace Transaction {
102
+ /**
103
+ * This is an object giving more details on the network-level event that caused the
104
+ * Transaction. Note that for backwards compatibility reasons, additional
105
+ * undocumented keys may appear in this object. These should be treated as
106
+ * deprecated and will be removed in the future.
107
+ */
103
108
  export interface Source {
104
109
  /**
105
110
  * A Account Transfer Intention object. This field will be present in the JSON
@@ -107,18 +112,6 @@ export namespace Transaction {
107
112
  */
108
113
  account_transfer_intention: Source.AccountTransferIntention | null;
109
114
 
110
- /**
111
- * A ACH Check Conversion object. This field will be present in the JSON response
112
- * if and only if `category` is equal to `ach_check_conversion`.
113
- */
114
- ach_check_conversion: Source.ACHCheckConversion | null;
115
-
116
- /**
117
- * A ACH Check Conversion Return object. This field will be present in the JSON
118
- * response if and only if `category` is equal to `ach_check_conversion_return`.
119
- */
120
- ach_check_conversion_return: Source.ACHCheckConversionReturn | null;
121
-
122
115
  /**
123
116
  * A ACH Transfer Intention object. This field will be present in the JSON response
124
117
  * if and only if `category` is equal to `ach_transfer_intention`.
@@ -150,16 +143,10 @@ export namespace Transaction {
150
143
  card_refund: Source.CardRefund | null;
151
144
 
152
145
  /**
153
- * A Deprecated Card Refund object. This field will be present in the JSON response
154
- * if and only if `category` is equal to `card_route_refund`.
155
- */
156
- card_route_refund: Source.CardRouteRefund | null;
157
-
158
- /**
159
- * A Deprecated Card Settlement object. This field will be present in the JSON
160
- * response if and only if `category` is equal to `card_route_settlement`.
146
+ * A Card Revenue Payment object. This field will be present in the JSON response
147
+ * if and only if `category` is equal to `card_revenue_payment`.
161
148
  */
162
- card_route_settlement: Source.CardRouteSettlement | null;
149
+ card_revenue_payment: Source.CardRevenuePayment | null;
163
150
 
164
151
  /**
165
152
  * A Card Settlement object. This field will be present in the JSON response if and
@@ -174,22 +161,20 @@ export namespace Transaction {
174
161
  */
175
162
  category:
176
163
  | 'account_transfer_intention'
177
- | 'ach_check_conversion_return'
178
- | 'ach_check_conversion'
179
164
  | 'ach_transfer_intention'
180
165
  | 'ach_transfer_rejection'
181
166
  | 'ach_transfer_return'
182
167
  | 'card_dispute_acceptance'
183
168
  | 'card_refund'
184
169
  | 'card_settlement'
170
+ | 'card_revenue_payment'
185
171
  | 'check_deposit_acceptance'
186
172
  | 'check_deposit_return'
187
173
  | 'check_transfer_intention'
188
174
  | 'check_transfer_return'
189
175
  | 'check_transfer_rejection'
190
176
  | 'check_transfer_stop_payment_request'
191
- | 'dispute_resolution'
192
- | 'empyreal_cash_deposit'
177
+ | 'fee_payment'
193
178
  | 'inbound_ach_transfer'
194
179
  | 'inbound_ach_transfer_return_intention'
195
180
  | 'inbound_check'
@@ -200,14 +185,9 @@ export namespace Transaction {
200
185
  | 'inbound_wire_reversal'
201
186
  | 'inbound_wire_transfer'
202
187
  | 'interest_payment'
203
- | 'internal_general_ledger_transaction'
204
188
  | 'internal_source'
205
- | 'card_route_refund'
206
- | 'card_route_settlement'
207
189
  | 'real_time_payments_transfer_acknowledgement'
208
190
  | 'sample_funds'
209
- | 'wire_drawdown_payment_intention'
210
- | 'wire_drawdown_payment_rejection'
211
191
  | 'wire_transfer_intention'
212
192
  | 'wire_transfer_rejection'
213
193
  | 'other';
@@ -250,16 +230,10 @@ export namespace Transaction {
250
230
  check_transfer_stop_payment_request: Source.CheckTransferStopPaymentRequest | null;
251
231
 
252
232
  /**
253
- * A Dispute Resolution object. This field will be present in the JSON response if
254
- * and only if `category` is equal to `dispute_resolution`.
255
- */
256
- dispute_resolution: Source.DisputeResolution | null;
257
-
258
- /**
259
- * A Empyreal Cash Deposit object. This field will be present in the JSON response
260
- * if and only if `category` is equal to `empyreal_cash_deposit`.
233
+ * A Fee Payment object. This field will be present in the JSON response if and
234
+ * only if `category` is equal to `fee_payment`.
261
235
  */
262
- empyreal_cash_deposit: Source.EmpyrealCashDeposit | null;
236
+ fee_payment: Source.FeePayment | null;
263
237
 
264
238
  /**
265
239
  * A Inbound ACH Transfer object. This field will be present in the JSON response
@@ -325,24 +299,17 @@ export namespace Transaction {
325
299
  internal_source: Source.InternalSource | null;
326
300
 
327
301
  /**
328
- * A Sample Funds object. This field will be present in the JSON response if and
329
- * only if `category` is equal to `sample_funds`.
330
- */
331
- sample_funds: Source.SampleFunds | null;
332
-
333
- /**
334
- * A Wire Drawdown Payment Intention object. This field will be present in the JSON
335
- * response if and only if `category` is equal to
336
- * `wire_drawdown_payment_intention`.
302
+ * A Real Time Payments Transfer Acknowledgement object. This field will be present
303
+ * in the JSON response if and only if `category` is equal to
304
+ * `real_time_payments_transfer_acknowledgement`.
337
305
  */
338
- wire_drawdown_payment_intention: Source.WireDrawdownPaymentIntention | null;
306
+ real_time_payments_transfer_acknowledgement: Source.RealTimePaymentsTransferAcknowledgement | null;
339
307
 
340
308
  /**
341
- * A Wire Drawdown Payment Rejection object. This field will be present in the JSON
342
- * response if and only if `category` is equal to
343
- * `wire_drawdown_payment_rejection`.
309
+ * A Sample Funds object. This field will be present in the JSON response if and
310
+ * only if `category` is equal to `sample_funds`.
344
311
  */
345
- wire_drawdown_payment_rejection: Source.WireDrawdownPaymentRejection | null;
312
+ sample_funds: Source.SampleFunds | null;
346
313
 
347
314
  /**
348
315
  * A Wire Transfer Intention object. This field will be present in the JSON
@@ -358,6 +325,10 @@ export namespace Transaction {
358
325
  }
359
326
 
360
327
  export namespace Source {
328
+ /**
329
+ * A Account Transfer Intention object. This field will be present in the JSON
330
+ * response if and only if `category` is equal to `account_transfer_intention`.
331
+ */
361
332
  export interface AccountTransferIntention {
362
333
  /**
363
334
  * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -392,32 +363,10 @@ export namespace Transaction {
392
363
  transfer_id: string;
393
364
  }
394
365
 
395
- export interface ACHCheckConversionReturn {
396
- /**
397
- * The amount in the minor unit of the transaction's currency. For dollars, for
398
- * example, this is cents.
399
- */
400
- amount: number;
401
-
402
- /**
403
- * Why the transfer was returned.
404
- */
405
- return_reason_code: string;
406
- }
407
-
408
- export interface ACHCheckConversion {
409
- /**
410
- * The amount in the minor unit of the transaction's currency. For dollars, for
411
- * example, this is cents.
412
- */
413
- amount: number;
414
-
415
- /**
416
- * The identifier of the File containing an image of the returned check.
417
- */
418
- file_id: string;
419
- }
420
-
366
+ /**
367
+ * A ACH Transfer Intention object. This field will be present in the JSON response
368
+ * if and only if `category` is equal to `ach_transfer_intention`.
369
+ */
421
370
  export interface ACHTransferIntention {
422
371
  account_number: string;
423
372
 
@@ -437,6 +386,10 @@ export namespace Transaction {
437
386
  transfer_id: string;
438
387
  }
439
388
 
389
+ /**
390
+ * A ACH Transfer Rejection object. This field will be present in the JSON response
391
+ * if and only if `category` is equal to `ach_transfer_rejection`.
392
+ */
440
393
  export interface ACHTransferRejection {
441
394
  /**
442
395
  * The identifier of the ACH Transfer that led to this Transaction.
@@ -444,6 +397,10 @@ export namespace Transaction {
444
397
  transfer_id: string;
445
398
  }
446
399
 
400
+ /**
401
+ * A ACH Transfer Return object. This field will be present in the JSON response if
402
+ * and only if `category` is equal to `ach_transfer_return`.
403
+ */
447
404
  export interface ACHTransferReturn {
448
405
  /**
449
406
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -451,6 +408,11 @@ export namespace Transaction {
451
408
  */
452
409
  created_at: string;
453
410
 
411
+ /**
412
+ * The three character ACH return code, in the range R01 to R85.
413
+ */
414
+ raw_return_reason_code: string;
415
+
454
416
  /**
455
417
  * Why the ACH Transfer was returned.
456
418
  */
@@ -474,10 +436,58 @@ export namespace Transaction {
474
436
  | 'file_record_edit_criteria'
475
437
  | 'enr_invalid_individual_name'
476
438
  | 'returned_per_odfi_request'
477
- | 'addenda_error'
478
439
  | 'limited_participation_dfi'
479
440
  | 'incorrectly_coded_outbound_international_payment'
480
- | 'other';
441
+ | 'other'
442
+ | 'account_sold_to_another_dfi'
443
+ | 'addenda_error'
444
+ | 'beneficiary_or_account_holder_deceased'
445
+ | 'customer_advised_not_within_authorization_terms'
446
+ | 'corrected_return'
447
+ | 'duplicate_entry'
448
+ | 'duplicate_return'
449
+ | 'enr_duplicate_enrollment'
450
+ | 'enr_invalid_dfi_account_number'
451
+ | 'enr_invalid_individual_id_number'
452
+ | 'enr_invalid_representative_payee_indicator'
453
+ | 'enr_invalid_transaction_code'
454
+ | 'enr_return_of_enr_entry'
455
+ | 'enr_routing_number_check_digit_error'
456
+ | 'entry_not_processed_by_gateway'
457
+ | 'field_error'
458
+ | 'foreign_receiving_dfi_unable_to_settle'
459
+ | 'iat_entry_coding_error'
460
+ | 'improper_effective_entry_date'
461
+ | 'improper_source_document_source_document_presented'
462
+ | 'invalid_company_id'
463
+ | 'invalid_foreign_receiving_dfi_identification'
464
+ | 'invalid_individual_id_number'
465
+ | 'item_and_rck_entry_presented_for_payment'
466
+ | 'item_related_to_rck_entry_is_ineligible'
467
+ | 'mandatory_field_error'
468
+ | 'misrouted_dishonored_return'
469
+ | 'misrouted_return'
470
+ | 'no_errors_found'
471
+ | 'non_acceptance_of_r62_dishonored_return'
472
+ | 'non_participant_in_iat_program'
473
+ | 'permissible_return_entry'
474
+ | 'permissible_return_entry_not_accepted'
475
+ | 'rdfi_non_settlement'
476
+ | 'rdfi_participant_in_check_truncation_program'
477
+ | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
478
+ | 'return_not_a_duplicate'
479
+ | 'return_of_erroneous_or_reversing_debit'
480
+ | 'return_of_improper_credit_entry'
481
+ | 'return_of_improper_debit_entry'
482
+ | 'return_of_xck_entry'
483
+ | 'source_document_presented_for_payment'
484
+ | 'state_law_affecting_rck_acceptance'
485
+ | 'stop_payment_on_item_related_to_rck_entry'
486
+ | 'stop_payment_on_source_document'
487
+ | 'timely_original_return'
488
+ | 'trace_number_error'
489
+ | 'untimely_dishonored_return'
490
+ | 'untimely_return';
481
491
 
482
492
  /**
483
493
  * The identifier of the Tranasaction associated with this return.
@@ -490,6 +500,10 @@ export namespace Transaction {
490
500
  transfer_id: string;
491
501
  }
492
502
 
503
+ /**
504
+ * A Card Dispute Acceptance object. This field will be present in the JSON
505
+ * response if and only if `category` is equal to `card_dispute_acceptance`.
506
+ */
493
507
  export interface CardDisputeAcceptance {
494
508
  /**
495
509
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -506,9 +520,13 @@ export namespace Transaction {
506
520
  * The identifier of the Transaction that was created to return the disputed funds
507
521
  * to your account.
508
522
  */
509
- transaction_id: string | null;
523
+ transaction_id: string;
510
524
  }
511
525
 
526
+ /**
527
+ * A Card Refund object. This field will be present in the JSON response if and
528
+ * only if `category` is equal to `card_refund`.
529
+ */
512
530
  export interface CardRefund {
513
531
  /**
514
532
  * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -516,17 +534,48 @@ export namespace Transaction {
516
534
  */
517
535
  amount: number;
518
536
 
519
- /**
520
- * The identifier for the Transaction this refunds, if any.
521
- */
522
- card_settlement_transaction_id: string | null;
523
-
524
537
  /**
525
538
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
526
539
  * transaction's currency.
527
540
  */
528
541
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
529
542
 
543
+ /**
544
+ * The Card Refund identifier.
545
+ */
546
+ id: string;
547
+
548
+ /**
549
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
550
+ * is transacting with.
551
+ */
552
+ merchant_acceptor_id: string | null;
553
+
554
+ /**
555
+ * The 4-digit MCC describing the merchant's business.
556
+ */
557
+ merchant_category_code: string;
558
+
559
+ /**
560
+ * The city the merchant resides in.
561
+ */
562
+ merchant_city: string | null;
563
+
564
+ /**
565
+ * The country the merchant resides in.
566
+ */
567
+ merchant_country: string;
568
+
569
+ /**
570
+ * The name of the merchant.
571
+ */
572
+ merchant_name: string | null;
573
+
574
+ /**
575
+ * The state the merchant resides in.
576
+ */
577
+ merchant_state: string | null;
578
+
530
579
  /**
531
580
  * A constant representing the object's type. For this resource it will always be
532
581
  * `card_refund`.
@@ -534,6 +583,10 @@ export namespace Transaction {
534
583
  type: 'card_refund';
535
584
  }
536
585
 
586
+ /**
587
+ * A Card Settlement object. This field will be present in the JSON response if and
588
+ * only if `category` is equal to `card_settlement`.
589
+ */
537
590
  export interface CardSettlement {
538
591
  /**
539
592
  * The amount in the minor unit of the transaction's settlement currency. For
@@ -541,20 +594,52 @@ export namespace Transaction {
541
594
  */
542
595
  amount: number;
543
596
 
597
+ /**
598
+ * The Card Authorization that was created prior to this Card Settlement, if on
599
+ * exists.
600
+ */
601
+ card_authorization: string | null;
602
+
544
603
  /**
545
604
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
546
605
  * transaction's settlement currency.
547
606
  */
548
607
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
549
608
 
609
+ /**
610
+ * The Card Settlement identifier.
611
+ */
612
+ id: string;
613
+
614
+ /**
615
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
616
+ * is transacting with.
617
+ */
618
+ merchant_acceptor_id: string | null;
619
+
620
+ /**
621
+ * The 4-digit MCC describing the merchant's business.
622
+ */
550
623
  merchant_category_code: string;
551
624
 
625
+ /**
626
+ * The city the merchant resides in.
627
+ */
552
628
  merchant_city: string | null;
553
629
 
630
+ /**
631
+ * The country the merchant resides in.
632
+ */
554
633
  merchant_country: string;
555
634
 
635
+ /**
636
+ * The name of the merchant.
637
+ */
556
638
  merchant_name: string | null;
557
639
 
640
+ /**
641
+ * The state the merchant resides in.
642
+ */
558
643
  merchant_state: string | null;
559
644
 
560
645
  /**
@@ -580,6 +665,43 @@ export namespace Transaction {
580
665
  type: 'card_settlement';
581
666
  }
582
667
 
668
+ /**
669
+ * A Card Revenue Payment object. This field will be present in the JSON response
670
+ * if and only if `category` is equal to `card_revenue_payment`.
671
+ */
672
+ export interface CardRevenuePayment {
673
+ /**
674
+ * The amount in the minor unit of the transaction's currency. For dollars, for
675
+ * example, this is cents.
676
+ */
677
+ amount: number;
678
+
679
+ /**
680
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
681
+ * currency.
682
+ */
683
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
684
+
685
+ /**
686
+ * The end of the period for which this transaction paid interest.
687
+ */
688
+ period_end: string;
689
+
690
+ /**
691
+ * The start of the period for which this transaction paid interest.
692
+ */
693
+ period_start: string;
694
+
695
+ /**
696
+ * The account the card belonged to.
697
+ */
698
+ transacted_on_account_id: string | null;
699
+ }
700
+
701
+ /**
702
+ * A Check Deposit Acceptance object. This field will be present in the JSON
703
+ * response if and only if `category` is equal to `check_deposit_acceptance`.
704
+ */
583
705
  export interface CheckDepositAcceptance {
584
706
  /**
585
707
  * The account number printed on the check.
@@ -621,6 +743,10 @@ export namespace Transaction {
621
743
  serial_number: string | null;
622
744
  }
623
745
 
746
+ /**
747
+ * A Check Deposit Return object. This field will be present in the JSON response
748
+ * if and only if `category` is equal to `check_deposit_return`.
749
+ */
624
750
  export interface CheckDepositReturn {
625
751
  /**
626
752
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -650,7 +776,8 @@ export namespace Transaction {
650
776
  | 'stop_payment'
651
777
  | 'unknown_reason'
652
778
  | 'unmatched_details'
653
- | 'unreadable_image';
779
+ | 'unreadable_image'
780
+ | 'endorsement_irregular';
654
781
 
655
782
  /**
656
783
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -665,6 +792,10 @@ export namespace Transaction {
665
792
  transaction_id: string;
666
793
  }
667
794
 
795
+ /**
796
+ * A Check Transfer Intention object. This field will be present in the JSON
797
+ * response if and only if `category` is equal to `check_transfer_intention`.
798
+ */
668
799
  export interface CheckTransferIntention {
669
800
  /**
670
801
  * The city of the check's destination.
@@ -713,18 +844,43 @@ export namespace Transaction {
713
844
  transfer_id: string;
714
845
  }
715
846
 
847
+ /**
848
+ * A Check Transfer Return object. This field will be present in the JSON response
849
+ * if and only if `category` is equal to `check_transfer_return`.
850
+ */
716
851
  export interface CheckTransferReturn {
717
852
  /**
718
853
  * If available, a document with additional information about the return.
719
854
  */
720
855
  file_id: string | null;
721
856
 
857
+ /**
858
+ * The reason why the check was returned.
859
+ */
860
+ reason: 'mail_delivery_failure' | 'refused_by_recipient' | 'returned_not_authorized';
861
+
862
+ /**
863
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
864
+ * the check was returned.
865
+ */
866
+ returned_at: string;
867
+
868
+ /**
869
+ * The identifier of the Transaction that was created to credit you for the
870
+ * returned check.
871
+ */
872
+ transaction_id: string | null;
873
+
722
874
  /**
723
875
  * The identifier of the returned Check Transfer.
724
876
  */
725
877
  transfer_id: string;
726
878
  }
727
879
 
880
+ /**
881
+ * A Check Transfer Rejection object. This field will be present in the JSON
882
+ * response if and only if `category` is equal to `check_transfer_rejection`.
883
+ */
728
884
  export interface CheckTransferRejection {
729
885
  /**
730
886
  * The identifier of the Check Transfer that led to this Transaction.
@@ -732,6 +888,11 @@ export namespace Transaction {
732
888
  transfer_id: string;
733
889
  }
734
890
 
891
+ /**
892
+ * A Check Transfer Stop Payment Request object. This field will be present in the
893
+ * JSON response if and only if `category` is equal to
894
+ * `check_transfer_stop_payment_request`.
895
+ */
735
896
  export interface CheckTransferStopPaymentRequest {
736
897
  /**
737
898
  * The time the stop-payment was requested.
@@ -755,7 +916,11 @@ export namespace Transaction {
755
916
  type: 'check_transfer_stop_payment_request';
756
917
  }
757
918
 
758
- export interface DisputeResolution {
919
+ /**
920
+ * A Fee Payment object. This field will be present in the JSON response if and
921
+ * only if `category` is equal to `fee_payment`.
922
+ */
923
+ export interface FeePayment {
759
924
  /**
760
925
  * The amount in the minor unit of the transaction's currency. For dollars, for
761
926
  * example, this is cents.
@@ -763,29 +928,16 @@ export namespace Transaction {
763
928
  amount: number;
764
929
 
765
930
  /**
766
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
767
- * transaction's currency.
931
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
932
+ * currency.
768
933
  */
769
934
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
770
-
771
- /**
772
- * The identifier of the Transaction that was disputed.
773
- */
774
- disputed_transaction_id: string;
775
- }
776
-
777
- export interface EmpyrealCashDeposit {
778
- /**
779
- * The amount in the minor unit of the transaction's currency. For dollars, for
780
- * example, this is cents.
781
- */
782
- amount: number;
783
-
784
- bag_id: string;
785
-
786
- deposit_date: string;
787
935
  }
788
936
 
937
+ /**
938
+ * A Inbound ACH Transfer object. This field will be present in the JSON response
939
+ * if and only if `category` is equal to `inbound_ach_transfer`.
940
+ */
789
941
  export interface InboundACHTransfer {
790
942
  /**
791
943
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -810,6 +962,10 @@ export namespace Transaction {
810
962
  trace_number: string;
811
963
  }
812
964
 
965
+ /**
966
+ * A Inbound Check object. This field will be present in the JSON response if and
967
+ * only if `category` is equal to `inbound_check`.
968
+ */
813
969
  export interface InboundCheck {
814
970
  /**
815
971
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -830,6 +986,11 @@ export namespace Transaction {
830
986
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
831
987
  }
832
988
 
989
+ /**
990
+ * A Inbound International ACH Transfer object. This field will be present in the
991
+ * JSON response if and only if `category` is equal to
992
+ * `inbound_international_ach_transfer`.
993
+ */
833
994
  export interface InboundInternationalACHTransfer {
834
995
  /**
835
996
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -908,6 +1069,11 @@ export namespace Transaction {
908
1069
  trace_number: string;
909
1070
  }
910
1071
 
1072
+ /**
1073
+ * A Inbound Real Time Payments Transfer Confirmation object. This field will be
1074
+ * present in the JSON response if and only if `category` is equal to
1075
+ * `inbound_real_time_payments_transfer_confirmation`.
1076
+ */
911
1077
  export interface InboundRealTimePaymentsTransferConfirmation {
912
1078
  /**
913
1079
  * The amount in the minor unit of the transfer's currency. For dollars, for
@@ -952,6 +1118,11 @@ export namespace Transaction {
952
1118
  transaction_identification: string;
953
1119
  }
954
1120
 
1121
+ /**
1122
+ * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
1123
+ * the JSON response if and only if `category` is equal to
1124
+ * `inbound_wire_drawdown_payment_reversal`.
1125
+ */
955
1126
  export interface InboundWireDrawdownPaymentReversal {
956
1127
  /**
957
1128
  * The amount that was reversed.
@@ -1004,6 +1175,10 @@ export namespace Transaction {
1004
1175
  previous_message_input_source: string;
1005
1176
  }
1006
1177
 
1178
+ /**
1179
+ * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
1180
+ * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
1181
+ */
1007
1182
  export interface InboundWireDrawdownPayment {
1008
1183
  /**
1009
1184
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -1036,12 +1211,22 @@ export namespace Transaction {
1036
1211
  originator_to_beneficiary_information: string | null;
1037
1212
  }
1038
1213
 
1214
+ /**
1215
+ * A Inbound Wire Reversal object. This field will be present in the JSON response
1216
+ * if and only if `category` is equal to `inbound_wire_reversal`.
1217
+ */
1039
1218
  export interface InboundWireReversal {
1040
1219
  /**
1041
1220
  * The amount that was reversed.
1042
1221
  */
1043
1222
  amount: number;
1044
1223
 
1224
+ /**
1225
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1226
+ * the reversal was created.
1227
+ */
1228
+ created_at: string;
1229
+
1045
1230
  /**
1046
1231
  * The description on the reversal message from Fedwire.
1047
1232
  */
@@ -1097,8 +1282,22 @@ export namespace Transaction {
1097
1282
  * institution.
1098
1283
  */
1099
1284
  receiver_financial_institution_information: string | null;
1285
+
1286
+ /**
1287
+ * The ID for the Transaction associated with the transfer reversal.
1288
+ */
1289
+ transaction_id: string | null;
1290
+
1291
+ /**
1292
+ * The ID for the Wire Transfer that is being reversed.
1293
+ */
1294
+ wire_transfer_id: string;
1100
1295
  }
1101
1296
 
1297
+ /**
1298
+ * A Inbound Wire Transfer object. This field will be present in the JSON response
1299
+ * if and only if `category` is equal to `inbound_wire_transfer`.
1300
+ */
1102
1301
  export interface InboundWireTransfer {
1103
1302
  /**
1104
1303
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -1139,6 +1338,10 @@ export namespace Transaction {
1139
1338
  originator_to_beneficiary_information_line4: string | null;
1140
1339
  }
1141
1340
 
1341
+ /**
1342
+ * A Interest Payment object. This field will be present in the JSON response if
1343
+ * and only if `category` is equal to `interest_payment`.
1344
+ */
1142
1345
  export interface InterestPayment {
1143
1346
  /**
1144
1347
  * The account on which the interest was accrued.
@@ -1168,6 +1371,10 @@ export namespace Transaction {
1168
1371
  period_start: string;
1169
1372
  }
1170
1373
 
1374
+ /**
1375
+ * A Internal Source object. This field will be present in the JSON response if and
1376
+ * only if `category` is equal to `internal_source`.
1377
+ */
1171
1378
  export interface InternalSource {
1172
1379
  /**
1173
1380
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -1182,69 +1389,56 @@ export namespace Transaction {
1182
1389
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1183
1390
 
1184
1391
  reason:
1392
+ | 'account_closure'
1185
1393
  | 'bank_migration'
1186
1394
  | 'cashback'
1395
+ | 'collection_receivable'
1187
1396
  | 'empyreal_adjustment'
1188
1397
  | 'error'
1189
1398
  | 'error_correction'
1190
1399
  | 'fees'
1191
1400
  | 'interest'
1401
+ | 'negative_balance_forgiveness'
1192
1402
  | 'sample_funds'
1193
1403
  | 'sample_funds_return';
1194
1404
  }
1195
1405
 
1196
- export interface CardRouteRefund {
1406
+ /**
1407
+ * A Real Time Payments Transfer Acknowledgement object. This field will be present
1408
+ * in the JSON response if and only if `category` is equal to
1409
+ * `real_time_payments_transfer_acknowledgement`.
1410
+ */
1411
+ export interface RealTimePaymentsTransferAcknowledgement {
1197
1412
  /**
1198
- * The refunded amount in the minor unit of the refunded currency. For dollars, for
1199
- * example, this is cents.
1413
+ * The transfer amount in USD cents.
1200
1414
  */
1201
1415
  amount: number;
1202
1416
 
1203
1417
  /**
1204
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the refund
1205
- * currency.
1418
+ * The destination account number.
1206
1419
  */
1207
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1208
-
1209
- merchant_acceptor_id: string;
1210
-
1211
- merchant_category_code: string | null;
1212
-
1213
- merchant_city: string | null;
1214
-
1215
- merchant_country: string;
1216
-
1217
- merchant_descriptor: string;
1218
-
1219
- merchant_state: string | null;
1220
- }
1420
+ destination_account_number: string;
1221
1421
 
1222
- export interface CardRouteSettlement {
1223
1422
  /**
1224
- * The settled amount in the minor unit of the settlement currency. For dollars,
1225
- * for example, this is cents.
1423
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN).
1226
1424
  */
1227
- amount: number;
1425
+ destination_routing_number: string;
1228
1426
 
1229
1427
  /**
1230
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the settlement
1231
- * currency.
1428
+ * Unstructured information that will show on the recipient's bank statement.
1232
1429
  */
1233
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1234
-
1235
- merchant_acceptor_id: string;
1236
-
1237
- merchant_category_code: string | null;
1430
+ remittance_information: string;
1238
1431
 
1239
- merchant_city: string | null;
1240
-
1241
- merchant_country: string | null;
1242
-
1243
- merchant_descriptor: string;
1244
-
1245
- merchant_state: string | null;
1432
+ /**
1433
+ * The identifier of the Real Time Payments Transfer that led to this Transaction.
1434
+ */
1435
+ transfer_id: string;
1246
1436
  }
1247
1437
 
1438
+ /**
1439
+ * A Sample Funds object. This field will be present in the JSON response if and
1440
+ * only if `category` is equal to `sample_funds`.
1441
+ */
1248
1442
  export interface SampleFunds {
1249
1443
  /**
1250
1444
  * Where the sample funds came from.
@@ -1252,25 +1446,10 @@ export namespace Transaction {
1252
1446
  originator: string;
1253
1447
  }
1254
1448
 
1255
- export interface WireDrawdownPaymentIntention {
1256
- account_number: string;
1257
-
1258
- /**
1259
- * The transfer amount in USD cents.
1260
- */
1261
- amount: number;
1262
-
1263
- message_to_recipient: string;
1264
-
1265
- routing_number: string;
1266
-
1267
- transfer_id: string;
1268
- }
1269
-
1270
- export interface WireDrawdownPaymentRejection {
1271
- transfer_id: string;
1272
- }
1273
-
1449
+ /**
1450
+ * A Wire Transfer Intention object. This field will be present in the JSON
1451
+ * response if and only if `category` is equal to `wire_transfer_intention`.
1452
+ */
1274
1453
  export interface WireTransferIntention {
1275
1454
  /**
1276
1455
  * The destination account number.
@@ -1295,6 +1474,10 @@ export namespace Transaction {
1295
1474
  transfer_id: string;
1296
1475
  }
1297
1476
 
1477
+ /**
1478
+ * A Wire Transfer Rejection object. This field will be present in the JSON
1479
+ * response if and only if `category` is equal to `wire_transfer_rejection`.
1480
+ */
1298
1481
  export interface WireTransferRejection {
1299
1482
  transfer_id: string;
1300
1483
  }
@@ -1312,38 +1495,13 @@ export interface TransactionListParams extends PageParams {
1312
1495
  created_at?: TransactionListParams.CreatedAt;
1313
1496
 
1314
1497
  /**
1315
- * Filter Transactions for those belonging to the specified route.
1498
+ * Filter Transactions for those belonging to the specified route. This could be a
1499
+ * Card ID or an Account Number ID.
1316
1500
  */
1317
1501
  route_id?: string;
1318
1502
  }
1319
1503
 
1320
1504
  export namespace TransactionListParams {
1321
- export interface CreatedAt {
1322
- /**
1323
- * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
1324
- * timestamp.
1325
- */
1326
- after?: string;
1327
-
1328
- /**
1329
- * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
1330
- * timestamp.
1331
- */
1332
- before?: string;
1333
-
1334
- /**
1335
- * Return results on or after this
1336
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
1337
- */
1338
- on_or_after?: string;
1339
-
1340
- /**
1341
- * Return results on or before this
1342
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
1343
- */
1344
- on_or_before?: string;
1345
- }
1346
-
1347
1505
  export interface Category {
1348
1506
  /**
1349
1507
  * Return results whose value is in the provided list. For GET requests, this
@@ -1351,22 +1509,20 @@ export namespace TransactionListParams {
1351
1509
  */
1352
1510
  in?: Array<
1353
1511
  | 'account_transfer_intention'
1354
- | 'ach_check_conversion_return'
1355
- | 'ach_check_conversion'
1356
1512
  | 'ach_transfer_intention'
1357
1513
  | 'ach_transfer_rejection'
1358
1514
  | 'ach_transfer_return'
1359
1515
  | 'card_dispute_acceptance'
1360
1516
  | 'card_refund'
1361
1517
  | 'card_settlement'
1518
+ | 'card_revenue_payment'
1362
1519
  | 'check_deposit_acceptance'
1363
1520
  | 'check_deposit_return'
1364
1521
  | 'check_transfer_intention'
1365
1522
  | 'check_transfer_return'
1366
1523
  | 'check_transfer_rejection'
1367
1524
  | 'check_transfer_stop_payment_request'
1368
- | 'dispute_resolution'
1369
- | 'empyreal_cash_deposit'
1525
+ | 'fee_payment'
1370
1526
  | 'inbound_ach_transfer'
1371
1527
  | 'inbound_ach_transfer_return_intention'
1372
1528
  | 'inbound_check'
@@ -1377,17 +1533,38 @@ export namespace TransactionListParams {
1377
1533
  | 'inbound_wire_reversal'
1378
1534
  | 'inbound_wire_transfer'
1379
1535
  | 'interest_payment'
1380
- | 'internal_general_ledger_transaction'
1381
1536
  | 'internal_source'
1382
- | 'card_route_refund'
1383
- | 'card_route_settlement'
1384
1537
  | 'real_time_payments_transfer_acknowledgement'
1385
1538
  | 'sample_funds'
1386
- | 'wire_drawdown_payment_intention'
1387
- | 'wire_drawdown_payment_rejection'
1388
1539
  | 'wire_transfer_intention'
1389
1540
  | 'wire_transfer_rejection'
1390
1541
  | 'other'
1391
1542
  >;
1392
1543
  }
1544
+
1545
+ export interface CreatedAt {
1546
+ /**
1547
+ * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
1548
+ * timestamp.
1549
+ */
1550
+ after?: string;
1551
+
1552
+ /**
1553
+ * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
1554
+ * timestamp.
1555
+ */
1556
+ before?: string;
1557
+
1558
+ /**
1559
+ * Return results on or after this
1560
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
1561
+ */
1562
+ on_or_after?: string;
1563
+
1564
+ /**
1565
+ * Return results on or before this
1566
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
1567
+ */
1568
+ on_or_before?: string;
1569
+ }
1393
1570
  }