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
@@ -26,6 +26,11 @@ export interface WireTransferSimulation {
26
26
  type: 'inbound_wire_transfer_simulation_result';
27
27
  }
28
28
  export declare namespace WireTransferSimulation {
29
+ /**
30
+ * If the Wire Transfer attempt succeeds, this will contain the resulting
31
+ * [Transaction](#transactions) object. The Transaction's `source` will be of
32
+ * `category: inbound_wire_transfer`.
33
+ */
29
34
  interface Transaction {
30
35
  /**
31
36
  * The identifier for the Account the Transaction belongs to.
@@ -65,7 +70,7 @@ export declare namespace WireTransferSimulation {
65
70
  /**
66
71
  * The type of the route this Transaction came through.
67
72
  */
68
- route_type: string | null;
73
+ route_type: 'account_number' | 'card' | null;
69
74
  /**
70
75
  * This is an object giving more details on the network-level event that caused the
71
76
  * Transaction. Note that for backwards compatibility reasons, additional
@@ -80,22 +85,18 @@ export declare namespace WireTransferSimulation {
80
85
  type: 'transaction';
81
86
  }
82
87
  namespace Transaction {
88
+ /**
89
+ * This is an object giving more details on the network-level event that caused the
90
+ * Transaction. Note that for backwards compatibility reasons, additional
91
+ * undocumented keys may appear in this object. These should be treated as
92
+ * deprecated and will be removed in the future.
93
+ */
83
94
  interface Source {
84
95
  /**
85
96
  * A Account Transfer Intention object. This field will be present in the JSON
86
97
  * response if and only if `category` is equal to `account_transfer_intention`.
87
98
  */
88
99
  account_transfer_intention: Source.AccountTransferIntention | null;
89
- /**
90
- * A ACH Check Conversion object. This field will be present in the JSON response
91
- * if and only if `category` is equal to `ach_check_conversion`.
92
- */
93
- ach_check_conversion: Source.ACHCheckConversion | null;
94
- /**
95
- * A ACH Check Conversion Return object. This field will be present in the JSON
96
- * response if and only if `category` is equal to `ach_check_conversion_return`.
97
- */
98
- ach_check_conversion_return: Source.ACHCheckConversionReturn | null;
99
100
  /**
100
101
  * A ACH Transfer Intention object. This field will be present in the JSON response
101
102
  * if and only if `category` is equal to `ach_transfer_intention`.
@@ -122,15 +123,10 @@ export declare namespace WireTransferSimulation {
122
123
  */
123
124
  card_refund: Source.CardRefund | null;
124
125
  /**
125
- * A Deprecated Card Refund object. This field will be present in the JSON response
126
- * if and only if `category` is equal to `card_route_refund`.
127
- */
128
- card_route_refund: Source.CardRouteRefund | null;
129
- /**
130
- * A Deprecated Card Settlement object. This field will be present in the JSON
131
- * response if and only if `category` is equal to `card_route_settlement`.
126
+ * A Card Revenue Payment object. This field will be present in the JSON response
127
+ * if and only if `category` is equal to `card_revenue_payment`.
132
128
  */
133
- card_route_settlement: Source.CardRouteSettlement | null;
129
+ card_revenue_payment: Source.CardRevenuePayment | null;
134
130
  /**
135
131
  * A Card Settlement object. This field will be present in the JSON response if and
136
132
  * only if `category` is equal to `card_settlement`.
@@ -143,22 +139,20 @@ export declare namespace WireTransferSimulation {
143
139
  */
144
140
  category:
145
141
  | 'account_transfer_intention'
146
- | 'ach_check_conversion_return'
147
- | 'ach_check_conversion'
148
142
  | 'ach_transfer_intention'
149
143
  | 'ach_transfer_rejection'
150
144
  | 'ach_transfer_return'
151
145
  | 'card_dispute_acceptance'
152
146
  | 'card_refund'
153
147
  | 'card_settlement'
148
+ | 'card_revenue_payment'
154
149
  | 'check_deposit_acceptance'
155
150
  | 'check_deposit_return'
156
151
  | 'check_transfer_intention'
157
152
  | 'check_transfer_return'
158
153
  | 'check_transfer_rejection'
159
154
  | 'check_transfer_stop_payment_request'
160
- | 'dispute_resolution'
161
- | 'empyreal_cash_deposit'
155
+ | 'fee_payment'
162
156
  | 'inbound_ach_transfer'
163
157
  | 'inbound_ach_transfer_return_intention'
164
158
  | 'inbound_check'
@@ -169,14 +163,9 @@ export declare namespace WireTransferSimulation {
169
163
  | 'inbound_wire_reversal'
170
164
  | 'inbound_wire_transfer'
171
165
  | 'interest_payment'
172
- | 'internal_general_ledger_transaction'
173
166
  | 'internal_source'
174
- | 'card_route_refund'
175
- | 'card_route_settlement'
176
167
  | 'real_time_payments_transfer_acknowledgement'
177
168
  | 'sample_funds'
178
- | 'wire_drawdown_payment_intention'
179
- | 'wire_drawdown_payment_rejection'
180
169
  | 'wire_transfer_intention'
181
170
  | 'wire_transfer_rejection'
182
171
  | 'other';
@@ -212,15 +201,10 @@ export declare namespace WireTransferSimulation {
212
201
  */
213
202
  check_transfer_stop_payment_request: Source.CheckTransferStopPaymentRequest | null;
214
203
  /**
215
- * A Dispute Resolution object. This field will be present in the JSON response if
216
- * and only if `category` is equal to `dispute_resolution`.
204
+ * A Fee Payment object. This field will be present in the JSON response if and
205
+ * only if `category` is equal to `fee_payment`.
217
206
  */
218
- dispute_resolution: Source.DisputeResolution | null;
219
- /**
220
- * A Empyreal Cash Deposit object. This field will be present in the JSON response
221
- * if and only if `category` is equal to `empyreal_cash_deposit`.
222
- */
223
- empyreal_cash_deposit: Source.EmpyrealCashDeposit | null;
207
+ fee_payment: Source.FeePayment | null;
224
208
  /**
225
209
  * A Inbound ACH Transfer object. This field will be present in the JSON response
226
210
  * if and only if `category` is equal to `inbound_ach_transfer`.
@@ -274,23 +258,17 @@ export declare namespace WireTransferSimulation {
274
258
  * only if `category` is equal to `internal_source`.
275
259
  */
276
260
  internal_source: Source.InternalSource | null;
261
+ /**
262
+ * A Real Time Payments Transfer Acknowledgement object. This field will be present
263
+ * in the JSON response if and only if `category` is equal to
264
+ * `real_time_payments_transfer_acknowledgement`.
265
+ */
266
+ real_time_payments_transfer_acknowledgement: Source.RealTimePaymentsTransferAcknowledgement | null;
277
267
  /**
278
268
  * A Sample Funds object. This field will be present in the JSON response if and
279
269
  * only if `category` is equal to `sample_funds`.
280
270
  */
281
271
  sample_funds: Source.SampleFunds | null;
282
- /**
283
- * A Wire Drawdown Payment Intention object. This field will be present in the JSON
284
- * response if and only if `category` is equal to
285
- * `wire_drawdown_payment_intention`.
286
- */
287
- wire_drawdown_payment_intention: Source.WireDrawdownPaymentIntention | null;
288
- /**
289
- * A Wire Drawdown Payment Rejection object. This field will be present in the JSON
290
- * response if and only if `category` is equal to
291
- * `wire_drawdown_payment_rejection`.
292
- */
293
- wire_drawdown_payment_rejection: Source.WireDrawdownPaymentRejection | null;
294
272
  /**
295
273
  * A Wire Transfer Intention object. This field will be present in the JSON
296
274
  * response if and only if `category` is equal to `wire_transfer_intention`.
@@ -303,6 +281,10 @@ export declare namespace WireTransferSimulation {
303
281
  wire_transfer_rejection: Source.WireTransferRejection | null;
304
282
  }
305
283
  namespace Source {
284
+ /**
285
+ * A Account Transfer Intention object. This field will be present in the JSON
286
+ * response if and only if `category` is equal to `account_transfer_intention`.
287
+ */
306
288
  interface AccountTransferIntention {
307
289
  /**
308
290
  * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -331,28 +313,10 @@ export declare namespace WireTransferSimulation {
331
313
  */
332
314
  transfer_id: string;
333
315
  }
334
- interface ACHCheckConversionReturn {
335
- /**
336
- * The amount in the minor unit of the transaction's currency. For dollars, for
337
- * example, this is cents.
338
- */
339
- amount: number;
340
- /**
341
- * Why the transfer was returned.
342
- */
343
- return_reason_code: string;
344
- }
345
- interface ACHCheckConversion {
346
- /**
347
- * The amount in the minor unit of the transaction's currency. For dollars, for
348
- * example, this is cents.
349
- */
350
- amount: number;
351
- /**
352
- * The identifier of the File containing an image of the returned check.
353
- */
354
- file_id: string;
355
- }
316
+ /**
317
+ * A ACH Transfer Intention object. This field will be present in the JSON response
318
+ * if and only if `category` is equal to `ach_transfer_intention`.
319
+ */
356
320
  interface ACHTransferIntention {
357
321
  account_number: string;
358
322
  /**
@@ -367,18 +331,30 @@ export declare namespace WireTransferSimulation {
367
331
  */
368
332
  transfer_id: string;
369
333
  }
334
+ /**
335
+ * A ACH Transfer Rejection object. This field will be present in the JSON response
336
+ * if and only if `category` is equal to `ach_transfer_rejection`.
337
+ */
370
338
  interface ACHTransferRejection {
371
339
  /**
372
340
  * The identifier of the ACH Transfer that led to this Transaction.
373
341
  */
374
342
  transfer_id: string;
375
343
  }
344
+ /**
345
+ * A ACH Transfer Return object. This field will be present in the JSON response if
346
+ * and only if `category` is equal to `ach_transfer_return`.
347
+ */
376
348
  interface ACHTransferReturn {
377
349
  /**
378
350
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
379
351
  * the transfer was created.
380
352
  */
381
353
  created_at: string;
354
+ /**
355
+ * The three character ACH return code, in the range R01 to R85.
356
+ */
357
+ raw_return_reason_code: string;
382
358
  /**
383
359
  * Why the ACH Transfer was returned.
384
360
  */
@@ -402,10 +378,58 @@ export declare namespace WireTransferSimulation {
402
378
  | 'file_record_edit_criteria'
403
379
  | 'enr_invalid_individual_name'
404
380
  | 'returned_per_odfi_request'
405
- | 'addenda_error'
406
381
  | 'limited_participation_dfi'
407
382
  | 'incorrectly_coded_outbound_international_payment'
408
- | 'other';
383
+ | 'other'
384
+ | 'account_sold_to_another_dfi'
385
+ | 'addenda_error'
386
+ | 'beneficiary_or_account_holder_deceased'
387
+ | 'customer_advised_not_within_authorization_terms'
388
+ | 'corrected_return'
389
+ | 'duplicate_entry'
390
+ | 'duplicate_return'
391
+ | 'enr_duplicate_enrollment'
392
+ | 'enr_invalid_dfi_account_number'
393
+ | 'enr_invalid_individual_id_number'
394
+ | 'enr_invalid_representative_payee_indicator'
395
+ | 'enr_invalid_transaction_code'
396
+ | 'enr_return_of_enr_entry'
397
+ | 'enr_routing_number_check_digit_error'
398
+ | 'entry_not_processed_by_gateway'
399
+ | 'field_error'
400
+ | 'foreign_receiving_dfi_unable_to_settle'
401
+ | 'iat_entry_coding_error'
402
+ | 'improper_effective_entry_date'
403
+ | 'improper_source_document_source_document_presented'
404
+ | 'invalid_company_id'
405
+ | 'invalid_foreign_receiving_dfi_identification'
406
+ | 'invalid_individual_id_number'
407
+ | 'item_and_rck_entry_presented_for_payment'
408
+ | 'item_related_to_rck_entry_is_ineligible'
409
+ | 'mandatory_field_error'
410
+ | 'misrouted_dishonored_return'
411
+ | 'misrouted_return'
412
+ | 'no_errors_found'
413
+ | 'non_acceptance_of_r62_dishonored_return'
414
+ | 'non_participant_in_iat_program'
415
+ | 'permissible_return_entry'
416
+ | 'permissible_return_entry_not_accepted'
417
+ | 'rdfi_non_settlement'
418
+ | 'rdfi_participant_in_check_truncation_program'
419
+ | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
420
+ | 'return_not_a_duplicate'
421
+ | 'return_of_erroneous_or_reversing_debit'
422
+ | 'return_of_improper_credit_entry'
423
+ | 'return_of_improper_debit_entry'
424
+ | 'return_of_xck_entry'
425
+ | 'source_document_presented_for_payment'
426
+ | 'state_law_affecting_rck_acceptance'
427
+ | 'stop_payment_on_item_related_to_rck_entry'
428
+ | 'stop_payment_on_source_document'
429
+ | 'timely_original_return'
430
+ | 'trace_number_error'
431
+ | 'untimely_dishonored_return'
432
+ | 'untimely_return';
409
433
  /**
410
434
  * The identifier of the Tranasaction associated with this return.
411
435
  */
@@ -415,6 +439,10 @@ export declare namespace WireTransferSimulation {
415
439
  */
416
440
  transfer_id: string;
417
441
  }
442
+ /**
443
+ * A Card Dispute Acceptance object. This field will be present in the JSON
444
+ * response if and only if `category` is equal to `card_dispute_acceptance`.
445
+ */
418
446
  interface CardDisputeAcceptance {
419
447
  /**
420
448
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -429,44 +457,106 @@ export declare namespace WireTransferSimulation {
429
457
  * The identifier of the Transaction that was created to return the disputed funds
430
458
  * to your account.
431
459
  */
432
- transaction_id: string | null;
460
+ transaction_id: string;
433
461
  }
462
+ /**
463
+ * A Card Refund object. This field will be present in the JSON response if and
464
+ * only if `category` is equal to `card_refund`.
465
+ */
434
466
  interface CardRefund {
435
467
  /**
436
468
  * The pending amount in the minor unit of the transaction's currency. For dollars,
437
469
  * for example, this is cents.
438
470
  */
439
471
  amount: number;
440
- /**
441
- * The identifier for the Transaction this refunds, if any.
442
- */
443
- card_settlement_transaction_id: string | null;
444
472
  /**
445
473
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
446
474
  * transaction's currency.
447
475
  */
448
476
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
477
+ /**
478
+ * The Card Refund identifier.
479
+ */
480
+ id: string;
481
+ /**
482
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
483
+ * is transacting with.
484
+ */
485
+ merchant_acceptor_id: string | null;
486
+ /**
487
+ * The 4-digit MCC describing the merchant's business.
488
+ */
489
+ merchant_category_code: string;
490
+ /**
491
+ * The city the merchant resides in.
492
+ */
493
+ merchant_city: string | null;
494
+ /**
495
+ * The country the merchant resides in.
496
+ */
497
+ merchant_country: string;
498
+ /**
499
+ * The name of the merchant.
500
+ */
501
+ merchant_name: string | null;
502
+ /**
503
+ * The state the merchant resides in.
504
+ */
505
+ merchant_state: string | null;
449
506
  /**
450
507
  * A constant representing the object's type. For this resource it will always be
451
508
  * `card_refund`.
452
509
  */
453
510
  type: 'card_refund';
454
511
  }
512
+ /**
513
+ * A Card Settlement object. This field will be present in the JSON response if and
514
+ * only if `category` is equal to `card_settlement`.
515
+ */
455
516
  interface CardSettlement {
456
517
  /**
457
518
  * The amount in the minor unit of the transaction's settlement currency. For
458
519
  * dollars, for example, this is cents.
459
520
  */
460
521
  amount: number;
522
+ /**
523
+ * The Card Authorization that was created prior to this Card Settlement, if on
524
+ * exists.
525
+ */
526
+ card_authorization: string | null;
461
527
  /**
462
528
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
463
529
  * transaction's settlement currency.
464
530
  */
465
531
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
532
+ /**
533
+ * The Card Settlement identifier.
534
+ */
535
+ id: string;
536
+ /**
537
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
538
+ * is transacting with.
539
+ */
540
+ merchant_acceptor_id: string | null;
541
+ /**
542
+ * The 4-digit MCC describing the merchant's business.
543
+ */
466
544
  merchant_category_code: string;
545
+ /**
546
+ * The city the merchant resides in.
547
+ */
467
548
  merchant_city: string | null;
549
+ /**
550
+ * The country the merchant resides in.
551
+ */
468
552
  merchant_country: string;
553
+ /**
554
+ * The name of the merchant.
555
+ */
469
556
  merchant_name: string | null;
557
+ /**
558
+ * The state the merchant resides in.
559
+ */
470
560
  merchant_state: string | null;
471
561
  /**
472
562
  * The identifier of the Pending Transaction associated with this Transaction.
@@ -487,6 +577,38 @@ export declare namespace WireTransferSimulation {
487
577
  */
488
578
  type: 'card_settlement';
489
579
  }
580
+ /**
581
+ * A Card Revenue Payment object. This field will be present in the JSON response
582
+ * if and only if `category` is equal to `card_revenue_payment`.
583
+ */
584
+ interface CardRevenuePayment {
585
+ /**
586
+ * The amount in the minor unit of the transaction's currency. For dollars, for
587
+ * example, this is cents.
588
+ */
589
+ amount: number;
590
+ /**
591
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
592
+ * currency.
593
+ */
594
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
595
+ /**
596
+ * The end of the period for which this transaction paid interest.
597
+ */
598
+ period_end: string;
599
+ /**
600
+ * The start of the period for which this transaction paid interest.
601
+ */
602
+ period_start: string;
603
+ /**
604
+ * The account the card belonged to.
605
+ */
606
+ transacted_on_account_id: string | null;
607
+ }
608
+ /**
609
+ * A Check Deposit Acceptance object. This field will be present in the JSON
610
+ * response if and only if `category` is equal to `check_deposit_acceptance`.
611
+ */
490
612
  interface CheckDepositAcceptance {
491
613
  /**
492
614
  * The account number printed on the check.
@@ -521,6 +643,10 @@ export declare namespace WireTransferSimulation {
521
643
  */
522
644
  serial_number: string | null;
523
645
  }
646
+ /**
647
+ * A Check Deposit Return object. This field will be present in the JSON response
648
+ * if and only if `category` is equal to `check_deposit_return`.
649
+ */
524
650
  interface CheckDepositReturn {
525
651
  /**
526
652
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -547,7 +673,8 @@ export declare namespace WireTransferSimulation {
547
673
  | 'stop_payment'
548
674
  | 'unknown_reason'
549
675
  | 'unmatched_details'
550
- | 'unreadable_image';
676
+ | 'unreadable_image'
677
+ | 'endorsement_irregular';
551
678
  /**
552
679
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
553
680
  * the check deposit was returned.
@@ -559,6 +686,10 @@ export declare namespace WireTransferSimulation {
559
686
  */
560
687
  transaction_id: string;
561
688
  }
689
+ /**
690
+ * A Check Transfer Intention object. This field will be present in the JSON
691
+ * response if and only if `category` is equal to `check_transfer_intention`.
692
+ */
562
693
  interface CheckTransferIntention {
563
694
  /**
564
695
  * The city of the check's destination.
@@ -598,22 +729,49 @@ export declare namespace WireTransferSimulation {
598
729
  */
599
730
  transfer_id: string;
600
731
  }
732
+ /**
733
+ * A Check Transfer Return object. This field will be present in the JSON response
734
+ * if and only if `category` is equal to `check_transfer_return`.
735
+ */
601
736
  interface CheckTransferReturn {
602
737
  /**
603
738
  * If available, a document with additional information about the return.
604
739
  */
605
740
  file_id: string | null;
741
+ /**
742
+ * The reason why the check was returned.
743
+ */
744
+ reason: 'mail_delivery_failure' | 'refused_by_recipient' | 'returned_not_authorized';
745
+ /**
746
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
747
+ * the check was returned.
748
+ */
749
+ returned_at: string;
750
+ /**
751
+ * The identifier of the Transaction that was created to credit you for the
752
+ * returned check.
753
+ */
754
+ transaction_id: string | null;
606
755
  /**
607
756
  * The identifier of the returned Check Transfer.
608
757
  */
609
758
  transfer_id: string;
610
759
  }
760
+ /**
761
+ * A Check Transfer Rejection object. This field will be present in the JSON
762
+ * response if and only if `category` is equal to `check_transfer_rejection`.
763
+ */
611
764
  interface CheckTransferRejection {
612
765
  /**
613
766
  * The identifier of the Check Transfer that led to this Transaction.
614
767
  */
615
768
  transfer_id: string;
616
769
  }
770
+ /**
771
+ * A Check Transfer Stop Payment Request object. This field will be present in the
772
+ * JSON response if and only if `category` is equal to
773
+ * `check_transfer_stop_payment_request`.
774
+ */
617
775
  interface CheckTransferStopPaymentRequest {
618
776
  /**
619
777
  * The time the stop-payment was requested.
@@ -633,31 +791,26 @@ export declare namespace WireTransferSimulation {
633
791
  */
634
792
  type: 'check_transfer_stop_payment_request';
635
793
  }
636
- interface DisputeResolution {
794
+ /**
795
+ * A Fee Payment object. This field will be present in the JSON response if and
796
+ * only if `category` is equal to `fee_payment`.
797
+ */
798
+ interface FeePayment {
637
799
  /**
638
800
  * The amount in the minor unit of the transaction's currency. For dollars, for
639
801
  * example, this is cents.
640
802
  */
641
803
  amount: number;
642
804
  /**
643
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
644
- * transaction's currency.
805
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
806
+ * currency.
645
807
  */
646
808
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
647
- /**
648
- * The identifier of the Transaction that was disputed.
649
- */
650
- disputed_transaction_id: string;
651
- }
652
- interface EmpyrealCashDeposit {
653
- /**
654
- * The amount in the minor unit of the transaction's currency. For dollars, for
655
- * example, this is cents.
656
- */
657
- amount: number;
658
- bag_id: string;
659
- deposit_date: string;
660
809
  }
810
+ /**
811
+ * A Inbound ACH Transfer object. This field will be present in the JSON response
812
+ * if and only if `category` is equal to `inbound_ach_transfer`.
813
+ */
661
814
  interface InboundACHTransfer {
662
815
  /**
663
816
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -673,6 +826,10 @@ export declare namespace WireTransferSimulation {
673
826
  receiver_name: string | null;
674
827
  trace_number: string;
675
828
  }
829
+ /**
830
+ * A Inbound Check object. This field will be present in the JSON response if and
831
+ * only if `category` is equal to `inbound_check`.
832
+ */
676
833
  interface InboundCheck {
677
834
  /**
678
835
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -688,6 +845,11 @@ export declare namespace WireTransferSimulation {
688
845
  */
689
846
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
690
847
  }
848
+ /**
849
+ * A Inbound International ACH Transfer object. This field will be present in the
850
+ * JSON response if and only if `category` is equal to
851
+ * `inbound_international_ach_transfer`.
852
+ */
691
853
  interface InboundInternationalACHTransfer {
692
854
  /**
693
855
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -730,6 +892,11 @@ export declare namespace WireTransferSimulation {
730
892
  receiving_depository_financial_institution_name: string;
731
893
  trace_number: string;
732
894
  }
895
+ /**
896
+ * A Inbound Real Time Payments Transfer Confirmation object. This field will be
897
+ * present in the JSON response if and only if `category` is equal to
898
+ * `inbound_real_time_payments_transfer_confirmation`.
899
+ */
733
900
  interface InboundRealTimePaymentsTransferConfirmation {
734
901
  /**
735
902
  * The amount in the minor unit of the transfer's currency. For dollars, for
@@ -766,6 +933,11 @@ export declare namespace WireTransferSimulation {
766
933
  */
767
934
  transaction_identification: string;
768
935
  }
936
+ /**
937
+ * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
938
+ * the JSON response if and only if `category` is equal to
939
+ * `inbound_wire_drawdown_payment_reversal`.
940
+ */
769
941
  interface InboundWireDrawdownPaymentReversal {
770
942
  /**
771
943
  * The amount that was reversed.
@@ -808,6 +980,10 @@ export declare namespace WireTransferSimulation {
808
980
  */
809
981
  previous_message_input_source: string;
810
982
  }
983
+ /**
984
+ * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
985
+ * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
986
+ */
811
987
  interface InboundWireDrawdownPayment {
812
988
  /**
813
989
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -827,11 +1003,20 @@ export declare namespace WireTransferSimulation {
827
1003
  originator_name: string | null;
828
1004
  originator_to_beneficiary_information: string | null;
829
1005
  }
1006
+ /**
1007
+ * A Inbound Wire Reversal object. This field will be present in the JSON response
1008
+ * if and only if `category` is equal to `inbound_wire_reversal`.
1009
+ */
830
1010
  interface InboundWireReversal {
831
1011
  /**
832
1012
  * The amount that was reversed.
833
1013
  */
834
1014
  amount: number;
1015
+ /**
1016
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1017
+ * the reversal was created.
1018
+ */
1019
+ created_at: string;
835
1020
  /**
836
1021
  * The description on the reversal message from Fedwire.
837
1022
  */
@@ -877,7 +1062,19 @@ export declare namespace WireTransferSimulation {
877
1062
  * institution.
878
1063
  */
879
1064
  receiver_financial_institution_information: string | null;
1065
+ /**
1066
+ * The ID for the Transaction associated with the transfer reversal.
1067
+ */
1068
+ transaction_id: string | null;
1069
+ /**
1070
+ * The ID for the Wire Transfer that is being reversed.
1071
+ */
1072
+ wire_transfer_id: string;
880
1073
  }
1074
+ /**
1075
+ * A Inbound Wire Transfer object. This field will be present in the JSON response
1076
+ * if and only if `category` is equal to `inbound_wire_transfer`.
1077
+ */
881
1078
  interface InboundWireTransfer {
882
1079
  /**
883
1080
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -901,6 +1098,10 @@ export declare namespace WireTransferSimulation {
901
1098
  originator_to_beneficiary_information_line3: string | null;
902
1099
  originator_to_beneficiary_information_line4: string | null;
903
1100
  }
1101
+ /**
1102
+ * A Interest Payment object. This field will be present in the JSON response if
1103
+ * and only if `category` is equal to `interest_payment`.
1104
+ */
904
1105
  interface InterestPayment {
905
1106
  /**
906
1107
  * The account on which the interest was accrued.
@@ -925,6 +1126,10 @@ export declare namespace WireTransferSimulation {
925
1126
  */
926
1127
  period_start: string;
927
1128
  }
1129
+ /**
1130
+ * A Internal Source object. This field will be present in the JSON response if and
1131
+ * only if `category` is equal to `internal_source`.
1132
+ */
928
1133
  interface InternalSource {
929
1134
  /**
930
1135
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -937,71 +1142,60 @@ export declare namespace WireTransferSimulation {
937
1142
  */
938
1143
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
939
1144
  reason:
1145
+ | 'account_closure'
940
1146
  | 'bank_migration'
941
1147
  | 'cashback'
1148
+ | 'collection_receivable'
942
1149
  | 'empyreal_adjustment'
943
1150
  | 'error'
944
1151
  | 'error_correction'
945
1152
  | 'fees'
946
1153
  | 'interest'
1154
+ | 'negative_balance_forgiveness'
947
1155
  | 'sample_funds'
948
1156
  | 'sample_funds_return';
949
1157
  }
950
- interface CardRouteRefund {
1158
+ /**
1159
+ * A Real Time Payments Transfer Acknowledgement object. This field will be present
1160
+ * in the JSON response if and only if `category` is equal to
1161
+ * `real_time_payments_transfer_acknowledgement`.
1162
+ */
1163
+ interface RealTimePaymentsTransferAcknowledgement {
951
1164
  /**
952
- * The refunded amount in the minor unit of the refunded currency. For dollars, for
953
- * example, this is cents.
1165
+ * The transfer amount in USD cents.
954
1166
  */
955
1167
  amount: number;
956
1168
  /**
957
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the refund
958
- * currency.
1169
+ * The destination account number.
959
1170
  */
960
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
961
- merchant_acceptor_id: string;
962
- merchant_category_code: string | null;
963
- merchant_city: string | null;
964
- merchant_country: string;
965
- merchant_descriptor: string;
966
- merchant_state: string | null;
967
- }
968
- interface CardRouteSettlement {
1171
+ destination_account_number: string;
969
1172
  /**
970
- * The settled amount in the minor unit of the settlement currency. For dollars,
971
- * for example, this is cents.
1173
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN).
972
1174
  */
973
- amount: number;
1175
+ destination_routing_number: string;
974
1176
  /**
975
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the settlement
976
- * currency.
1177
+ * Unstructured information that will show on the recipient's bank statement.
977
1178
  */
978
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
979
- merchant_acceptor_id: string;
980
- merchant_category_code: string | null;
981
- merchant_city: string | null;
982
- merchant_country: string | null;
983
- merchant_descriptor: string;
984
- merchant_state: string | null;
1179
+ remittance_information: string;
1180
+ /**
1181
+ * The identifier of the Real Time Payments Transfer that led to this Transaction.
1182
+ */
1183
+ transfer_id: string;
985
1184
  }
1185
+ /**
1186
+ * A Sample Funds object. This field will be present in the JSON response if and
1187
+ * only if `category` is equal to `sample_funds`.
1188
+ */
986
1189
  interface SampleFunds {
987
1190
  /**
988
1191
  * Where the sample funds came from.
989
1192
  */
990
1193
  originator: string;
991
1194
  }
992
- interface WireDrawdownPaymentIntention {
993
- account_number: string;
994
- /**
995
- * The transfer amount in USD cents.
996
- */
997
- amount: number;
998
- message_to_recipient: string;
999
- routing_number: string;
1000
- transfer_id: string;
1001
- }
1002
- interface WireDrawdownPaymentRejection {
1003
- transfer_id: string;
1004
- }
1195
+ /**
1196
+ * A Wire Transfer Intention object. This field will be present in the JSON
1197
+ * response if and only if `category` is equal to `wire_transfer_intention`.
1198
+ */
1005
1199
  interface WireTransferIntention {
1006
1200
  /**
1007
1201
  * The destination account number.
@@ -1021,6 +1215,10 @@ export declare namespace WireTransferSimulation {
1021
1215
  routing_number: string;
1022
1216
  transfer_id: string;
1023
1217
  }
1218
+ /**
1219
+ * A Wire Transfer Rejection object. This field will be present in the JSON
1220
+ * response if and only if `category` is equal to `wire_transfer_rejection`.
1221
+ */
1024
1222
  interface WireTransferRejection {
1025
1223
  transfer_id: string;
1026
1224
  }
@@ -1102,3 +1300,4 @@ export interface WireTransferCreateInboundParams {
1102
1300
  */
1103
1301
  originator_to_beneficiary_information_line4?: string;
1104
1302
  }
1303
+ //# sourceMappingURL=wire-transfers.d.ts.map