increase 0.2.0 → 0.3.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 (538) hide show
  1. package/.github/workflows/publish-npm.yml +28 -0
  2. package/.github/workflows/release-doctor.yml +20 -0
  3. package/.github/workflows/release.yml +38 -0
  4. package/.prettierignore +1 -0
  5. package/.release-please-manifest.json +3 -0
  6. package/.stats.yml +1 -1
  7. package/CHANGELOG.md +84 -0
  8. package/README.md +16 -1
  9. package/api.md +88 -0
  10. package/bin/check-release-environment +25 -0
  11. package/bin/publish-npm +6 -0
  12. package/check-version.ts +4 -1
  13. package/core.ts +56 -14
  14. package/dist/cjs/check-version.d.ts +1 -0
  15. package/dist/cjs/check-version.d.ts.map +1 -0
  16. package/dist/cjs/check-version.js +3 -1
  17. package/dist/cjs/check-version.js.map +1 -1
  18. package/dist/cjs/core.d.ts +22 -2
  19. package/dist/cjs/core.d.ts.map +1 -0
  20. package/dist/cjs/core.js +58 -16
  21. package/dist/cjs/core.js.map +1 -1
  22. package/dist/cjs/error.d.ts +163 -0
  23. package/dist/cjs/error.d.ts.map +1 -0
  24. package/dist/cjs/error.js +204 -0
  25. package/dist/cjs/error.js.map +1 -0
  26. package/dist/cjs/examples/api-error.d.ts +3 -0
  27. package/dist/cjs/examples/api-error.d.ts.map +1 -0
  28. package/dist/cjs/examples/api-error.js +92 -0
  29. package/dist/cjs/examples/api-error.js.map +1 -0
  30. package/dist/cjs/fetch-polyfill.d.ts +1 -0
  31. package/dist/cjs/fetch-polyfill.d.ts.map +1 -0
  32. package/dist/cjs/fetch-polyfill.js +2 -2
  33. package/dist/cjs/fetch-polyfill.js.map +1 -1
  34. package/dist/cjs/index.d.ts +65 -3
  35. package/dist/cjs/index.d.ts.map +1 -0
  36. package/dist/cjs/index.js +104 -3
  37. package/dist/cjs/index.js.map +1 -1
  38. package/dist/cjs/pagination.d.ts +4 -0
  39. package/dist/cjs/pagination.d.ts.map +1 -0
  40. package/dist/cjs/pagination.js.map +1 -1
  41. package/dist/cjs/resource.d.ts +1 -0
  42. package/dist/cjs/resource.d.ts.map +1 -0
  43. package/dist/cjs/resources/account-numbers.d.ts +45 -0
  44. package/dist/cjs/resources/account-numbers.d.ts.map +1 -0
  45. package/dist/cjs/resources/account-numbers.js.map +1 -1
  46. package/dist/cjs/resources/account-statements.d.ts +21 -1
  47. package/dist/cjs/resources/account-statements.d.ts.map +1 -0
  48. package/dist/cjs/resources/account-statements.js.map +1 -1
  49. package/dist/cjs/resources/account-transfers.d.ts +40 -12
  50. package/dist/cjs/resources/account-transfers.d.ts.map +1 -0
  51. package/dist/cjs/resources/account-transfers.js.map +1 -1
  52. package/dist/cjs/resources/accounts.d.ts +53 -23
  53. package/dist/cjs/resources/accounts.d.ts.map +1 -0
  54. package/dist/cjs/resources/accounts.js.map +1 -1
  55. package/dist/cjs/resources/ach-prenotifications.d.ts +29 -6
  56. package/dist/cjs/resources/ach-prenotifications.d.ts.map +1 -0
  57. package/dist/cjs/resources/ach-prenotifications.js.map +1 -1
  58. package/dist/cjs/resources/ach-transfers.d.ts +70 -23
  59. package/dist/cjs/resources/ach-transfers.d.ts.map +1 -0
  60. package/dist/cjs/resources/ach-transfers.js.map +1 -1
  61. package/dist/cjs/resources/balance-lookups.d.ts +47 -0
  62. package/dist/cjs/resources/balance-lookups.d.ts.map +1 -0
  63. package/dist/cjs/resources/balance-lookups.js +15 -0
  64. package/dist/cjs/resources/balance-lookups.js.map +1 -0
  65. package/dist/cjs/resources/bookkeeping-accounts.d.ts +71 -0
  66. package/dist/cjs/resources/bookkeeping-accounts.d.ts.map +1 -0
  67. package/dist/cjs/resources/bookkeeping-accounts.js +29 -0
  68. package/dist/cjs/resources/bookkeeping-accounts.js.map +1 -0
  69. package/dist/cjs/resources/bookkeeping-entries.d.ts +43 -0
  70. package/dist/cjs/resources/bookkeeping-entries.d.ts.map +1 -0
  71. package/dist/cjs/resources/bookkeeping-entries.js +19 -0
  72. package/dist/cjs/resources/bookkeeping-entries.js.map +1 -0
  73. package/dist/cjs/resources/bookkeeping-entry-sets.d.ts +95 -0
  74. package/dist/cjs/resources/bookkeeping-entry-sets.d.ts.map +1 -0
  75. package/dist/cjs/resources/bookkeeping-entry-sets.js +15 -0
  76. package/dist/cjs/resources/bookkeeping-entry-sets.js.map +1 -0
  77. package/dist/cjs/resources/card-disputes.d.ts +39 -5
  78. package/dist/cjs/resources/card-disputes.d.ts.map +1 -0
  79. package/dist/cjs/resources/card-disputes.js.map +1 -1
  80. package/dist/cjs/resources/card-profiles.d.ts +81 -3
  81. package/dist/cjs/resources/card-profiles.d.ts.map +1 -0
  82. package/dist/cjs/resources/card-profiles.js.map +1 -1
  83. package/dist/cjs/resources/cards.d.ts +147 -3
  84. package/dist/cjs/resources/cards.d.ts.map +1 -0
  85. package/dist/cjs/resources/cards.js.map +1 -1
  86. package/dist/cjs/resources/check-deposits.d.ts +34 -1
  87. package/dist/cjs/resources/check-deposits.d.ts.map +1 -0
  88. package/dist/cjs/resources/check-deposits.js.map +1 -1
  89. package/dist/cjs/resources/check-transfers.d.ts +161 -14
  90. package/dist/cjs/resources/check-transfers.d.ts.map +1 -0
  91. package/dist/cjs/resources/check-transfers.js.map +1 -1
  92. package/dist/cjs/resources/declined-transactions.d.ts +116 -8
  93. package/dist/cjs/resources/declined-transactions.d.ts.map +1 -0
  94. package/dist/cjs/resources/declined-transactions.js.map +1 -1
  95. package/dist/cjs/resources/digital-wallet-tokens.d.ts +21 -1
  96. package/dist/cjs/resources/digital-wallet-tokens.d.ts.map +1 -0
  97. package/dist/cjs/resources/digital-wallet-tokens.js.map +1 -1
  98. package/dist/cjs/resources/documents.d.ts +181 -6
  99. package/dist/cjs/resources/documents.d.ts.map +1 -0
  100. package/dist/cjs/resources/documents.js.map +1 -1
  101. package/dist/cjs/resources/entities/entities.d.ts +1177 -10
  102. package/dist/cjs/resources/entities/entities.d.ts.map +1 -0
  103. package/dist/cjs/resources/entities/entities.js +1 -1
  104. package/dist/cjs/resources/entities/entities.js.map +1 -1
  105. package/dist/cjs/resources/entities/index.d.ts +1 -0
  106. package/dist/cjs/resources/entities/index.d.ts.map +1 -0
  107. package/dist/cjs/resources/entities/supplemental-documents.d.ts +1 -0
  108. package/dist/cjs/resources/entities/supplemental-documents.d.ts.map +1 -0
  109. package/dist/cjs/resources/event-subscriptions.d.ts +9 -4
  110. package/dist/cjs/resources/event-subscriptions.d.ts.map +1 -0
  111. package/dist/cjs/resources/event-subscriptions.js.map +1 -1
  112. package/dist/cjs/resources/events.d.ts +85 -4
  113. package/dist/cjs/resources/events.d.ts.map +1 -0
  114. package/dist/cjs/resources/events.js.map +1 -1
  115. package/dist/cjs/resources/exports.d.ts +244 -0
  116. package/dist/cjs/resources/exports.d.ts.map +1 -0
  117. package/dist/cjs/resources/exports.js +31 -0
  118. package/dist/cjs/resources/exports.js.map +1 -0
  119. package/dist/cjs/resources/external-accounts.d.ts +14 -7
  120. package/dist/cjs/resources/external-accounts.d.ts.map +1 -0
  121. package/dist/cjs/resources/external-accounts.js.map +1 -1
  122. package/dist/cjs/resources/files.d.ts +53 -10
  123. package/dist/cjs/resources/files.d.ts.map +1 -0
  124. package/dist/cjs/resources/files.js.map +1 -1
  125. package/dist/cjs/resources/groups.d.ts +1 -0
  126. package/dist/cjs/resources/groups.d.ts.map +1 -0
  127. package/dist/cjs/resources/inbound-ach-transfer-returns.d.ts +4 -0
  128. package/dist/cjs/resources/inbound-ach-transfer-returns.d.ts.map +1 -0
  129. package/dist/cjs/resources/inbound-ach-transfer-returns.js.map +1 -1
  130. package/dist/cjs/resources/inbound-wire-drawdown-requests.d.ts +1 -0
  131. package/dist/cjs/resources/inbound-wire-drawdown-requests.d.ts.map +1 -0
  132. package/dist/cjs/resources/inbound-wire-drawdown-requests.js.map +1 -1
  133. package/dist/cjs/resources/index.d.ts +29 -0
  134. package/dist/cjs/resources/index.d.ts.map +1 -0
  135. package/dist/cjs/resources/index.js +100 -9
  136. package/dist/cjs/resources/index.js.map +1 -1
  137. package/dist/cjs/resources/limits.d.ts +5 -4
  138. package/dist/cjs/resources/limits.d.ts.map +1 -0
  139. package/dist/cjs/resources/limits.js.map +1 -1
  140. package/dist/cjs/resources/oauth-connections.d.ts +1 -0
  141. package/dist/cjs/resources/oauth-connections.d.ts.map +1 -0
  142. package/dist/cjs/resources/oauth-connections.js.map +1 -1
  143. package/dist/cjs/resources/pending-transactions.d.ts +160 -6
  144. package/dist/cjs/resources/pending-transactions.d.ts.map +1 -0
  145. package/dist/cjs/resources/pending-transactions.js.map +1 -1
  146. package/dist/cjs/resources/programs.d.ts +48 -0
  147. package/dist/cjs/resources/programs.d.ts.map +1 -0
  148. package/dist/cjs/resources/programs.js +25 -0
  149. package/dist/cjs/resources/programs.js.map +1 -0
  150. package/dist/cjs/resources/real-time-decisions.d.ts +106 -1
  151. package/dist/cjs/resources/real-time-decisions.d.ts.map +1 -0
  152. package/dist/cjs/resources/real-time-payments-transfers.d.ts +306 -0
  153. package/dist/cjs/resources/real-time-payments-transfers.d.ts.map +1 -0
  154. package/dist/cjs/resources/real-time-payments-transfers.js +35 -0
  155. package/dist/cjs/resources/real-time-payments-transfers.js.map +1 -0
  156. package/dist/cjs/resources/routing-numbers.d.ts +1 -0
  157. package/dist/cjs/resources/routing-numbers.d.ts.map +1 -0
  158. package/dist/cjs/resources/shared.d.ts +1 -0
  159. package/dist/cjs/resources/shared.d.ts.map +1 -0
  160. package/dist/cjs/resources/simulations/account-statements.d.ts +1 -0
  161. package/dist/cjs/resources/simulations/account-statements.d.ts.map +1 -0
  162. package/dist/cjs/resources/simulations/account-transfers.d.ts +1 -0
  163. package/dist/cjs/resources/simulations/account-transfers.d.ts.map +1 -0
  164. package/dist/cjs/resources/simulations/ach-transfers.d.ts +431 -12
  165. package/dist/cjs/resources/simulations/ach-transfers.d.ts.map +1 -0
  166. package/dist/cjs/resources/simulations/card-disputes.d.ts +5 -4
  167. package/dist/cjs/resources/simulations/card-disputes.d.ts.map +1 -0
  168. package/dist/cjs/resources/simulations/card-refunds.d.ts +1 -0
  169. package/dist/cjs/resources/simulations/card-refunds.d.ts.map +1 -0
  170. package/dist/cjs/resources/simulations/cards.d.ts +222 -13
  171. package/dist/cjs/resources/simulations/cards.d.ts.map +1 -0
  172. package/dist/cjs/resources/simulations/check-deposits.d.ts +1 -0
  173. package/dist/cjs/resources/simulations/check-deposits.d.ts.map +1 -0
  174. package/dist/cjs/resources/simulations/check-transfers.d.ts +16 -0
  175. package/dist/cjs/resources/simulations/check-transfers.d.ts.map +1 -0
  176. package/dist/cjs/resources/simulations/check-transfers.js +10 -0
  177. package/dist/cjs/resources/simulations/check-transfers.js.map +1 -1
  178. package/dist/cjs/resources/simulations/digital-wallet-token-requests.d.ts +1 -0
  179. package/dist/cjs/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -0
  180. package/dist/cjs/resources/simulations/documents.d.ts +1 -0
  181. package/dist/cjs/resources/simulations/documents.d.ts.map +1 -0
  182. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.d.ts +26 -25
  183. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -0
  184. package/dist/cjs/resources/simulations/index.d.ts +4 -0
  185. package/dist/cjs/resources/simulations/index.d.ts.map +1 -0
  186. package/dist/cjs/resources/simulations/interest-payments.d.ts +1364 -0
  187. package/dist/cjs/resources/simulations/interest-payments.d.ts.map +1 -0
  188. package/dist/cjs/resources/simulations/interest-payments.js +16 -0
  189. package/dist/cjs/resources/simulations/interest-payments.js.map +1 -0
  190. package/dist/cjs/resources/simulations/real-time-payments-transfers.d.ts +511 -12
  191. package/dist/cjs/resources/simulations/real-time-payments-transfers.d.ts.map +1 -0
  192. package/dist/cjs/resources/simulations/real-time-payments-transfers.js +11 -0
  193. package/dist/cjs/resources/simulations/real-time-payments-transfers.js.map +1 -1
  194. package/dist/cjs/resources/simulations/simulations.d.ts +3 -0
  195. package/dist/cjs/resources/simulations/simulations.d.ts.map +1 -0
  196. package/dist/cjs/resources/simulations/simulations.js +2 -0
  197. package/dist/cjs/resources/simulations/simulations.js.map +1 -1
  198. package/dist/cjs/resources/simulations/wire-transfers.d.ts +332 -6
  199. package/dist/cjs/resources/simulations/wire-transfers.d.ts.map +1 -0
  200. package/dist/cjs/resources/transactions.d.ts +397 -9
  201. package/dist/cjs/resources/transactions.d.ts.map +1 -0
  202. package/dist/cjs/resources/transactions.js.map +1 -1
  203. package/dist/cjs/resources/wire-drawdown-requests.d.ts +13 -8
  204. package/dist/cjs/resources/wire-drawdown-requests.d.ts.map +1 -0
  205. package/dist/cjs/resources/wire-drawdown-requests.js.map +1 -1
  206. package/dist/cjs/resources/wire-transfers.d.ts +71 -17
  207. package/dist/cjs/resources/wire-transfers.d.ts.map +1 -0
  208. package/dist/cjs/resources/wire-transfers.js.map +1 -1
  209. package/dist/cjs/tests/api-resources/account-numbers.test.d.ts +1 -0
  210. package/dist/cjs/tests/api-resources/account-numbers.test.d.ts.map +1 -0
  211. package/dist/cjs/tests/api-resources/account-numbers.test.js +24 -26
  212. package/dist/cjs/tests/api-resources/account-numbers.test.js.map +1 -1
  213. package/dist/cjs/tests/api-resources/account-statements.test.d.ts +1 -0
  214. package/dist/cjs/tests/api-resources/account-statements.test.d.ts.map +1 -0
  215. package/dist/cjs/tests/api-resources/account-statements.test.js +11 -26
  216. package/dist/cjs/tests/api-resources/account-statements.test.js.map +1 -1
  217. package/dist/cjs/tests/api-resources/account-transfers.test.d.ts +1 -0
  218. package/dist/cjs/tests/api-resources/account-transfers.test.d.ts.map +1 -0
  219. package/dist/cjs/tests/api-resources/account-transfers.test.js +20 -34
  220. package/dist/cjs/tests/api-resources/account-transfers.test.js.map +1 -1
  221. package/dist/cjs/tests/api-resources/accounts.test.d.ts +1 -0
  222. package/dist/cjs/tests/api-resources/accounts.test.d.ts.map +1 -0
  223. package/dist/cjs/tests/api-resources/accounts.test.js +25 -24
  224. package/dist/cjs/tests/api-resources/accounts.test.js.map +1 -1
  225. package/dist/cjs/tests/api-resources/ach-prenotifications.test.d.ts +1 -0
  226. package/dist/cjs/tests/api-resources/ach-prenotifications.test.d.ts.map +1 -0
  227. package/dist/cjs/tests/api-resources/ach-prenotifications.test.js +24 -28
  228. package/dist/cjs/tests/api-resources/ach-prenotifications.test.js.map +1 -1
  229. package/dist/cjs/tests/api-resources/ach-transfers.test.d.ts +1 -0
  230. package/dist/cjs/tests/api-resources/ach-transfers.test.d.ts.map +1 -0
  231. package/dist/cjs/tests/api-resources/ach-transfers.test.js +34 -36
  232. package/dist/cjs/tests/api-resources/ach-transfers.test.js.map +1 -1
  233. package/dist/cjs/tests/api-resources/balance-lookups.test.d.ts +2 -0
  234. package/dist/cjs/tests/api-resources/balance-lookups.test.d.ts.map +1 -0
  235. package/dist/cjs/tests/api-resources/balance-lookups.test.js +58 -0
  236. package/dist/cjs/tests/api-resources/balance-lookups.test.js.map +1 -0
  237. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.d.ts +2 -0
  238. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.d.ts.map +1 -0
  239. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.js +83 -0
  240. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.js.map +1 -0
  241. package/dist/cjs/tests/api-resources/bookkeeping-entries.test.d.ts +2 -0
  242. package/dist/cjs/tests/api-resources/bookkeeping-entries.test.d.ts.map +1 -0
  243. package/dist/cjs/tests/api-resources/bookkeeping-entries.test.js +65 -0
  244. package/dist/cjs/tests/api-resources/bookkeeping-entries.test.js.map +1 -0
  245. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.d.ts +2 -0
  246. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.d.ts.map +1 -0
  247. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.js +68 -0
  248. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.js.map +1 -0
  249. package/dist/cjs/tests/api-resources/card-disputes.test.d.ts +1 -0
  250. package/dist/cjs/tests/api-resources/card-disputes.test.d.ts.map +1 -0
  251. package/dist/cjs/tests/api-resources/card-disputes.test.js +21 -29
  252. package/dist/cjs/tests/api-resources/card-disputes.test.js.map +1 -1
  253. package/dist/cjs/tests/api-resources/card-profiles.test.d.ts +1 -0
  254. package/dist/cjs/tests/api-resources/card-profiles.test.d.ts.map +1 -0
  255. package/dist/cjs/tests/api-resources/card-profiles.test.js +29 -20
  256. package/dist/cjs/tests/api-resources/card-profiles.test.js.map +1 -1
  257. package/dist/cjs/tests/api-resources/cards.test.d.ts +1 -0
  258. package/dist/cjs/tests/api-resources/cards.test.d.ts.map +1 -0
  259. package/dist/cjs/tests/api-resources/cards.test.js +24 -38
  260. package/dist/cjs/tests/api-resources/cards.test.js.map +1 -1
  261. package/dist/cjs/tests/api-resources/check-deposits.test.d.ts +1 -0
  262. package/dist/cjs/tests/api-resources/check-deposits.test.d.ts.map +1 -0
  263. package/dist/cjs/tests/api-resources/check-deposits.test.js +27 -32
  264. package/dist/cjs/tests/api-resources/check-deposits.test.js.map +1 -1
  265. package/dist/cjs/tests/api-resources/check-transfers.test.d.ts +1 -0
  266. package/dist/cjs/tests/api-resources/check-transfers.test.d.ts.map +1 -0
  267. package/dist/cjs/tests/api-resources/check-transfers.test.js +34 -45
  268. package/dist/cjs/tests/api-resources/check-transfers.test.js.map +1 -1
  269. package/dist/cjs/tests/api-resources/declined-transactions.test.d.ts +1 -0
  270. package/dist/cjs/tests/api-resources/declined-transactions.test.d.ts.map +1 -0
  271. package/dist/cjs/tests/api-resources/declined-transactions.test.js +11 -27
  272. package/dist/cjs/tests/api-resources/declined-transactions.test.js.map +1 -1
  273. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.d.ts +1 -0
  274. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.d.ts.map +1 -0
  275. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.js +11 -26
  276. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.js.map +1 -1
  277. package/dist/cjs/tests/api-resources/documents.test.d.ts +1 -0
  278. package/dist/cjs/tests/api-resources/documents.test.d.ts.map +1 -0
  279. package/dist/cjs/tests/api-resources/documents.test.js +15 -27
  280. package/dist/cjs/tests/api-resources/documents.test.js.map +1 -1
  281. package/dist/cjs/tests/api-resources/entities/entities.test.d.ts +1 -0
  282. package/dist/cjs/tests/api-resources/entities/entities.test.d.ts.map +1 -0
  283. package/dist/cjs/tests/api-resources/entities/entities.test.js +109 -32
  284. package/dist/cjs/tests/api-resources/entities/entities.test.js.map +1 -1
  285. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.d.ts +1 -0
  286. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.d.ts.map +1 -0
  287. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.js +13 -6
  288. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.js.map +1 -1
  289. package/dist/cjs/tests/api-resources/event-subscriptions.test.d.ts +1 -0
  290. package/dist/cjs/tests/api-resources/event-subscriptions.test.d.ts.map +1 -0
  291. package/dist/cjs/tests/api-resources/event-subscriptions.test.js +14 -20
  292. package/dist/cjs/tests/api-resources/event-subscriptions.test.js.map +1 -1
  293. package/dist/cjs/tests/api-resources/events.test.d.ts +1 -0
  294. package/dist/cjs/tests/api-resources/events.test.d.ts.map +1 -0
  295. package/dist/cjs/tests/api-resources/events.test.js +11 -27
  296. package/dist/cjs/tests/api-resources/events.test.js.map +1 -1
  297. package/dist/cjs/tests/api-resources/exports.test.d.ts +2 -0
  298. package/dist/cjs/tests/api-resources/exports.test.d.ts.map +1 -0
  299. package/dist/cjs/tests/api-resources/exports.test.js +105 -0
  300. package/dist/cjs/tests/api-resources/exports.test.js.map +1 -0
  301. package/dist/cjs/tests/api-resources/external-accounts.test.d.ts +1 -0
  302. package/dist/cjs/tests/api-resources/external-accounts.test.d.ts.map +1 -0
  303. package/dist/cjs/tests/api-resources/external-accounts.test.js +16 -26
  304. package/dist/cjs/tests/api-resources/external-accounts.test.js.map +1 -1
  305. package/dist/cjs/tests/api-resources/files.test.d.ts +1 -0
  306. package/dist/cjs/tests/api-resources/files.test.d.ts.map +1 -0
  307. package/dist/cjs/tests/api-resources/files.test.js +12 -26
  308. package/dist/cjs/tests/api-resources/files.test.js.map +1 -1
  309. package/dist/cjs/tests/api-resources/groups.test.d.ts +1 -0
  310. package/dist/cjs/tests/api-resources/groups.test.d.ts.map +1 -0
  311. package/dist/cjs/tests/api-resources/groups.test.js +6 -5
  312. package/dist/cjs/tests/api-resources/groups.test.js.map +1 -1
  313. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.d.ts +1 -0
  314. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.d.ts.map +1 -0
  315. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.js +16 -12
  316. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.js.map +1 -1
  317. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.d.ts +1 -0
  318. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.d.ts.map +1 -0
  319. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.js +6 -9
  320. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.js.map +1 -1
  321. package/dist/cjs/tests/api-resources/limits.test.d.ts +1 -0
  322. package/dist/cjs/tests/api-resources/limits.test.d.ts.map +1 -0
  323. package/dist/cjs/tests/api-resources/limits.test.js +17 -15
  324. package/dist/cjs/tests/api-resources/limits.test.js.map +1 -1
  325. package/dist/cjs/tests/api-resources/oauth-connections.test.d.ts +1 -0
  326. package/dist/cjs/tests/api-resources/oauth-connections.test.d.ts.map +1 -0
  327. package/dist/cjs/tests/api-resources/oauth-connections.test.js +6 -9
  328. package/dist/cjs/tests/api-resources/oauth-connections.test.js.map +1 -1
  329. package/dist/cjs/tests/api-resources/pending-transactions.test.d.ts +1 -0
  330. package/dist/cjs/tests/api-resources/pending-transactions.test.d.ts.map +1 -0
  331. package/dist/cjs/tests/api-resources/pending-transactions.test.js +12 -18
  332. package/dist/cjs/tests/api-resources/pending-transactions.test.js.map +1 -1
  333. package/dist/cjs/tests/api-resources/programs.test.d.ts +2 -0
  334. package/dist/cjs/tests/api-resources/programs.test.d.ts.map +1 -0
  335. package/dist/cjs/tests/api-resources/programs.test.js +73 -0
  336. package/dist/cjs/tests/api-resources/programs.test.js.map +1 -0
  337. package/dist/cjs/tests/api-resources/real-time-decisions.test.d.ts +1 -0
  338. package/dist/cjs/tests/api-resources/real-time-decisions.test.d.ts.map +1 -0
  339. package/dist/cjs/tests/api-resources/real-time-decisions.test.js +7 -13
  340. package/dist/cjs/tests/api-resources/real-time-decisions.test.js.map +1 -1
  341. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.d.ts +2 -0
  342. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.d.ts.map +1 -0
  343. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.js +115 -0
  344. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.js.map +1 -0
  345. package/dist/cjs/tests/api-resources/routing-numbers.test.d.ts +1 -0
  346. package/dist/cjs/tests/api-resources/routing-numbers.test.d.ts.map +1 -0
  347. package/dist/cjs/tests/api-resources/routing-numbers.test.js +10 -5
  348. package/dist/cjs/tests/api-resources/routing-numbers.test.js.map +1 -1
  349. package/dist/cjs/tests/api-resources/simulations/account-statements.test.d.ts +1 -0
  350. package/dist/cjs/tests/api-resources/simulations/account-statements.test.d.ts.map +1 -0
  351. package/dist/cjs/tests/api-resources/simulations/account-statements.test.js +11 -8
  352. package/dist/cjs/tests/api-resources/simulations/account-statements.test.js.map +1 -1
  353. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.d.ts +1 -0
  354. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.d.ts.map +1 -0
  355. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.js +5 -4
  356. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.js.map +1 -1
  357. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.d.ts +1 -0
  358. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.d.ts.map +1 -0
  359. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.js +18 -20
  360. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.js.map +1 -1
  361. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.d.ts +1 -0
  362. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.d.ts.map +1 -0
  363. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.js +9 -7
  364. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.js.map +1 -1
  365. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.d.ts +1 -0
  366. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.d.ts.map +1 -0
  367. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.js +11 -8
  368. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.js.map +1 -1
  369. package/dist/cjs/tests/api-resources/simulations/cards.test.d.ts +1 -0
  370. package/dist/cjs/tests/api-resources/simulations/cards.test.d.ts.map +1 -0
  371. package/dist/cjs/tests/api-resources/simulations/cards.test.js +18 -10
  372. package/dist/cjs/tests/api-resources/simulations/cards.test.js.map +1 -1
  373. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.d.ts +1 -0
  374. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.d.ts.map +1 -0
  375. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.js +5 -4
  376. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.js.map +1 -1
  377. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.d.ts +1 -0
  378. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.d.ts.map +1 -0
  379. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.js +23 -4
  380. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.js.map +1 -1
  381. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.d.ts +1 -0
  382. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.d.ts.map +1 -0
  383. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.js +11 -8
  384. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.js.map +1 -1
  385. package/dist/cjs/tests/api-resources/simulations/documents.test.d.ts +1 -0
  386. package/dist/cjs/tests/api-resources/simulations/documents.test.d.ts.map +1 -0
  387. package/dist/cjs/tests/api-resources/simulations/documents.test.js +10 -7
  388. package/dist/cjs/tests/api-resources/simulations/documents.test.js.map +1 -1
  389. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.d.ts +1 -0
  390. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.d.ts.map +1 -0
  391. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.js +41 -28
  392. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.js.map +1 -1
  393. package/dist/cjs/tests/api-resources/simulations/interest-payments.test.d.ts +2 -0
  394. package/dist/cjs/tests/api-resources/simulations/interest-payments.test.d.ts.map +1 -0
  395. package/dist/cjs/tests/api-resources/simulations/interest-payments.test.js +58 -0
  396. package/dist/cjs/tests/api-resources/simulations/interest-payments.test.js.map +1 -0
  397. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.d.ts +1 -0
  398. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.d.ts.map +1 -0
  399. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.js +25 -12
  400. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.js.map +1 -1
  401. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.d.ts +1 -0
  402. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.d.ts.map +1 -0
  403. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.js +24 -10
  404. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.js.map +1 -1
  405. package/dist/cjs/tests/api-resources/transactions.test.d.ts +1 -0
  406. package/dist/cjs/tests/api-resources/transactions.test.d.ts.map +1 -0
  407. package/dist/cjs/tests/api-resources/transactions.test.js +15 -32
  408. package/dist/cjs/tests/api-resources/transactions.test.js.map +1 -1
  409. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.d.ts +1 -0
  410. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.d.ts.map +1 -0
  411. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.js +23 -23
  412. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.js.map +1 -1
  413. package/dist/cjs/tests/api-resources/wire-transfers.test.d.ts +1 -0
  414. package/dist/cjs/tests/api-resources/wire-transfers.test.d.ts.map +1 -0
  415. package/dist/cjs/tests/api-resources/wire-transfers.test.js +32 -41
  416. package/dist/cjs/tests/api-resources/wire-transfers.test.js.map +1 -1
  417. package/dist/cjs/tests/form.test.d.ts +1 -0
  418. package/dist/cjs/tests/form.test.d.ts.map +1 -0
  419. package/dist/cjs/tests/form.test.js +4 -3
  420. package/dist/cjs/tests/index.test.d.ts +1 -0
  421. package/dist/cjs/tests/index.test.d.ts.map +1 -0
  422. package/dist/cjs/tests/index.test.js +31 -4
  423. package/dist/cjs/tests/index.test.js.map +1 -1
  424. package/dist/cjs/tests/responses.test.d.ts +1 -0
  425. package/dist/cjs/tests/responses.test.d.ts.map +1 -0
  426. package/dist/cjs/tests/responses.test.js +4 -3
  427. package/dist/cjs/version.d.ts +2 -1
  428. package/dist/cjs/version.d.ts.map +1 -0
  429. package/dist/cjs/version.js +1 -1
  430. package/dist/cjs/version.js.map +1 -1
  431. package/error.ts +337 -0
  432. package/examples/api-error.ts +21 -0
  433. package/fetch-polyfill.ts +2 -2
  434. package/index.ts +140 -2
  435. package/package.json +2 -2
  436. package/pagination.ts +3 -0
  437. package/release-please-config.json +64 -0
  438. package/resources/account-numbers.ts +52 -1
  439. package/resources/account-statements.ts +23 -2
  440. package/resources/account-transfers.ts +44 -14
  441. package/resources/accounts.ts +62 -28
  442. package/resources/ach-prenotifications.ts +32 -8
  443. package/resources/ach-transfers.ts +77 -27
  444. package/resources/balance-lookups.ts +57 -0
  445. package/resources/bookkeeping-accounts.ts +98 -0
  446. package/resources/bookkeeping-entries.ts +62 -0
  447. package/resources/bookkeeping-entry-sets.ts +114 -0
  448. package/resources/card-disputes.ts +41 -6
  449. package/resources/card-profiles.ts +91 -4
  450. package/resources/cards.ts +165 -4
  451. package/resources/check-deposits.ts +36 -2
  452. package/resources/check-transfers.ts +184 -17
  453. package/resources/declined-transactions.ts +136 -9
  454. package/resources/digital-wallet-tokens.ts +23 -2
  455. package/resources/documents.ts +183 -7
  456. package/resources/entities/entities.ts +1343 -14
  457. package/resources/event-subscriptions.ts +9 -6
  458. package/resources/events.ts +87 -5
  459. package/resources/exports.ts +298 -0
  460. package/resources/external-accounts.ts +14 -9
  461. package/resources/files.ts +55 -11
  462. package/resources/inbound-ach-transfer-returns.ts +3 -1
  463. package/resources/inbound-wire-drawdown-requests.ts +0 -1
  464. package/resources/index.ts +28 -0
  465. package/resources/limits.ts +5 -6
  466. package/resources/oauth-connections.ts +0 -1
  467. package/resources/pending-transactions.ts +177 -7
  468. package/resources/programs.ts +70 -0
  469. package/resources/real-time-decisions.ts +113 -1
  470. package/resources/real-time-payments-transfers.ts +373 -0
  471. package/resources/simulations/ach-transfers.ts +479 -13
  472. package/resources/simulations/card-disputes.ts +4 -4
  473. package/resources/simulations/cards.ts +251 -14
  474. package/resources/simulations/check-transfers.ts +19 -0
  475. package/resources/simulations/inbound-wire-drawdown-requests.ts +28 -28
  476. package/resources/simulations/index.ts +3 -0
  477. package/resources/simulations/interest-payments.ts +1667 -0
  478. package/resources/simulations/real-time-payments-transfers.ts +568 -13
  479. package/resources/simulations/simulations.ts +2 -0
  480. package/resources/simulations/wire-transfers.ts +362 -7
  481. package/resources/transactions.ts +430 -11
  482. package/resources/wire-drawdown-requests.ts +14 -11
  483. package/resources/wire-transfers.ts +80 -21
  484. package/tests/api-resources/account-numbers.test.ts +21 -23
  485. package/tests/api-resources/account-statements.test.ts +8 -23
  486. package/tests/api-resources/account-transfers.test.ts +17 -31
  487. package/tests/api-resources/accounts.test.ts +22 -21
  488. package/tests/api-resources/ach-prenotifications.test.ts +21 -25
  489. package/tests/api-resources/ach-transfers.test.ts +31 -33
  490. package/tests/api-resources/balance-lookups.test.ts +21 -0
  491. package/tests/api-resources/bookkeeping-accounts.test.ts +43 -0
  492. package/tests/api-resources/bookkeeping-entries.test.ts +25 -0
  493. package/tests/api-resources/bookkeeping-entry-sets.test.ts +31 -0
  494. package/tests/api-resources/card-disputes.test.ts +18 -26
  495. package/tests/api-resources/card-profiles.test.ts +26 -17
  496. package/tests/api-resources/cards.test.ts +21 -35
  497. package/tests/api-resources/check-deposits.test.ts +24 -29
  498. package/tests/api-resources/check-transfers.test.ts +31 -42
  499. package/tests/api-resources/declined-transactions.test.ts +8 -24
  500. package/tests/api-resources/digital-wallet-tokens.test.ts +8 -23
  501. package/tests/api-resources/documents.test.ts +12 -24
  502. package/tests/api-resources/entities/entities.test.ts +106 -29
  503. package/tests/api-resources/entities/supplemental-documents.test.ts +10 -3
  504. package/tests/api-resources/event-subscriptions.test.ts +11 -17
  505. package/tests/api-resources/events.test.ts +8 -24
  506. package/tests/api-resources/exports.test.ts +68 -0
  507. package/tests/api-resources/external-accounts.test.ts +13 -23
  508. package/tests/api-resources/files.test.ts +9 -24
  509. package/tests/api-resources/groups.test.ts +3 -2
  510. package/tests/api-resources/inbound-ach-transfer-returns.test.ts +13 -9
  511. package/tests/api-resources/inbound-wire-drawdown-requests.test.ts +3 -6
  512. package/tests/api-resources/limits.test.ts +14 -12
  513. package/tests/api-resources/oauth-connections.test.ts +3 -6
  514. package/tests/api-resources/pending-transactions.test.ts +9 -15
  515. package/tests/api-resources/programs.test.ts +36 -0
  516. package/tests/api-resources/real-time-decisions.test.ts +4 -10
  517. package/tests/api-resources/real-time-payments-transfers.test.ts +78 -0
  518. package/tests/api-resources/routing-numbers.test.ts +7 -2
  519. package/tests/api-resources/simulations/account-statements.test.ts +8 -5
  520. package/tests/api-resources/simulations/account-transfers.test.ts +2 -1
  521. package/tests/api-resources/simulations/ach-transfers.test.ts +15 -14
  522. package/tests/api-resources/simulations/card-disputes.test.ts +6 -4
  523. package/tests/api-resources/simulations/card-refunds.test.ts +8 -5
  524. package/tests/api-resources/simulations/cards.test.ts +15 -7
  525. package/tests/api-resources/simulations/check-deposits.test.ts +2 -1
  526. package/tests/api-resources/simulations/check-transfers.test.ts +14 -1
  527. package/tests/api-resources/simulations/digital-wallet-token-requests.test.ts +8 -5
  528. package/tests/api-resources/simulations/documents.test.ts +7 -4
  529. package/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.ts +38 -25
  530. package/tests/api-resources/simulations/interest-payments.test.ts +15 -0
  531. package/tests/api-resources/simulations/real-time-payments-transfers.test.ts +22 -9
  532. package/tests/api-resources/simulations/wire-transfers.test.ts +21 -7
  533. package/tests/api-resources/transactions.test.ts +12 -29
  534. package/tests/api-resources/wire-drawdown-requests.test.ts +20 -20
  535. package/tests/api-resources/wire-transfers.test.ts +29 -38
  536. package/tests/index.test.ts +25 -1
  537. package/tsconfig.json +2 -0
  538. package/version.ts +1 -1
