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
@@ -34,6 +34,11 @@ export interface WireTransferSimulation {
34
34
  }
35
35
 
36
36
  export namespace WireTransferSimulation {
37
+ /**
38
+ * If the Wire Transfer attempt succeeds, this will contain the resulting
39
+ * [Transaction](#transactions) object. The Transaction's `source` will be of
40
+ * `category: inbound_wire_transfer`.
41
+ */
37
42
  export interface Transaction {
38
43
  /**
39
44
  * The identifier for the Account the Transaction belongs to.
@@ -80,7 +85,7 @@ export namespace WireTransferSimulation {
80
85
  /**
81
86
  * The type of the route this Transaction came through.
82
87
  */
83
- route_type: string | null;
88
+ route_type: 'account_number' | 'card' | null;
84
89
 
85
90
  /**
86
91
  * This is an object giving more details on the network-level event that caused the
@@ -98,6 +103,12 @@ export namespace WireTransferSimulation {
98
103
  }
99
104
 
100
105
  export namespace Transaction {
106
+ /**
107
+ * This is an object giving more details on the network-level event that caused the
108
+ * Transaction. Note that for backwards compatibility reasons, additional
109
+ * undocumented keys may appear in this object. These should be treated as
110
+ * deprecated and will be removed in the future.
111
+ */
101
112
  export interface Source {
102
113
  /**
103
114
  * A Account Transfer Intention object. This field will be present in the JSON
@@ -105,18 +116,6 @@ export namespace WireTransferSimulation {
105
116
  */
106
117
  account_transfer_intention: Source.AccountTransferIntention | null;
107
118
 
108
- /**
109
- * A ACH Check Conversion object. This field will be present in the JSON response
110
- * if and only if `category` is equal to `ach_check_conversion`.
111
- */
112
- ach_check_conversion: Source.ACHCheckConversion | null;
113
-
114
- /**
115
- * A ACH Check Conversion Return object. This field will be present in the JSON
116
- * response if and only if `category` is equal to `ach_check_conversion_return`.
117
- */
118
- ach_check_conversion_return: Source.ACHCheckConversionReturn | null;
119
-
120
119
  /**
121
120
  * A ACH Transfer Intention object. This field will be present in the JSON response
122
121
  * if and only if `category` is equal to `ach_transfer_intention`.
@@ -148,16 +147,10 @@ export namespace WireTransferSimulation {
148
147
  card_refund: Source.CardRefund | null;
149
148
 
150
149
  /**
151
- * A Deprecated Card Refund object. This field will be present in the JSON response
152
- * if and only if `category` is equal to `card_route_refund`.
150
+ * A Card Revenue Payment object. This field will be present in the JSON response
151
+ * if and only if `category` is equal to `card_revenue_payment`.
153
152
  */
154
- card_route_refund: Source.CardRouteRefund | null;
155
-
156
- /**
157
- * A Deprecated Card Settlement object. This field will be present in the JSON
158
- * response if and only if `category` is equal to `card_route_settlement`.
159
- */
160
- card_route_settlement: Source.CardRouteSettlement | null;
153
+ card_revenue_payment: Source.CardRevenuePayment | null;
161
154
 
162
155
  /**
163
156
  * A Card Settlement object. This field will be present in the JSON response if and
@@ -172,22 +165,20 @@ export namespace WireTransferSimulation {
172
165
  */
173
166
  category:
174
167
  | 'account_transfer_intention'
175
- | 'ach_check_conversion_return'
176
- | 'ach_check_conversion'
177
168
  | 'ach_transfer_intention'
178
169
  | 'ach_transfer_rejection'
179
170
  | 'ach_transfer_return'
180
171
  | 'card_dispute_acceptance'
181
172
  | 'card_refund'
182
173
  | 'card_settlement'
174
+ | 'card_revenue_payment'
183
175
  | 'check_deposit_acceptance'
184
176
  | 'check_deposit_return'
185
177
  | 'check_transfer_intention'
186
178
  | 'check_transfer_return'
187
179
  | 'check_transfer_rejection'
188
180
  | 'check_transfer_stop_payment_request'
189
- | 'dispute_resolution'
190
- | 'empyreal_cash_deposit'
181
+ | 'fee_payment'
191
182
  | 'inbound_ach_transfer'
192
183
  | 'inbound_ach_transfer_return_intention'
193
184
  | 'inbound_check'
@@ -198,14 +189,9 @@ export namespace WireTransferSimulation {
198
189
  | 'inbound_wire_reversal'
199
190
  | 'inbound_wire_transfer'
200
191
  | 'interest_payment'
201
- | 'internal_general_ledger_transaction'
202
192
  | 'internal_source'
203
- | 'card_route_refund'
204
- | 'card_route_settlement'
205
193
  | 'real_time_payments_transfer_acknowledgement'
206
194
  | 'sample_funds'
207
- | 'wire_drawdown_payment_intention'
208
- | 'wire_drawdown_payment_rejection'
209
195
  | 'wire_transfer_intention'
210
196
  | 'wire_transfer_rejection'
211
197
  | 'other';
@@ -248,16 +234,10 @@ export namespace WireTransferSimulation {
248
234
  check_transfer_stop_payment_request: Source.CheckTransferStopPaymentRequest | null;
249
235
 
250
236
  /**
251
- * A Dispute Resolution object. This field will be present in the JSON response if
252
- * and only if `category` is equal to `dispute_resolution`.
253
- */
254
- dispute_resolution: Source.DisputeResolution | null;
255
-
256
- /**
257
- * A Empyreal Cash Deposit object. This field will be present in the JSON response
258
- * if and only if `category` is equal to `empyreal_cash_deposit`.
237
+ * A Fee Payment object. This field will be present in the JSON response if and
238
+ * only if `category` is equal to `fee_payment`.
259
239
  */
260
- empyreal_cash_deposit: Source.EmpyrealCashDeposit | null;
240
+ fee_payment: Source.FeePayment | null;
261
241
 
262
242
  /**
263
243
  * A Inbound ACH Transfer object. This field will be present in the JSON response
@@ -323,24 +303,17 @@ export namespace WireTransferSimulation {
323
303
  internal_source: Source.InternalSource | null;
324
304
 
325
305
  /**
326
- * A Sample Funds object. This field will be present in the JSON response if and
327
- * only if `category` is equal to `sample_funds`.
306
+ * A Real Time Payments Transfer Acknowledgement object. This field will be present
307
+ * in the JSON response if and only if `category` is equal to
308
+ * `real_time_payments_transfer_acknowledgement`.
328
309
  */
329
- sample_funds: Source.SampleFunds | null;
310
+ real_time_payments_transfer_acknowledgement: Source.RealTimePaymentsTransferAcknowledgement | null;
330
311
 
331
312
  /**
332
- * A Wire Drawdown Payment Intention object. This field will be present in the JSON
333
- * response if and only if `category` is equal to
334
- * `wire_drawdown_payment_intention`.
335
- */
336
- wire_drawdown_payment_intention: Source.WireDrawdownPaymentIntention | null;
337
-
338
- /**
339
- * A Wire Drawdown Payment Rejection object. This field will be present in the JSON
340
- * response if and only if `category` is equal to
341
- * `wire_drawdown_payment_rejection`.
313
+ * A Sample Funds object. This field will be present in the JSON response if and
314
+ * only if `category` is equal to `sample_funds`.
342
315
  */
343
- wire_drawdown_payment_rejection: Source.WireDrawdownPaymentRejection | null;
316
+ sample_funds: Source.SampleFunds | null;
344
317
 
345
318
  /**
346
319
  * A Wire Transfer Intention object. This field will be present in the JSON
@@ -356,6 +329,10 @@ export namespace WireTransferSimulation {
356
329
  }
357
330
 
358
331
  export namespace Source {
332
+ /**
333
+ * A Account Transfer Intention object. This field will be present in the JSON
334
+ * response if and only if `category` is equal to `account_transfer_intention`.
335
+ */
359
336
  export interface AccountTransferIntention {
360
337
  /**
361
338
  * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -390,32 +367,10 @@ export namespace WireTransferSimulation {
390
367
  transfer_id: string;
391
368
  }
392
369
 
393
- export interface ACHCheckConversionReturn {
394
- /**
395
- * The amount in the minor unit of the transaction's currency. For dollars, for
396
- * example, this is cents.
397
- */
398
- amount: number;
399
-
400
- /**
401
- * Why the transfer was returned.
402
- */
403
- return_reason_code: string;
404
- }
405
-
406
- export interface ACHCheckConversion {
407
- /**
408
- * The amount in the minor unit of the transaction's currency. For dollars, for
409
- * example, this is cents.
410
- */
411
- amount: number;
412
-
413
- /**
414
- * The identifier of the File containing an image of the returned check.
415
- */
416
- file_id: string;
417
- }
418
-
370
+ /**
371
+ * A ACH Transfer Intention object. This field will be present in the JSON response
372
+ * if and only if `category` is equal to `ach_transfer_intention`.
373
+ */
419
374
  export interface ACHTransferIntention {
420
375
  account_number: string;
421
376
 
@@ -435,6 +390,10 @@ export namespace WireTransferSimulation {
435
390
  transfer_id: string;
436
391
  }
437
392
 
393
+ /**
394
+ * A ACH Transfer Rejection object. This field will be present in the JSON response
395
+ * if and only if `category` is equal to `ach_transfer_rejection`.
396
+ */
438
397
  export interface ACHTransferRejection {
439
398
  /**
440
399
  * The identifier of the ACH Transfer that led to this Transaction.
@@ -442,6 +401,10 @@ export namespace WireTransferSimulation {
442
401
  transfer_id: string;
443
402
  }
444
403
 
404
+ /**
405
+ * A ACH Transfer Return object. This field will be present in the JSON response if
406
+ * and only if `category` is equal to `ach_transfer_return`.
407
+ */
445
408
  export interface ACHTransferReturn {
446
409
  /**
447
410
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -449,6 +412,11 @@ export namespace WireTransferSimulation {
449
412
  */
450
413
  created_at: string;
451
414
 
415
+ /**
416
+ * The three character ACH return code, in the range R01 to R85.
417
+ */
418
+ raw_return_reason_code: string;
419
+
452
420
  /**
453
421
  * Why the ACH Transfer was returned.
454
422
  */
@@ -472,10 +440,58 @@ export namespace WireTransferSimulation {
472
440
  | 'file_record_edit_criteria'
473
441
  | 'enr_invalid_individual_name'
474
442
  | 'returned_per_odfi_request'
475
- | 'addenda_error'
476
443
  | 'limited_participation_dfi'
477
444
  | 'incorrectly_coded_outbound_international_payment'
478
- | 'other';
445
+ | 'other'
446
+ | 'account_sold_to_another_dfi'
447
+ | 'addenda_error'
448
+ | 'beneficiary_or_account_holder_deceased'
449
+ | 'customer_advised_not_within_authorization_terms'
450
+ | 'corrected_return'
451
+ | 'duplicate_entry'
452
+ | 'duplicate_return'
453
+ | 'enr_duplicate_enrollment'
454
+ | 'enr_invalid_dfi_account_number'
455
+ | 'enr_invalid_individual_id_number'
456
+ | 'enr_invalid_representative_payee_indicator'
457
+ | 'enr_invalid_transaction_code'
458
+ | 'enr_return_of_enr_entry'
459
+ | 'enr_routing_number_check_digit_error'
460
+ | 'entry_not_processed_by_gateway'
461
+ | 'field_error'
462
+ | 'foreign_receiving_dfi_unable_to_settle'
463
+ | 'iat_entry_coding_error'
464
+ | 'improper_effective_entry_date'
465
+ | 'improper_source_document_source_document_presented'
466
+ | 'invalid_company_id'
467
+ | 'invalid_foreign_receiving_dfi_identification'
468
+ | 'invalid_individual_id_number'
469
+ | 'item_and_rck_entry_presented_for_payment'
470
+ | 'item_related_to_rck_entry_is_ineligible'
471
+ | 'mandatory_field_error'
472
+ | 'misrouted_dishonored_return'
473
+ | 'misrouted_return'
474
+ | 'no_errors_found'
475
+ | 'non_acceptance_of_r62_dishonored_return'
476
+ | 'non_participant_in_iat_program'
477
+ | 'permissible_return_entry'
478
+ | 'permissible_return_entry_not_accepted'
479
+ | 'rdfi_non_settlement'
480
+ | 'rdfi_participant_in_check_truncation_program'
481
+ | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
482
+ | 'return_not_a_duplicate'
483
+ | 'return_of_erroneous_or_reversing_debit'
484
+ | 'return_of_improper_credit_entry'
485
+ | 'return_of_improper_debit_entry'
486
+ | 'return_of_xck_entry'
487
+ | 'source_document_presented_for_payment'
488
+ | 'state_law_affecting_rck_acceptance'
489
+ | 'stop_payment_on_item_related_to_rck_entry'
490
+ | 'stop_payment_on_source_document'
491
+ | 'timely_original_return'
492
+ | 'trace_number_error'
493
+ | 'untimely_dishonored_return'
494
+ | 'untimely_return';
479
495
 
480
496
  /**
481
497
  * The identifier of the Tranasaction associated with this return.
@@ -488,6 +504,10 @@ export namespace WireTransferSimulation {
488
504
  transfer_id: string;
489
505
  }
490
506
 
507
+ /**
508
+ * A Card Dispute Acceptance object. This field will be present in the JSON
509
+ * response if and only if `category` is equal to `card_dispute_acceptance`.
510
+ */
491
511
  export interface CardDisputeAcceptance {
492
512
  /**
493
513
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -504,9 +524,13 @@ export namespace WireTransferSimulation {
504
524
  * The identifier of the Transaction that was created to return the disputed funds
505
525
  * to your account.
506
526
  */
507
- transaction_id: string | null;
527
+ transaction_id: string;
508
528
  }
509
529
 
530
+ /**
531
+ * A Card Refund object. This field will be present in the JSON response if and
532
+ * only if `category` is equal to `card_refund`.
533
+ */
510
534
  export interface CardRefund {
511
535
  /**
512
536
  * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -514,17 +538,48 @@ export namespace WireTransferSimulation {
514
538
  */
515
539
  amount: number;
516
540
 
517
- /**
518
- * The identifier for the Transaction this refunds, if any.
519
- */
520
- card_settlement_transaction_id: string | null;
521
-
522
541
  /**
523
542
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
524
543
  * transaction's currency.
525
544
  */
526
545
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
527
546
 
547
+ /**
548
+ * The Card Refund identifier.
549
+ */
550
+ id: string;
551
+
552
+ /**
553
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
554
+ * is transacting with.
555
+ */
556
+ merchant_acceptor_id: string | null;
557
+
558
+ /**
559
+ * The 4-digit MCC describing the merchant's business.
560
+ */
561
+ merchant_category_code: string;
562
+
563
+ /**
564
+ * The city the merchant resides in.
565
+ */
566
+ merchant_city: string | null;
567
+
568
+ /**
569
+ * The country the merchant resides in.
570
+ */
571
+ merchant_country: string;
572
+
573
+ /**
574
+ * The name of the merchant.
575
+ */
576
+ merchant_name: string | null;
577
+
578
+ /**
579
+ * The state the merchant resides in.
580
+ */
581
+ merchant_state: string | null;
582
+
528
583
  /**
529
584
  * A constant representing the object's type. For this resource it will always be
530
585
  * `card_refund`.
@@ -532,6 +587,10 @@ export namespace WireTransferSimulation {
532
587
  type: 'card_refund';
533
588
  }
534
589
 
590
+ /**
591
+ * A Card Settlement object. This field will be present in the JSON response if and
592
+ * only if `category` is equal to `card_settlement`.
593
+ */
535
594
  export interface CardSettlement {
536
595
  /**
537
596
  * The amount in the minor unit of the transaction's settlement currency. For
@@ -539,20 +598,52 @@ export namespace WireTransferSimulation {
539
598
  */
540
599
  amount: number;
541
600
 
601
+ /**
602
+ * The Card Authorization that was created prior to this Card Settlement, if on
603
+ * exists.
604
+ */
605
+ card_authorization: string | null;
606
+
542
607
  /**
543
608
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
544
609
  * transaction's settlement currency.
545
610
  */
546
611
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
547
612
 
613
+ /**
614
+ * The Card Settlement identifier.
615
+ */
616
+ id: string;
617
+
618
+ /**
619
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
620
+ * is transacting with.
621
+ */
622
+ merchant_acceptor_id: string | null;
623
+
624
+ /**
625
+ * The 4-digit MCC describing the merchant's business.
626
+ */
548
627
  merchant_category_code: string;
549
628
 
629
+ /**
630
+ * The city the merchant resides in.
631
+ */
550
632
  merchant_city: string | null;
551
633
 
634
+ /**
635
+ * The country the merchant resides in.
636
+ */
552
637
  merchant_country: string;
553
638
 
639
+ /**
640
+ * The name of the merchant.
641
+ */
554
642
  merchant_name: string | null;
555
643
 
644
+ /**
645
+ * The state the merchant resides in.
646
+ */
556
647
  merchant_state: string | null;
557
648
 
558
649
  /**
@@ -578,6 +669,43 @@ export namespace WireTransferSimulation {
578
669
  type: 'card_settlement';
579
670
  }
580
671
 
672
+ /**
673
+ * A Card Revenue Payment object. This field will be present in the JSON response
674
+ * if and only if `category` is equal to `card_revenue_payment`.
675
+ */
676
+ export interface CardRevenuePayment {
677
+ /**
678
+ * The amount in the minor unit of the transaction's currency. For dollars, for
679
+ * example, this is cents.
680
+ */
681
+ amount: number;
682
+
683
+ /**
684
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
685
+ * currency.
686
+ */
687
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
688
+
689
+ /**
690
+ * The end of the period for which this transaction paid interest.
691
+ */
692
+ period_end: string;
693
+
694
+ /**
695
+ * The start of the period for which this transaction paid interest.
696
+ */
697
+ period_start: string;
698
+
699
+ /**
700
+ * The account the card belonged to.
701
+ */
702
+ transacted_on_account_id: string | null;
703
+ }
704
+
705
+ /**
706
+ * A Check Deposit Acceptance object. This field will be present in the JSON
707
+ * response if and only if `category` is equal to `check_deposit_acceptance`.
708
+ */
581
709
  export interface CheckDepositAcceptance {
582
710
  /**
583
711
  * The account number printed on the check.
@@ -619,6 +747,10 @@ export namespace WireTransferSimulation {
619
747
  serial_number: string | null;
620
748
  }
621
749
 
750
+ /**
751
+ * A Check Deposit Return object. This field will be present in the JSON response
752
+ * if and only if `category` is equal to `check_deposit_return`.
753
+ */
622
754
  export interface CheckDepositReturn {
623
755
  /**
624
756
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -648,7 +780,8 @@ export namespace WireTransferSimulation {
648
780
  | 'stop_payment'
649
781
  | 'unknown_reason'
650
782
  | 'unmatched_details'
651
- | 'unreadable_image';
783
+ | 'unreadable_image'
784
+ | 'endorsement_irregular';
652
785
 
653
786
  /**
654
787
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -663,6 +796,10 @@ export namespace WireTransferSimulation {
663
796
  transaction_id: string;
664
797
  }
665
798
 
799
+ /**
800
+ * A Check Transfer Intention object. This field will be present in the JSON
801
+ * response if and only if `category` is equal to `check_transfer_intention`.
802
+ */
666
803
  export interface CheckTransferIntention {
667
804
  /**
668
805
  * The city of the check's destination.
@@ -711,18 +848,43 @@ export namespace WireTransferSimulation {
711
848
  transfer_id: string;
712
849
  }
713
850
 
851
+ /**
852
+ * A Check Transfer Return object. This field will be present in the JSON response
853
+ * if and only if `category` is equal to `check_transfer_return`.
854
+ */
714
855
  export interface CheckTransferReturn {
715
856
  /**
716
857
  * If available, a document with additional information about the return.
717
858
  */
718
859
  file_id: string | null;
719
860
 
861
+ /**
862
+ * The reason why the check was returned.
863
+ */
864
+ reason: 'mail_delivery_failure' | 'refused_by_recipient' | 'returned_not_authorized';
865
+
866
+ /**
867
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
868
+ * the check was returned.
869
+ */
870
+ returned_at: string;
871
+
872
+ /**
873
+ * The identifier of the Transaction that was created to credit you for the
874
+ * returned check.
875
+ */
876
+ transaction_id: string | null;
877
+
720
878
  /**
721
879
  * The identifier of the returned Check Transfer.
722
880
  */
723
881
  transfer_id: string;
724
882
  }
725
883
 
884
+ /**
885
+ * A Check Transfer Rejection object. This field will be present in the JSON
886
+ * response if and only if `category` is equal to `check_transfer_rejection`.
887
+ */
726
888
  export interface CheckTransferRejection {
727
889
  /**
728
890
  * The identifier of the Check Transfer that led to this Transaction.
@@ -730,6 +892,11 @@ export namespace WireTransferSimulation {
730
892
  transfer_id: string;
731
893
  }
732
894
 
895
+ /**
896
+ * A Check Transfer Stop Payment Request object. This field will be present in the
897
+ * JSON response if and only if `category` is equal to
898
+ * `check_transfer_stop_payment_request`.
899
+ */
733
900
  export interface CheckTransferStopPaymentRequest {
734
901
  /**
735
902
  * The time the stop-payment was requested.
@@ -753,7 +920,11 @@ export namespace WireTransferSimulation {
753
920
  type: 'check_transfer_stop_payment_request';
754
921
  }
755
922
 
756
- export interface DisputeResolution {
923
+ /**
924
+ * A Fee Payment object. This field will be present in the JSON response if and
925
+ * only if `category` is equal to `fee_payment`.
926
+ */
927
+ export interface FeePayment {
757
928
  /**
758
929
  * The amount in the minor unit of the transaction's currency. For dollars, for
759
930
  * example, this is cents.
@@ -761,29 +932,16 @@ export namespace WireTransferSimulation {
761
932
  amount: number;
762
933
 
763
934
  /**
764
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
765
- * transaction's currency.
935
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
936
+ * currency.
766
937
  */
767
938
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
768
-
769
- /**
770
- * The identifier of the Transaction that was disputed.
771
- */
772
- disputed_transaction_id: string;
773
- }
774
-
775
- export interface EmpyrealCashDeposit {
776
- /**
777
- * The amount in the minor unit of the transaction's currency. For dollars, for
778
- * example, this is cents.
779
- */
780
- amount: number;
781
-
782
- bag_id: string;
783
-
784
- deposit_date: string;
785
939
  }
786
940
 
941
+ /**
942
+ * A Inbound ACH Transfer object. This field will be present in the JSON response
943
+ * if and only if `category` is equal to `inbound_ach_transfer`.
944
+ */
787
945
  export interface InboundACHTransfer {
788
946
  /**
789
947
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -808,6 +966,10 @@ export namespace WireTransferSimulation {
808
966
  trace_number: string;
809
967
  }
810
968
 
969
+ /**
970
+ * A Inbound Check object. This field will be present in the JSON response if and
971
+ * only if `category` is equal to `inbound_check`.
972
+ */
811
973
  export interface InboundCheck {
812
974
  /**
813
975
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -828,6 +990,11 @@ export namespace WireTransferSimulation {
828
990
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
829
991
  }
830
992
 
993
+ /**
994
+ * A Inbound International ACH Transfer object. This field will be present in the
995
+ * JSON response if and only if `category` is equal to
996
+ * `inbound_international_ach_transfer`.
997
+ */
831
998
  export interface InboundInternationalACHTransfer {
832
999
  /**
833
1000
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -906,6 +1073,11 @@ export namespace WireTransferSimulation {
906
1073
  trace_number: string;
907
1074
  }
908
1075
 
1076
+ /**
1077
+ * A Inbound Real Time Payments Transfer Confirmation object. This field will be
1078
+ * present in the JSON response if and only if `category` is equal to
1079
+ * `inbound_real_time_payments_transfer_confirmation`.
1080
+ */
909
1081
  export interface InboundRealTimePaymentsTransferConfirmation {
910
1082
  /**
911
1083
  * The amount in the minor unit of the transfer's currency. For dollars, for
@@ -950,6 +1122,11 @@ export namespace WireTransferSimulation {
950
1122
  transaction_identification: string;
951
1123
  }
952
1124
 
1125
+ /**
1126
+ * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
1127
+ * the JSON response if and only if `category` is equal to
1128
+ * `inbound_wire_drawdown_payment_reversal`.
1129
+ */
953
1130
  export interface InboundWireDrawdownPaymentReversal {
954
1131
  /**
955
1132
  * The amount that was reversed.
@@ -1002,6 +1179,10 @@ export namespace WireTransferSimulation {
1002
1179
  previous_message_input_source: string;
1003
1180
  }
1004
1181
 
1182
+ /**
1183
+ * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
1184
+ * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
1185
+ */
1005
1186
  export interface InboundWireDrawdownPayment {
1006
1187
  /**
1007
1188
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -1034,12 +1215,22 @@ export namespace WireTransferSimulation {
1034
1215
  originator_to_beneficiary_information: string | null;
1035
1216
  }
1036
1217
 
1218
+ /**
1219
+ * A Inbound Wire Reversal object. This field will be present in the JSON response
1220
+ * if and only if `category` is equal to `inbound_wire_reversal`.
1221
+ */
1037
1222
  export interface InboundWireReversal {
1038
1223
  /**
1039
1224
  * The amount that was reversed.
1040
1225
  */
1041
1226
  amount: number;
1042
1227
 
1228
+ /**
1229
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1230
+ * the reversal was created.
1231
+ */
1232
+ created_at: string;
1233
+
1043
1234
  /**
1044
1235
  * The description on the reversal message from Fedwire.
1045
1236
  */
@@ -1095,8 +1286,22 @@ export namespace WireTransferSimulation {
1095
1286
  * institution.
1096
1287
  */
1097
1288
  receiver_financial_institution_information: string | null;
1289
+
1290
+ /**
1291
+ * The ID for the Transaction associated with the transfer reversal.
1292
+ */
1293
+ transaction_id: string | null;
1294
+
1295
+ /**
1296
+ * The ID for the Wire Transfer that is being reversed.
1297
+ */
1298
+ wire_transfer_id: string;
1098
1299
  }
1099
1300
 
1301
+ /**
1302
+ * A Inbound Wire Transfer object. This field will be present in the JSON response
1303
+ * if and only if `category` is equal to `inbound_wire_transfer`.
1304
+ */
1100
1305
  export interface InboundWireTransfer {
1101
1306
  /**
1102
1307
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -1137,6 +1342,10 @@ export namespace WireTransferSimulation {
1137
1342
  originator_to_beneficiary_information_line4: string | null;
1138
1343
  }
1139
1344
 
1345
+ /**
1346
+ * A Interest Payment object. This field will be present in the JSON response if
1347
+ * and only if `category` is equal to `interest_payment`.
1348
+ */
1140
1349
  export interface InterestPayment {
1141
1350
  /**
1142
1351
  * The account on which the interest was accrued.
@@ -1166,6 +1375,10 @@ export namespace WireTransferSimulation {
1166
1375
  period_start: string;
1167
1376
  }
1168
1377
 
1378
+ /**
1379
+ * A Internal Source object. This field will be present in the JSON response if and
1380
+ * only if `category` is equal to `internal_source`.
1381
+ */
1169
1382
  export interface InternalSource {
1170
1383
  /**
1171
1384
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -1180,69 +1393,56 @@ export namespace WireTransferSimulation {
1180
1393
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1181
1394
 
1182
1395
  reason:
1396
+ | 'account_closure'
1183
1397
  | 'bank_migration'
1184
1398
  | 'cashback'
1399
+ | 'collection_receivable'
1185
1400
  | 'empyreal_adjustment'
1186
1401
  | 'error'
1187
1402
  | 'error_correction'
1188
1403
  | 'fees'
1189
1404
  | 'interest'
1405
+ | 'negative_balance_forgiveness'
1190
1406
  | 'sample_funds'
1191
1407
  | 'sample_funds_return';
1192
1408
  }
1193
1409
 
1194
- export interface CardRouteRefund {
1410
+ /**
1411
+ * A Real Time Payments Transfer Acknowledgement object. This field will be present
1412
+ * in the JSON response if and only if `category` is equal to
1413
+ * `real_time_payments_transfer_acknowledgement`.
1414
+ */
1415
+ export interface RealTimePaymentsTransferAcknowledgement {
1195
1416
  /**
1196
- * The refunded amount in the minor unit of the refunded currency. For dollars, for
1197
- * example, this is cents.
1417
+ * The transfer amount in USD cents.
1198
1418
  */
1199
1419
  amount: number;
1200
1420
 
1201
1421
  /**
1202
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the refund
1203
- * currency.
1422
+ * The destination account number.
1204
1423
  */
1205
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1206
-
1207
- merchant_acceptor_id: string;
1424
+ destination_account_number: string;
1208
1425
 
1209
- merchant_category_code: string | null;
1210
-
1211
- merchant_city: string | null;
1212
-
1213
- merchant_country: string;
1214
-
1215
- merchant_descriptor: string;
1216
-
1217
- merchant_state: string | null;
1218
- }
1219
-
1220
- export interface CardRouteSettlement {
1221
1426
  /**
1222
- * The settled amount in the minor unit of the settlement currency. For dollars,
1223
- * for example, this is cents.
1427
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN).
1224
1428
  */
1225
- amount: number;
1429
+ destination_routing_number: string;
1226
1430
 
1227
1431
  /**
1228
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the settlement
1229
- * currency.
1432
+ * Unstructured information that will show on the recipient's bank statement.
1230
1433
  */
1231
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1232
-
1233
- merchant_acceptor_id: string;
1234
-
1235
- merchant_category_code: string | null;
1236
-
1237
- merchant_city: string | null;
1434
+ remittance_information: string;
1238
1435
 
1239
- merchant_country: string | null;
1240
-
1241
- merchant_descriptor: string;
1242
-
1243
- merchant_state: string | null;
1436
+ /**
1437
+ * The identifier of the Real Time Payments Transfer that led to this Transaction.
1438
+ */
1439
+ transfer_id: string;
1244
1440
  }
1245
1441
 
1442
+ /**
1443
+ * A Sample Funds object. This field will be present in the JSON response if and
1444
+ * only if `category` is equal to `sample_funds`.
1445
+ */
1246
1446
  export interface SampleFunds {
1247
1447
  /**
1248
1448
  * Where the sample funds came from.
@@ -1250,25 +1450,10 @@ export namespace WireTransferSimulation {
1250
1450
  originator: string;
1251
1451
  }
1252
1452
 
1253
- export interface WireDrawdownPaymentIntention {
1254
- account_number: string;
1255
-
1256
- /**
1257
- * The transfer amount in USD cents.
1258
- */
1259
- amount: number;
1260
-
1261
- message_to_recipient: string;
1262
-
1263
- routing_number: string;
1264
-
1265
- transfer_id: string;
1266
- }
1267
-
1268
- export interface WireDrawdownPaymentRejection {
1269
- transfer_id: string;
1270
- }
1271
-
1453
+ /**
1454
+ * A Wire Transfer Intention object. This field will be present in the JSON
1455
+ * response if and only if `category` is equal to `wire_transfer_intention`.
1456
+ */
1272
1457
  export interface WireTransferIntention {
1273
1458
  /**
1274
1459
  * The destination account number.
@@ -1293,6 +1478,10 @@ export namespace WireTransferSimulation {
1293
1478
  transfer_id: string;
1294
1479
  }
1295
1480
 
1481
+ /**
1482
+ * A Wire Transfer Rejection object. This field will be present in the JSON
1483
+ * response if and only if `category` is equal to `wire_transfer_rejection`.
1484
+ */
1296
1485
  export interface WireTransferRejection {
1297
1486
  transfer_id: string;
1298
1487
  }