@@ -76,6 +76,11 @@ export interface ACHTransferSimulation {
76
76
  }
77
77
 
78
78
  export namespace ACHTransferSimulation {
79
+ /**
80
+ * If the ACH Transfer attempt succeeds, this will contain the resulting
81
+ * [Transaction](#transactions) object. The Transaction's `source` will be of
82
+ * `category: inbound_ach_transfer`.
83
+ */
79
84
  export interface Transaction {
80
85
  /**
81
86
  * The identifier for the Account the Transaction belongs to.
@@ -122,7 +127,7 @@ export namespace ACHTransferSimulation {
122
127
  /**
123
128
  * The type of the route this Transaction came through.
124
129
  */
125
- route_type: string | null;
130
+ route_type: 'account_number' | 'card' | null;
126
131
 
127
132
  /**
128
133
  * This is an object giving more details on the network-level event that caused the
@@ -140,6 +145,12 @@ export namespace ACHTransferSimulation {
140
145
  }
141
146
 
142
147
  export namespace Transaction {
148
+ /**
149
+ * This is an object giving more details on the network-level event that caused the
150
+ * Transaction. Note that for backwards compatibility reasons, additional
151
+ * undocumented keys may appear in this object. These should be treated as
152
+ * deprecated and will be removed in the future.
153
+ */
143
154
  export interface Source {
144
155
  /**
145
156
  * A Account Transfer Intention object. This field will be present in the JSON
@@ -189,6 +200,12 @@ export namespace ACHTransferSimulation {
189
200
  */
190
201
  card_refund: Source.CardRefund | null;
191
202
 
203
+ /**
204
+ * A Card Revenue Payment object. This field will be present in the JSON response
205
+ * if and only if `category` is equal to `card_revenue_payment`.
206
+ */
207
+ card_revenue_payment: Source.CardRevenuePayment | null;
208
+
192
209
  /**
193
210
  * A Deprecated Card Refund object. This field will be present in the JSON response
194
211
  * if and only if `category` is equal to `card_route_refund`.
@@ -222,6 +239,7 @@ export namespace ACHTransferSimulation {
222
239
  | 'card_dispute_acceptance'
223
240
  | 'card_refund'
224
241
  | 'card_settlement'
242
+ | 'card_revenue_payment'
225
243
  | 'check_deposit_acceptance'
226
244
  | 'check_deposit_return'
227
245
  | 'check_transfer_intention'
@@ -230,6 +248,7 @@ export namespace ACHTransferSimulation {
230
248
  | 'check_transfer_stop_payment_request'
231
249
  | 'dispute_resolution'
232
250
  | 'empyreal_cash_deposit'
251
+ | 'fee_payment'
233
252
  | 'inbound_ach_transfer'
234
253
  | 'inbound_ach_transfer_return_intention'
235
254
  | 'inbound_check'
@@ -301,6 +320,12 @@ export namespace ACHTransferSimulation {
301
320
  */
302
321
  empyreal_cash_deposit: Source.EmpyrealCashDeposit | null;
303
322
 
323
+ /**
324
+ * A Fee Payment object. This field will be present in the JSON response if and
325
+ * only if `category` is equal to `fee_payment`.
326
+ */
327
+ fee_payment: Source.FeePayment | null;
328
+
304
329
  /**
305
330
  * A Inbound ACH Transfer object. This field will be present in the JSON response
306
331
  * if and only if `category` is equal to `inbound_ach_transfer`.
@@ -364,6 +389,13 @@ export namespace ACHTransferSimulation {
364
389
  */
365
390
  internal_source: Source.InternalSource | null;
366
391
 
392
+ /**
393
+ * A Real Time Payments Transfer Acknowledgement object. This field will be present
394
+ * in the JSON response if and only if `category` is equal to
395
+ * `real_time_payments_transfer_acknowledgement`.
396
+ */
397
+ real_time_payments_transfer_acknowledgement: Source.RealTimePaymentsTransferAcknowledgement | null;
398
+
367
399
  /**
368
400
  * A Sample Funds object. This field will be present in the JSON response if and
369
401
  * only if `category` is equal to `sample_funds`.
@@ -398,6 +430,10 @@ export namespace ACHTransferSimulation {
398
430
  }
399
431
 
400
432
  export namespace Source {
433
+ /**
434
+ * A Account Transfer Intention object. This field will be present in the JSON
435
+ * response if and only if `category` is equal to `account_transfer_intention`.
436
+ */
401
437
  export interface AccountTransferIntention {
402
438
  /**
403
439
  * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -432,6 +468,10 @@ export namespace ACHTransferSimulation {
432
468
  transfer_id: string;
433
469
  }
434
470
 
471
+ /**
472
+ * A ACH Check Conversion Return object. This field will be present in the JSON
473
+ * response if and only if `category` is equal to `ach_check_conversion_return`.
474
+ */
435
475
  export interface ACHCheckConversionReturn {
436
476
  /**
437
477
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -445,6 +485,10 @@ export namespace ACHTransferSimulation {
445
485
  return_reason_code: string;
446
486
  }
447
487
 
488
+ /**
489
+ * A ACH Check Conversion object. This field will be present in the JSON response
490
+ * if and only if `category` is equal to `ach_check_conversion`.
491
+ */
448
492
  export interface ACHCheckConversion {
449
493
  /**
450
494
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -458,6 +502,10 @@ export namespace ACHTransferSimulation {
458
502
  file_id: string;
459
503
  }
460
504
 
505
+ /**
506
+ * A ACH Transfer Intention object. This field will be present in the JSON response
507
+ * if and only if `category` is equal to `ach_transfer_intention`.
508
+ */
461
509
  export interface ACHTransferIntention {
462
510
  account_number: string;
463
511
 
@@ -477,6 +525,10 @@ export namespace ACHTransferSimulation {
477
525
  transfer_id: string;
478
526
  }
479
527
 
528
+ /**
529
+ * A ACH Transfer Rejection object. This field will be present in the JSON response
530
+ * if and only if `category` is equal to `ach_transfer_rejection`.
531
+ */
480
532
  export interface ACHTransferRejection {
481
533
  /**
482
534
  * The identifier of the ACH Transfer that led to this Transaction.
@@ -484,6 +536,10 @@ export namespace ACHTransferSimulation {
484
536
  transfer_id: string;
485
537
  }
486
538
 
539
+ /**
540
+ * A ACH Transfer Return object. This field will be present in the JSON response if
541
+ * and only if `category` is equal to `ach_transfer_return`.
542
+ */
487
543
  export interface ACHTransferReturn {
488
544
  /**
489
545
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -530,6 +586,10 @@ export namespace ACHTransferSimulation {
530
586
  transfer_id: string;
531
587
  }
532
588
 
589
+ /**
590
+ * A Card Dispute Acceptance object. This field will be present in the JSON
591
+ * response if and only if `category` is equal to `card_dispute_acceptance`.
592
+ */
533
593
  export interface CardDisputeAcceptance {
534
594
  /**
535
595
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -546,9 +606,13 @@ export namespace ACHTransferSimulation {
546
606
  * The identifier of the Transaction that was created to return the disputed funds
547
607
  * to your account.
548
608
  */
549
- transaction_id: string | null;
609
+ transaction_id: string;
550
610
  }
551
611
 
612
+ /**
613
+ * A Card Refund object. This field will be present in the JSON response if and
614
+ * only if `category` is equal to `card_refund`.
615
+ */
552
616
  export interface CardRefund {
553
617
  /**
554
618
  * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -556,17 +620,48 @@ export namespace ACHTransferSimulation {
556
620
  */
557
621
  amount: number;
558
622
 
559
- /**
560
- * The identifier for the Transaction this refunds, if any.
561
- */
562
- card_settlement_transaction_id: string | null;
563
-
564
623
  /**
565
624
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
566
625
  * transaction's currency.
567
626
  */
568
627
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
569
628
 
629
+ /**
630
+ * The Card Refund identifier.
631
+ */
632
+ id: string;
633
+
634
+ /**
635
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
636
+ * is transacting with.
637
+ */
638
+ merchant_acceptor_id: string | null;
639
+
640
+ /**
641
+ * The 4-digit MCC describing the merchant's business.
642
+ */
643
+ merchant_category_code: string;
644
+
645
+ /**
646
+ * The city the merchant resides in.
647
+ */
648
+ merchant_city: string | null;
649
+
650
+ /**
651
+ * The country the merchant resides in.
652
+ */
653
+ merchant_country: string;
654
+
655
+ /**
656
+ * The name of the merchant.
657
+ */
658
+ merchant_name: string | null;
659
+
660
+ /**
661
+ * The state the merchant resides in.
662
+ */
663
+ merchant_state: string | null;
664
+
570
665
  /**
571
666
  * A constant representing the object's type. For this resource it will always be
572
667
  * `card_refund`.
@@ -574,6 +669,10 @@ export namespace ACHTransferSimulation {
574
669
  type: 'card_refund';
575
670
  }
576
671
 
672
+ /**
673
+ * A Card Settlement object. This field will be present in the JSON response if and
674
+ * only if `category` is equal to `card_settlement`.
675
+ */
577
676
  export interface CardSettlement {
578
677
  /**
579
678
  * The amount in the minor unit of the transaction's settlement currency. For
@@ -581,20 +680,52 @@ export namespace ACHTransferSimulation {
581
680
  */
582
681
  amount: number;
583
682
 
683
+ /**
684
+ * The Card Authorization that was created prior to this Card Settlement, if on
685
+ * exists.
686
+ */
687
+ card_authorization: string | null;
688
+
584
689
  /**
585
690
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
586
691
  * transaction's settlement currency.
587
692
  */
588
693
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
589
694
 
695
+ /**
696
+ * The Card Settlement identifier.
697
+ */
698
+ id: string;
699
+
700
+ /**
701
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
702
+ * is transacting with.
703
+ */
704
+ merchant_acceptor_id: string | null;
705
+
706
+ /**
707
+ * The 4-digit MCC describing the merchant's business.
708
+ */
590
709
  merchant_category_code: string;
591
710
 
711
+ /**
712
+ * The city the merchant resides in.
713
+ */
592
714
  merchant_city: string | null;
593
715
 
716
+ /**
717
+ * The country the merchant resides in.
718
+ */
594
719
  merchant_country: string;
595
720
 
721
+ /**
722
+ * The name of the merchant.
723
+ */
596
724
  merchant_name: string | null;
597
725
 
726
+ /**
727
+ * The state the merchant resides in.
728
+ */
598
729
  merchant_state: string | null;
599
730
 
600
731
  /**
@@ -620,6 +751,43 @@ export namespace ACHTransferSimulation {
620
751
  type: 'card_settlement';
621
752
  }
622
753
 
754
+ /**
755
+ * A Card Revenue Payment object. This field will be present in the JSON response
756
+ * if and only if `category` is equal to `card_revenue_payment`.
757
+ */
758
+ export interface CardRevenuePayment {
759
+ /**
760
+ * The amount in the minor unit of the transaction's currency. For dollars, for
761
+ * example, this is cents.
762
+ */
763
+ amount: number;
764
+
765
+ /**
766
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
767
+ * currency.
768
+ */
769
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
770
+
771
+ /**
772
+ * The end of the period for which this transaction paid interest.
773
+ */
774
+ period_end: string;
775
+
776
+ /**
777
+ * The start of the period for which this transaction paid interest.
778
+ */
779
+ period_start: string;
780
+
781
+ /**
782
+ * The account the card belonged to.
783
+ */
784
+ transacted_on_account_id: string | null;
785
+ }
786
+
787
+ /**
788
+ * A Check Deposit Acceptance object. This field will be present in the JSON
789
+ * response if and only if `category` is equal to `check_deposit_acceptance`.
790
+ */
623
791
  export interface CheckDepositAcceptance {
624
792
  /**
625
793
  * The account number printed on the check.
@@ -661,6 +829,10 @@ export namespace ACHTransferSimulation {
661
829
  serial_number: string | null;
662
830
  }
663
831
 
832
+ /**
833
+ * A Check Deposit Return object. This field will be present in the JSON response
834
+ * if and only if `category` is equal to `check_deposit_return`.
835
+ */
664
836
  export interface CheckDepositReturn {
665
837
  /**
666
838
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -705,6 +877,10 @@ export namespace ACHTransferSimulation {
705
877
  transaction_id: string;
706
878
  }
707
879
 
880
+ /**
881
+ * A Check Transfer Intention object. This field will be present in the JSON
882
+ * response if and only if `category` is equal to `check_transfer_intention`.
883
+ */
708
884
  export interface CheckTransferIntention {
709
885
  /**
710
886
  * The city of the check's destination.
@@ -753,18 +929,43 @@ export namespace ACHTransferSimulation {
753
929
  transfer_id: string;
754
930
  }
755
931
 
932
+ /**
933
+ * A Check Transfer Return object. This field will be present in the JSON response
934
+ * if and only if `category` is equal to `check_transfer_return`.
935
+ */
756
936
  export interface CheckTransferReturn {
757
937
  /**
758
938
  * If available, a document with additional information about the return.
759
939
  */
760
940
  file_id: string | null;
761
941
 
942
+ /**
943
+ * The reason why the check was returned.
944
+ */
945
+ reason: 'mail_delivery_failure' | 'refused_by_recipient' | 'returned_not_authorized';
946
+
947
+ /**
948
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
949
+ * the check was returned.
950
+ */
951
+ returned_at: string;
952
+
953
+ /**
954
+ * The identifier of the Transaction that was created to credit you for the
955
+ * returned check.
956
+ */
957
+ transaction_id: string | null;
958
+
762
959
  /**
763
960
  * The identifier of the returned Check Transfer.
764
961
  */
765
962
  transfer_id: string;
766
963
  }
767
964
 
965
+ /**
966
+ * A Check Transfer Rejection object. This field will be present in the JSON
967
+ * response if and only if `category` is equal to `check_transfer_rejection`.
968
+ */
768
969
  export interface CheckTransferRejection {
769
970
  /**
770
971
  * The identifier of the Check Transfer that led to this Transaction.
@@ -772,6 +973,11 @@ export namespace ACHTransferSimulation {
772
973
  transfer_id: string;
773
974
  }
774
975
 
976
+ /**
977
+ * A Check Transfer Stop Payment Request object. This field will be present in the
978
+ * JSON response if and only if `category` is equal to
979
+ * `check_transfer_stop_payment_request`.
980
+ */
775
981
  export interface CheckTransferStopPaymentRequest {
776
982
  /**
777
983
  * The time the stop-payment was requested.
@@ -795,6 +1001,10 @@ export namespace ACHTransferSimulation {
795
1001
  type: 'check_transfer_stop_payment_request';
796
1002
  }
797
1003
 
1004
+ /**
1005
+ * A Dispute Resolution object. This field will be present in the JSON response if
1006
+ * and only if `category` is equal to `dispute_resolution`.
1007
+ */
798
1008
  export interface DisputeResolution {
799
1009
  /**
800
1010
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -814,6 +1024,10 @@ export namespace ACHTransferSimulation {
814
1024
  disputed_transaction_id: string;
815
1025
  }
816
1026
 
1027
+ /**
1028
+ * A Empyreal Cash Deposit object. This field will be present in the JSON response
1029
+ * if and only if `category` is equal to `empyreal_cash_deposit`.
1030
+ */
817
1031
  export interface EmpyrealCashDeposit {
818
1032
  /**
819
1033
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -826,6 +1040,28 @@ export namespace ACHTransferSimulation {
826
1040
  deposit_date: string;
827
1041
  }
828
1042
 
1043
+ /**
1044
+ * A Fee Payment object. This field will be present in the JSON response if and
1045
+ * only if `category` is equal to `fee_payment`.
1046
+ */
1047
+ export interface FeePayment {
1048
+ /**
1049
+ * The amount in the minor unit of the transaction's currency. For dollars, for
1050
+ * example, this is cents.
1051
+ */
1052
+ amount: number;
1053
+
1054
+ /**
1055
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
1056
+ * currency.
1057
+ */
1058
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1059
+ }
1060
+
1061
+ /**
1062
+ * A Inbound ACH Transfer object. This field will be present in the JSON response
1063
+ * if and only if `category` is equal to `inbound_ach_transfer`.
1064
+ */
829
1065
  export interface InboundACHTransfer {
830
1066
  /**
831
1067
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -850,6 +1086,10 @@ export namespace ACHTransferSimulation {
850
1086
  trace_number: string;
851
1087
  }
852
1088
 
1089
+ /**
1090
+ * A Inbound Check object. This field will be present in the JSON response if and
1091
+ * only if `category` is equal to `inbound_check`.
1092
+ */
853
1093
  export interface InboundCheck {
854
1094
  /**
855
1095
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -870,6 +1110,11 @@ export namespace ACHTransferSimulation {
870
1110
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
871
1111
  }
872
1112
 
1113
+ /**
1114
+ * A Inbound International ACH Transfer object. This field will be present in the
1115
+ * JSON response if and only if `category` is equal to
1116
+ * `inbound_international_ach_transfer`.
1117
+ */
873
1118
  export interface InboundInternationalACHTransfer {
874
1119
  /**
875
1120
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -948,6 +1193,11 @@ export namespace ACHTransferSimulation {
948
1193
  trace_number: string;
949
1194
  }
950
1195
 
1196
+ /**
1197
+ * A Inbound Real Time Payments Transfer Confirmation object. This field will be
1198
+ * present in the JSON response if and only if `category` is equal to
1199
+ * `inbound_real_time_payments_transfer_confirmation`.
1200
+ */
951
1201
  export interface InboundRealTimePaymentsTransferConfirmation {
952
1202
  /**
953
1203
  * The amount in the minor unit of the transfer's currency. For dollars, for
@@ -992,6 +1242,11 @@ export namespace ACHTransferSimulation {
992
1242
  transaction_identification: string;
993
1243
  }
994
1244
 
1245
+ /**
1246
+ * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
1247
+ * the JSON response if and only if `category` is equal to
1248
+ * `inbound_wire_drawdown_payment_reversal`.
1249
+ */
995
1250
  export interface InboundWireDrawdownPaymentReversal {
996
1251
  /**
997
1252
  * The amount that was reversed.
@@ -1044,6 +1299,10 @@ export namespace ACHTransferSimulation {
1044
1299
  previous_message_input_source: string;
1045
1300
  }
1046
1301
 
1302
+ /**
1303
+ * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
1304
+ * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
1305
+ */
1047
1306
  export interface InboundWireDrawdownPayment {
1048
1307
  /**
1049
1308
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -1076,12 +1335,22 @@ export namespace ACHTransferSimulation {
1076
1335
  originator_to_beneficiary_information: string | null;
1077
1336
  }
1078
1337
 
1338
+ /**
1339
+ * A Inbound Wire Reversal object. This field will be present in the JSON response
1340
+ * if and only if `category` is equal to `inbound_wire_reversal`.
1341
+ */
1079
1342
  export interface InboundWireReversal {
1080
1343
  /**
1081
1344
  * The amount that was reversed.
1082
1345
  */
1083
1346
  amount: number;
1084
1347
 
1348
+ /**
1349
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1350
+ * the reversal was created.
1351
+ */
1352
+ created_at: string;
1353
+
1085
1354
  /**
1086
1355
  * The description on the reversal message from Fedwire.
1087
1356
  */
@@ -1137,8 +1406,22 @@ export namespace ACHTransferSimulation {
1137
1406
  * institution.
1138
1407
  */
1139
1408
  receiver_financial_institution_information: string | null;
1409
+
1410
+ /**
1411
+ * The ID for the Transaction associated with the transfer reversal.
1412
+ */
1413
+ transaction_id: string | null;
1414
+
1415
+ /**
1416
+ * The ID for the Wire Transfer that is being reversed.
1417
+ */
1418
+ wire_transfer_id: string;
1140
1419
  }
1141
1420
 
1421
+ /**
1422
+ * A Inbound Wire Transfer object. This field will be present in the JSON response
1423
+ * if and only if `category` is equal to `inbound_wire_transfer`.
1424
+ */
1142
1425
  export interface InboundWireTransfer {
1143
1426
  /**
1144
1427
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -1179,6 +1462,10 @@ export namespace ACHTransferSimulation {
1179
1462
  originator_to_beneficiary_information_line4: string | null;
1180
1463
  }
1181
1464
 
1465
+ /**
1466
+ * A Interest Payment object. This field will be present in the JSON response if
1467
+ * and only if `category` is equal to `interest_payment`.
1468
+ */
1182
1469
  export interface InterestPayment {
1183
1470
  /**
1184
1471
  * The account on which the interest was accrued.
@@ -1208,6 +1495,10 @@ export namespace ACHTransferSimulation {
1208
1495
  period_start: string;
1209
1496
  }
1210
1497
 
1498
+ /**
1499
+ * A Internal Source object. This field will be present in the JSON response if and
1500
+ * only if `category` is equal to `internal_source`.
1501
+ */
1211
1502
  export interface InternalSource {
1212
1503
  /**
1213
1504
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -1224,15 +1515,21 @@ export namespace ACHTransferSimulation {
1224
1515
  reason:
1225
1516
  | 'bank_migration'
1226
1517
  | 'cashback'
1518
+ | 'collection_receivable'
1227
1519
  | 'empyreal_adjustment'
1228
1520
  | 'error'
1229
1521
  | 'error_correction'
1230
1522
  | 'fees'
1231
1523
  | 'interest'
1524
+ | 'negative_balance_forgiveness'
1232
1525
  | 'sample_funds'
1233
1526
  | 'sample_funds_return';
1234
1527
  }
1235
1528
 
1529
+ /**
1530
+ * A Deprecated Card Refund object. This field will be present in the JSON response
1531
+ * if and only if `category` is equal to `card_route_refund`.
1532
+ */
1236
1533
  export interface CardRouteRefund {
1237
1534
  /**
1238
1535
  * The refunded amount in the minor unit of the refunded currency. For dollars, for
@@ -1259,6 +1556,10 @@ export namespace ACHTransferSimulation {
1259
1556
  merchant_state: string | null;
1260
1557
  }
1261
1558
 
1559
+ /**
1560
+ * A Deprecated Card Settlement object. This field will be present in the JSON
1561
+ * response if and only if `category` is equal to `card_route_settlement`.
1562
+ */
1262
1563
  export interface CardRouteSettlement {
1263
1564
  /**
1264
1565
  * The settled amount in the minor unit of the settlement currency. For dollars,
@@ -1285,6 +1586,42 @@ export namespace ACHTransferSimulation {
1285
1586
  merchant_state: string | null;
1286
1587
  }
1287
1588
 
1589
+ /**
1590
+ * A Real Time Payments Transfer Acknowledgement object. This field will be present
1591
+ * in the JSON response if and only if `category` is equal to
1592
+ * `real_time_payments_transfer_acknowledgement`.
1593
+ */
1594
+ export interface RealTimePaymentsTransferAcknowledgement {
1595
+ /**
1596
+ * The transfer amount in USD cents.
1597
+ */
1598
+ amount: number;
1599
+
1600
+ /**
1601
+ * The destination account number.
1602
+ */
1603
+ destination_account_number: string;
1604
+
1605
+ /**
1606
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN).
1607
+ */
1608
+ destination_routing_number: string;
1609
+
1610
+ /**
1611
+ * Unstructured information that will show on the recipient's bank statement.
1612
+ */
1613
+ remittance_information: string;
1614
+
1615
+ /**
1616
+ * The identifier of the Real Time Payments Transfer that led to this Transaction.
1617
+ */
1618
+ transfer_id: string;
1619
+ }
1620
+
1621
+ /**
1622
+ * A Sample Funds object. This field will be present in the JSON response if and
1623
+ * only if `category` is equal to `sample_funds`.
1624
+ */
1288
1625
  export interface SampleFunds {
1289
1626
  /**
1290
1627
  * Where the sample funds came from.
@@ -1292,6 +1629,11 @@ export namespace ACHTransferSimulation {
1292
1629
  originator: string;
1293
1630
  }
1294
1631
 
1632
+ /**
1633
+ * A Wire Drawdown Payment Intention object. This field will be present in the JSON
1634
+ * response if and only if `category` is equal to
1635
+ * `wire_drawdown_payment_intention`.
1636
+ */
1295
1637
  export interface WireDrawdownPaymentIntention {
1296
1638
  account_number: string;
1297
1639
 
@@ -1307,10 +1649,19 @@ export namespace ACHTransferSimulation {
1307
1649
  transfer_id: string;
1308
1650
  }
1309
1651
 
1652
+ /**
1653
+ * A Wire Drawdown Payment Rejection object. This field will be present in the JSON
1654
+ * response if and only if `category` is equal to
1655
+ * `wire_drawdown_payment_rejection`.
1656
+ */
1310
1657
  export interface WireDrawdownPaymentRejection {
1311
1658
  transfer_id: string;
1312
1659
  }
1313
1660
 
1661
+ /**
1662
+ * A Wire Transfer Intention object. This field will be present in the JSON
1663
+ * response if and only if `category` is equal to `wire_transfer_intention`.
1664
+ */
1314
1665
  export interface WireTransferIntention {
1315
1666
  /**
1316
1667
  * The destination account number.
@@ -1335,12 +1686,21 @@ export namespace ACHTransferSimulation {
1335
1686
  transfer_id: string;
1336
1687
  }
1337
1688
 
1689
+ /**
1690
+ * A Wire Transfer Rejection object. This field will be present in the JSON
1691
+ * response if and only if `category` is equal to `wire_transfer_rejection`.
1692
+ */
1338
1693
  export interface WireTransferRejection {
1339
1694
  transfer_id: string;
1340
1695
  }
1341
1696
  }
1342
1697
  }
1343
1698
 
1699
+ /**
1700
+ * If the ACH Transfer attempt fails, this will contain the resulting
1701
+ * [Declined Transaction](#declined-transactions) object. The Declined
1702
+ * Transaction's `source` will be of `category: inbound_ach_transfer`.
1703
+ */
1344
1704
  export interface DeclinedTransaction {
1345
1705
  /**
1346
1706
  * The identifier for the Account the Declined Transaction belongs to.
@@ -1385,7 +1745,7 @@ export namespace ACHTransferSimulation {
1385
1745
  /**
1386
1746
  * The type of the route this Declined Transaction came through.
1387
1747
  */
1388
- route_type: string | null;
1748
+ route_type: 'account_number' | 'card' | null;
1389
1749
 
1390
1750
  /**
1391
1751
  * This is an object giving more details on the network-level event that caused the
@@ -1404,6 +1764,13 @@ export namespace ACHTransferSimulation {
1404
1764
  }
1405
1765
 
1406
1766
  export namespace DeclinedTransaction {
1767
+ /**
1768
+ * This is an object giving more details on the network-level event that caused the
1769
+ * Declined Transaction. For example, for a card transaction this lists the
1770
+ * merchant's industry and location. Note that for backwards compatibility reasons,
1771
+ * additional undocumented keys may appear in this object. These should be treated
1772
+ * as deprecated and will be removed in the future.
1773
+ */
1407
1774
  export interface Source {
1408
1775
  /**
1409
1776
  * A ACH Decline object. This field will be present in the JSON response if and
@@ -1435,6 +1802,7 @@ export namespace ACHTransferSimulation {
1435
1802
  | 'inbound_real_time_payments_transfer_decline'
1436
1803
  | 'international_ach_decline'
1437
1804
  | 'card_route_decline'
1805
+ | 'wire_decline'
1438
1806
  | 'other';
1439
1807
 
1440
1808
  /**
@@ -1455,9 +1823,19 @@ export namespace ACHTransferSimulation {
1455
1823
  * response if and only if `category` is equal to `international_ach_decline`.
1456
1824
  */
1457
1825
  international_ach_decline: Source.InternationalACHDecline | null;
1826
+
1827
+ /**
1828
+ * A Wire Decline object. This field will be present in the JSON response if and
1829
+ * only if `category` is equal to `wire_decline`.
1830
+ */
1831
+ wire_decline: Source.WireDecline | null;
1458
1832
  }
1459
1833
 
1460
1834
  export namespace Source {
1835
+ /**
1836
+ * A ACH Decline object. This field will be present in the JSON response if and
1837
+ * only if `category` is equal to `ach_decline`.
1838
+ */
1461
1839
  export interface ACHDecline {
1462
1840
  /**
1463
1841
  * The declined amount in the minor unit of the destination account currency. For
@@ -1483,11 +1861,12 @@ export namespace ACHTransferSimulation {
1483
1861
  | 'credit_entry_refused_by_receiver'
1484
1862
  | 'duplicate_return'
1485
1863
  | 'entity_not_active'
1486
- | 'transaction_not_allowed'
1487
1864
  | 'group_locked'
1488
1865
  | 'insufficient_funds'
1866
+ | 'misrouted_return'
1489
1867
  | 'no_ach_route'
1490
- | 'originator_request';
1868
+ | 'originator_request'
1869
+ | 'transaction_not_allowed';
1491
1870
 
1492
1871
  receiver_id_number: string | null;
1493
1872
 
@@ -1496,6 +1875,10 @@ export namespace ACHTransferSimulation {
1496
1875
  trace_number: string;
1497
1876
  }
1498
1877
 
1878
+ /**
1879
+ * A Card Decline object. This field will be present in the JSON response if and
1880
+ * only if `category` is equal to `card_decline`.
1881
+ */
1499
1882
  export interface CardDecline {
1500
1883
  /**
1501
1884
  * The declined amount in the minor unit of the destination account currency. For
@@ -1573,13 +1956,19 @@ export namespace ACHTransferSimulation {
1573
1956
  | 'insufficient_funds'
1574
1957
  | 'cvv2_mismatch'
1575
1958
  | 'transaction_not_allowed'
1959
+ | 'breaches_internal_limit'
1576
1960
  | 'breaches_limit'
1577
1961
  | 'webhook_declined'
1578
1962
  | 'webhook_timed_out'
1579
- | 'declined_by_stand_in_processing';
1963
+ | 'declined_by_stand_in_processing'
1964
+ | 'invalid_physical_card'
1965
+ | 'missing_original_authorization';
1580
1966
  }
1581
1967
 
1582
1968
  export namespace CardDecline {
1969
+ /**
1970
+ * Fields specific to the `network`
1971
+ */
1583
1972
  export interface NetworkDetails {
1584
1973
  /**
1585
1974
  * Fields specific to the `visa` network
@@ -1588,6 +1977,9 @@ export namespace ACHTransferSimulation {
1588
1977
  }
1589
1978
 
1590
1979
  export namespace NetworkDetails {
1980
+ /**
1981
+ * Fields specific to the `visa` network
1982
+ */
1591
1983
  export interface Visa {
1592
1984
  /**
1593
1985
  * For electronic commerce transactions, this identifies the level of security used
@@ -1609,11 +2001,15 @@ export namespace ACHTransferSimulation {
1609
2001
  * The method used to enter the cardholder's primary account number and card
1610
2002
  * expiration date
1611
2003
  */
1612
- point_of_service_entry_mode: Shared.PointOfServiceEntryMode;
2004
+ point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
1613
2005
  }
1614
2006
  }
1615
2007
  }
1616
2008
 
2009
+ /**
2010
+ * A Check Decline object. This field will be present in the JSON response if and
2011
+ * only if `category` is equal to `check_decline`.
2012
+ */
1617
2013
  export interface CheckDecline {
1618
2014
  /**
1619
2015
  * The declined amount in the minor unit of the destination account currency. For
@@ -1637,9 +2033,17 @@ export namespace ACHTransferSimulation {
1637
2033
  | 'unable_to_process'
1638
2034
  | 'refer_to_image'
1639
2035
  | 'stop_payment_requested'
1640
- | 'returned';
2036
+ | 'returned'
2037
+ | 'duplicate_presentment'
2038
+ | 'not_authorized'
2039
+ | 'altered_or_fictitious';
1641
2040
  }
1642
2041
 
2042
+ /**
2043
+ * A Inbound Real Time Payments Transfer Decline object. This field will be present
2044
+ * in the JSON response if and only if `category` is equal to
2045
+ * `inbound_real_time_payments_transfer_decline`.
2046
+ */
1643
2047
  export interface InboundRealTimePaymentsTransferDecline {
1644
2048
  /**
1645
2049
  * The declined amount in the minor unit of the destination account currency. For
@@ -1680,6 +2084,7 @@ export namespace ACHTransferSimulation {
1680
2084
  reason:
1681
2085
  | 'account_number_canceled'
1682
2086
  | 'account_number_disabled'
2087
+ | 'account_restricted'
1683
2088
  | 'group_locked'
1684
2089
  | 'entity_not_active'
1685
2090
  | 'real_time_payments_not_enabled';
@@ -1695,6 +2100,10 @@ export namespace ACHTransferSimulation {
1695
2100
  transaction_identification: string;
1696
2101
  }
1697
2102
 
2103
+ /**
2104
+ * A International ACH Decline object. This field will be present in the JSON
2105
+ * response if and only if `category` is equal to `international_ach_decline`.
2106
+ */
1698
2107
  export interface InternationalACHDecline {
1699
2108
  /**
1700
2109
  * The declined amount in the minor unit of the destination account currency. For
@@ -1773,6 +2182,10 @@ export namespace ACHTransferSimulation {
1773
2182
  trace_number: string;
1774
2183
  }
1775
2184
 
2185
+ /**
2186
+ * A Deprecated Card Decline object. This field will be present in the JSON
2187
+ * response if and only if `category` is equal to `card_route_decline`.
2188
+ */
1776
2189
  export interface CardRouteDecline {
1777
2190
  /**
1778
2191
  * The declined amount in the minor unit of the destination account currency. For
@@ -1798,6 +2211,59 @@ export namespace ACHTransferSimulation {
1798
2211
 
1799
2212
  merchant_state: string | null;
1800
2213
  }
2214
+
2215
+ /**
2216
+ * A Wire Decline object. This field will be present in the JSON response if and
2217
+ * only if `category` is equal to `wire_decline`.
2218
+ */
2219
+ export interface WireDecline {
2220
+ /**
2221
+ * The declined amount in the minor unit of the destination account currency. For
2222
+ * dollars, for example, this is cents.
2223
+ */
2224
+ amount: number;
2225
+
2226
+ beneficiary_address_line1: string | null;
2227
+
2228
+ beneficiary_address_line2: string | null;
2229
+
2230
+ beneficiary_address_line3: string | null;
2231
+
2232
+ beneficiary_name: string | null;
2233
+
2234
+ beneficiary_reference: string | null;
2235
+
2236
+ description: string;
2237
+
2238
+ input_message_accountability_data: string | null;
2239
+
2240
+ originator_address_line1: string | null;
2241
+
2242
+ originator_address_line2: string | null;
2243
+
2244
+ originator_address_line3: string | null;
2245
+
2246
+ originator_name: string | null;
2247
+
2248
+ originator_to_beneficiary_information_line1: string | null;
2249
+
2250
+ originator_to_beneficiary_information_line2: string | null;
2251
+
2252
+ originator_to_beneficiary_information_line3: string | null;
2253
+
2254
+ originator_to_beneficiary_information_line4: string | null;
2255
+
2256
+ /**
2257
+ * Why the wire transfer was declined.
2258
+ */
2259
+ reason:
2260
+ | 'account_number_canceled'
2261
+ | 'account_number_disabled'
2262
+ | 'entity_not_active'
2263
+ | 'group_locked'
2264
+ | 'no_account_number'
2265
+ | 'transaction_not_allowed';
2266
+ }
1801
2267
  }
1802
2268
  }
1803
2269
  }