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
@@ -61,6 +61,11 @@ export interface ACHTransferSimulation {
61
61
  type: 'inbound_ach_transfer_simulation_result';
62
62
  }
63
63
  export declare namespace ACHTransferSimulation {
64
+ /**
65
+ * If the ACH Transfer attempt succeeds, this will contain the resulting
66
+ * [Transaction](#transactions) object. The Transaction's `source` will be of
67
+ * `category: inbound_ach_transfer`.
68
+ */
64
69
  interface Transaction {
65
70
  /**
66
71
  * The identifier for the Account the Transaction belongs to.
@@ -100,7 +105,7 @@ export declare namespace ACHTransferSimulation {
100
105
  /**
101
106
  * The type of the route this Transaction came through.
102
107
  */
103
- route_type: string | null;
108
+ route_type: 'account_number' | 'card' | null;
104
109
  /**
105
110
  * This is an object giving more details on the network-level event that caused the
106
111
  * Transaction. Note that for backwards compatibility reasons, additional
@@ -115,6 +120,12 @@ export declare namespace ACHTransferSimulation {
115
120
  type: 'transaction';
116
121
  }
117
122
  namespace Transaction {
123
+ /**
124
+ * This is an object giving more details on the network-level event that caused the
125
+ * Transaction. Note that for backwards compatibility reasons, additional
126
+ * undocumented keys may appear in this object. These should be treated as
127
+ * deprecated and will be removed in the future.
128
+ */
118
129
  interface Source {
119
130
  /**
120
131
  * A Account Transfer Intention object. This field will be present in the JSON
@@ -156,6 +167,11 @@ export declare namespace ACHTransferSimulation {
156
167
  * only if `category` is equal to `card_refund`.
157
168
  */
158
169
  card_refund: Source.CardRefund | null;
170
+ /**
171
+ * A Card Revenue Payment object. This field will be present in the JSON response
172
+ * if and only if `category` is equal to `card_revenue_payment`.
173
+ */
174
+ card_revenue_payment: Source.CardRevenuePayment | null;
159
175
  /**
160
176
  * A Deprecated Card Refund object. This field will be present in the JSON response
161
177
  * if and only if `category` is equal to `card_route_refund`.
@@ -186,6 +202,7 @@ export declare namespace ACHTransferSimulation {
186
202
  | 'card_dispute_acceptance'
187
203
  | 'card_refund'
188
204
  | 'card_settlement'
205
+ | 'card_revenue_payment'
189
206
  | 'check_deposit_acceptance'
190
207
  | 'check_deposit_return'
191
208
  | 'check_transfer_intention'
@@ -194,6 +211,7 @@ export declare namespace ACHTransferSimulation {
194
211
  | 'check_transfer_stop_payment_request'
195
212
  | 'dispute_resolution'
196
213
  | 'empyreal_cash_deposit'
214
+ | 'fee_payment'
197
215
  | 'inbound_ach_transfer'
198
216
  | 'inbound_ach_transfer_return_intention'
199
217
  | 'inbound_check'
@@ -256,6 +274,11 @@ export declare namespace ACHTransferSimulation {
256
274
  * if and only if `category` is equal to `empyreal_cash_deposit`.
257
275
  */
258
276
  empyreal_cash_deposit: Source.EmpyrealCashDeposit | null;
277
+ /**
278
+ * A Fee Payment object. This field will be present in the JSON response if and
279
+ * only if `category` is equal to `fee_payment`.
280
+ */
281
+ fee_payment: Source.FeePayment | null;
259
282
  /**
260
283
  * A Inbound ACH Transfer object. This field will be present in the JSON response
261
284
  * if and only if `category` is equal to `inbound_ach_transfer`.
@@ -309,6 +332,12 @@ export declare namespace ACHTransferSimulation {
309
332
  * only if `category` is equal to `internal_source`.
310
333
  */
311
334
  internal_source: Source.InternalSource | null;
335
+ /**
336
+ * A Real Time Payments Transfer Acknowledgement object. This field will be present
337
+ * in the JSON response if and only if `category` is equal to
338
+ * `real_time_payments_transfer_acknowledgement`.
339
+ */
340
+ real_time_payments_transfer_acknowledgement: Source.RealTimePaymentsTransferAcknowledgement | null;
312
341
  /**
313
342
  * A Sample Funds object. This field will be present in the JSON response if and
314
343
  * only if `category` is equal to `sample_funds`.
@@ -338,6 +367,10 @@ export declare namespace ACHTransferSimulation {
338
367
  wire_transfer_rejection: Source.WireTransferRejection | null;
339
368
  }
340
369
  namespace Source {
370
+ /**
371
+ * A Account Transfer Intention object. This field will be present in the JSON
372
+ * response if and only if `category` is equal to `account_transfer_intention`.
373
+ */
341
374
  interface AccountTransferIntention {
342
375
  /**
343
376
  * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -366,6 +399,10 @@ export declare namespace ACHTransferSimulation {
366
399
  */
367
400
  transfer_id: string;
368
401
  }
402
+ /**
403
+ * A ACH Check Conversion Return object. This field will be present in the JSON
404
+ * response if and only if `category` is equal to `ach_check_conversion_return`.
405
+ */
369
406
  interface ACHCheckConversionReturn {
370
407
  /**
371
408
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -377,6 +414,10 @@ export declare namespace ACHTransferSimulation {
377
414
  */
378
415
  return_reason_code: string;
379
416
  }
417
+ /**
418
+ * A ACH Check Conversion object. This field will be present in the JSON response
419
+ * if and only if `category` is equal to `ach_check_conversion`.
420
+ */
380
421
  interface ACHCheckConversion {
381
422
  /**
382
423
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -388,6 +429,10 @@ export declare namespace ACHTransferSimulation {
388
429
  */
389
430
  file_id: string;
390
431
  }
432
+ /**
433
+ * A ACH Transfer Intention object. This field will be present in the JSON response
434
+ * if and only if `category` is equal to `ach_transfer_intention`.
435
+ */
391
436
  interface ACHTransferIntention {
392
437
  account_number: string;
393
438
  /**
@@ -402,12 +447,20 @@ export declare namespace ACHTransferSimulation {
402
447
  */
403
448
  transfer_id: string;
404
449
  }
450
+ /**
451
+ * A ACH Transfer Rejection object. This field will be present in the JSON response
452
+ * if and only if `category` is equal to `ach_transfer_rejection`.
453
+ */
405
454
  interface ACHTransferRejection {
406
455
  /**
407
456
  * The identifier of the ACH Transfer that led to this Transaction.
408
457
  */
409
458
  transfer_id: string;
410
459
  }
460
+ /**
461
+ * A ACH Transfer Return object. This field will be present in the JSON response if
462
+ * and only if `category` is equal to `ach_transfer_return`.
463
+ */
411
464
  interface ACHTransferReturn {
412
465
  /**
413
466
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -450,6 +503,10 @@ export declare namespace ACHTransferSimulation {
450
503
  */
451
504
  transfer_id: string;
452
505
  }
506
+ /**
507
+ * A Card Dispute Acceptance object. This field will be present in the JSON
508
+ * response if and only if `category` is equal to `card_dispute_acceptance`.
509
+ */
453
510
  interface CardDisputeAcceptance {
454
511
  /**
455
512
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -464,44 +521,106 @@ export declare namespace ACHTransferSimulation {
464
521
  * The identifier of the Transaction that was created to return the disputed funds
465
522
  * to your account.
466
523
  */
467
- transaction_id: string | null;
524
+ transaction_id: string;
468
525
  }
526
+ /**
527
+ * A Card Refund object. This field will be present in the JSON response if and
528
+ * only if `category` is equal to `card_refund`.
529
+ */
469
530
  interface CardRefund {
470
531
  /**
471
532
  * The pending amount in the minor unit of the transaction's currency. For dollars,
472
533
  * for example, this is cents.
473
534
  */
474
535
  amount: number;
475
- /**
476
- * The identifier for the Transaction this refunds, if any.
477
- */
478
- card_settlement_transaction_id: string | null;
479
536
  /**
480
537
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
481
538
  * transaction's currency.
482
539
  */
483
540
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
541
+ /**
542
+ * The Card Refund identifier.
543
+ */
544
+ id: string;
545
+ /**
546
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
547
+ * is transacting with.
548
+ */
549
+ merchant_acceptor_id: string | null;
550
+ /**
551
+ * The 4-digit MCC describing the merchant's business.
552
+ */
553
+ merchant_category_code: string;
554
+ /**
555
+ * The city the merchant resides in.
556
+ */
557
+ merchant_city: string | null;
558
+ /**
559
+ * The country the merchant resides in.
560
+ */
561
+ merchant_country: string;
562
+ /**
563
+ * The name of the merchant.
564
+ */
565
+ merchant_name: string | null;
566
+ /**
567
+ * The state the merchant resides in.
568
+ */
569
+ merchant_state: string | null;
484
570
  /**
485
571
  * A constant representing the object's type. For this resource it will always be
486
572
  * `card_refund`.
487
573
  */
488
574
  type: 'card_refund';
489
575
  }
576
+ /**
577
+ * A Card Settlement object. This field will be present in the JSON response if and
578
+ * only if `category` is equal to `card_settlement`.
579
+ */
490
580
  interface CardSettlement {
491
581
  /**
492
582
  * The amount in the minor unit of the transaction's settlement currency. For
493
583
  * dollars, for example, this is cents.
494
584
  */
495
585
  amount: number;
586
+ /**
587
+ * The Card Authorization that was created prior to this Card Settlement, if on
588
+ * exists.
589
+ */
590
+ card_authorization: string | null;
496
591
  /**
497
592
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
498
593
  * transaction's settlement currency.
499
594
  */
500
595
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
596
+ /**
597
+ * The Card Settlement identifier.
598
+ */
599
+ id: string;
600
+ /**
601
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
602
+ * is transacting with.
603
+ */
604
+ merchant_acceptor_id: string | null;
605
+ /**
606
+ * The 4-digit MCC describing the merchant's business.
607
+ */
501
608
  merchant_category_code: string;
609
+ /**
610
+ * The city the merchant resides in.
611
+ */
502
612
  merchant_city: string | null;
613
+ /**
614
+ * The country the merchant resides in.
615
+ */
503
616
  merchant_country: string;
617
+ /**
618
+ * The name of the merchant.
619
+ */
504
620
  merchant_name: string | null;
621
+ /**
622
+ * The state the merchant resides in.
623
+ */
505
624
  merchant_state: string | null;
506
625
  /**
507
626
  * The identifier of the Pending Transaction associated with this Transaction.
@@ -522,6 +641,38 @@ export declare namespace ACHTransferSimulation {
522
641
  */
523
642
  type: 'card_settlement';
524
643
  }
644
+ /**
645
+ * A Card Revenue Payment object. This field will be present in the JSON response
646
+ * if and only if `category` is equal to `card_revenue_payment`.
647
+ */
648
+ interface CardRevenuePayment {
649
+ /**
650
+ * The amount in the minor unit of the transaction's currency. For dollars, for
651
+ * example, this is cents.
652
+ */
653
+ amount: number;
654
+ /**
655
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
656
+ * currency.
657
+ */
658
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
659
+ /**
660
+ * The end of the period for which this transaction paid interest.
661
+ */
662
+ period_end: string;
663
+ /**
664
+ * The start of the period for which this transaction paid interest.
665
+ */
666
+ period_start: string;
667
+ /**
668
+ * The account the card belonged to.
669
+ */
670
+ transacted_on_account_id: string | null;
671
+ }
672
+ /**
673
+ * A Check Deposit Acceptance object. This field will be present in the JSON
674
+ * response if and only if `category` is equal to `check_deposit_acceptance`.
675
+ */
525
676
  interface CheckDepositAcceptance {
526
677
  /**
527
678
  * The account number printed on the check.
@@ -556,6 +707,10 @@ export declare namespace ACHTransferSimulation {
556
707
  */
557
708
  serial_number: string | null;
558
709
  }
710
+ /**
711
+ * A Check Deposit Return object. This field will be present in the JSON response
712
+ * if and only if `category` is equal to `check_deposit_return`.
713
+ */
559
714
  interface CheckDepositReturn {
560
715
  /**
561
716
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -594,6 +749,10 @@ export declare namespace ACHTransferSimulation {
594
749
  */
595
750
  transaction_id: string;
596
751
  }
752
+ /**
753
+ * A Check Transfer Intention object. This field will be present in the JSON
754
+ * response if and only if `category` is equal to `check_transfer_intention`.
755
+ */
597
756
  interface CheckTransferIntention {
598
757
  /**
599
758
  * The city of the check's destination.
@@ -633,22 +792,49 @@ export declare namespace ACHTransferSimulation {
633
792
  */
634
793
  transfer_id: string;
635
794
  }
795
+ /**
796
+ * A Check Transfer Return object. This field will be present in the JSON response
797
+ * if and only if `category` is equal to `check_transfer_return`.
798
+ */
636
799
  interface CheckTransferReturn {
637
800
  /**
638
801
  * If available, a document with additional information about the return.
639
802
  */
640
803
  file_id: string | null;
804
+ /**
805
+ * The reason why the check was returned.
806
+ */
807
+ reason: 'mail_delivery_failure' | 'refused_by_recipient' | 'returned_not_authorized';
808
+ /**
809
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
810
+ * the check was returned.
811
+ */
812
+ returned_at: string;
813
+ /**
814
+ * The identifier of the Transaction that was created to credit you for the
815
+ * returned check.
816
+ */
817
+ transaction_id: string | null;
641
818
  /**
642
819
  * The identifier of the returned Check Transfer.
643
820
  */
644
821
  transfer_id: string;
645
822
  }
823
+ /**
824
+ * A Check Transfer Rejection object. This field will be present in the JSON
825
+ * response if and only if `category` is equal to `check_transfer_rejection`.
826
+ */
646
827
  interface CheckTransferRejection {
647
828
  /**
648
829
  * The identifier of the Check Transfer that led to this Transaction.
649
830
  */
650
831
  transfer_id: string;
651
832
  }
833
+ /**
834
+ * A Check Transfer Stop Payment Request object. This field will be present in the
835
+ * JSON response if and only if `category` is equal to
836
+ * `check_transfer_stop_payment_request`.
837
+ */
652
838
  interface CheckTransferStopPaymentRequest {
653
839
  /**
654
840
  * The time the stop-payment was requested.
@@ -668,6 +854,10 @@ export declare namespace ACHTransferSimulation {
668
854
  */
669
855
  type: 'check_transfer_stop_payment_request';
670
856
  }
857
+ /**
858
+ * A Dispute Resolution object. This field will be present in the JSON response if
859
+ * and only if `category` is equal to `dispute_resolution`.
860
+ */
671
861
  interface DisputeResolution {
672
862
  /**
673
863
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -684,6 +874,10 @@ export declare namespace ACHTransferSimulation {
684
874
  */
685
875
  disputed_transaction_id: string;
686
876
  }
877
+ /**
878
+ * A Empyreal Cash Deposit object. This field will be present in the JSON response
879
+ * if and only if `category` is equal to `empyreal_cash_deposit`.
880
+ */
687
881
  interface EmpyrealCashDeposit {
688
882
  /**
689
883
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -693,6 +887,26 @@ export declare namespace ACHTransferSimulation {
693
887
  bag_id: string;
694
888
  deposit_date: string;
695
889
  }
890
+ /**
891
+ * A Fee Payment object. This field will be present in the JSON response if and
892
+ * only if `category` is equal to `fee_payment`.
893
+ */
894
+ interface FeePayment {
895
+ /**
896
+ * The amount in the minor unit of the transaction's currency. For dollars, for
897
+ * example, this is cents.
898
+ */
899
+ amount: number;
900
+ /**
901
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
902
+ * currency.
903
+ */
904
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
905
+ }
906
+ /**
907
+ * A Inbound ACH Transfer object. This field will be present in the JSON response
908
+ * if and only if `category` is equal to `inbound_ach_transfer`.
909
+ */
696
910
  interface InboundACHTransfer {
697
911
  /**
698
912
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -708,6 +922,10 @@ export declare namespace ACHTransferSimulation {
708
922
  receiver_name: string | null;
709
923
  trace_number: string;
710
924
  }
925
+ /**
926
+ * A Inbound Check object. This field will be present in the JSON response if and
927
+ * only if `category` is equal to `inbound_check`.
928
+ */
711
929
  interface InboundCheck {
712
930
  /**
713
931
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -723,6 +941,11 @@ export declare namespace ACHTransferSimulation {
723
941
  */
724
942
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
725
943
  }
944
+ /**
945
+ * A Inbound International ACH Transfer object. This field will be present in the
946
+ * JSON response if and only if `category` is equal to
947
+ * `inbound_international_ach_transfer`.
948
+ */
726
949
  interface InboundInternationalACHTransfer {
727
950
  /**
728
951
  * The amount in the minor unit of the destination account currency. For dollars,
@@ -765,6 +988,11 @@ export declare namespace ACHTransferSimulation {
765
988
  receiving_depository_financial_institution_name: string;
766
989
  trace_number: string;
767
990
  }
991
+ /**
992
+ * A Inbound Real Time Payments Transfer Confirmation object. This field will be
993
+ * present in the JSON response if and only if `category` is equal to
994
+ * `inbound_real_time_payments_transfer_confirmation`.
995
+ */
768
996
  interface InboundRealTimePaymentsTransferConfirmation {
769
997
  /**
770
998
  * The amount in the minor unit of the transfer's currency. For dollars, for
@@ -801,6 +1029,11 @@ export declare namespace ACHTransferSimulation {
801
1029
  */
802
1030
  transaction_identification: string;
803
1031
  }
1032
+ /**
1033
+ * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
1034
+ * the JSON response if and only if `category` is equal to
1035
+ * `inbound_wire_drawdown_payment_reversal`.
1036
+ */
804
1037
  interface InboundWireDrawdownPaymentReversal {
805
1038
  /**
806
1039
  * The amount that was reversed.
@@ -843,6 +1076,10 @@ export declare namespace ACHTransferSimulation {
843
1076
  */
844
1077
  previous_message_input_source: string;
845
1078
  }
1079
+ /**
1080
+ * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
1081
+ * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
1082
+ */
846
1083
  interface InboundWireDrawdownPayment {
847
1084
  /**
848
1085
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -862,11 +1099,20 @@ export declare namespace ACHTransferSimulation {
862
1099
  originator_name: string | null;
863
1100
  originator_to_beneficiary_information: string | null;
864
1101
  }
1102
+ /**
1103
+ * A Inbound Wire Reversal object. This field will be present in the JSON response
1104
+ * if and only if `category` is equal to `inbound_wire_reversal`.
1105
+ */
865
1106
  interface InboundWireReversal {
866
1107
  /**
867
1108
  * The amount that was reversed.
868
1109
  */
869
1110
  amount: number;
1111
+ /**
1112
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1113
+ * the reversal was created.
1114
+ */
1115
+ created_at: string;
870
1116
  /**
871
1117
  * The description on the reversal message from Fedwire.
872
1118
  */
@@ -912,7 +1158,19 @@ export declare namespace ACHTransferSimulation {
912
1158
  * institution.
913
1159
  */
914
1160
  receiver_financial_institution_information: string | null;
1161
+ /**
1162
+ * The ID for the Transaction associated with the transfer reversal.
1163
+ */
1164
+ transaction_id: string | null;
1165
+ /**
1166
+ * The ID for the Wire Transfer that is being reversed.
1167
+ */
1168
+ wire_transfer_id: string;
915
1169
  }
1170
+ /**
1171
+ * A Inbound Wire Transfer object. This field will be present in the JSON response
1172
+ * if and only if `category` is equal to `inbound_wire_transfer`.
1173
+ */
916
1174
  interface InboundWireTransfer {
917
1175
  /**
918
1176
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -936,6 +1194,10 @@ export declare namespace ACHTransferSimulation {
936
1194
  originator_to_beneficiary_information_line3: string | null;
937
1195
  originator_to_beneficiary_information_line4: string | null;
938
1196
  }
1197
+ /**
1198
+ * A Interest Payment object. This field will be present in the JSON response if
1199
+ * and only if `category` is equal to `interest_payment`.
1200
+ */
939
1201
  interface InterestPayment {
940
1202
  /**
941
1203
  * The account on which the interest was accrued.
@@ -960,6 +1222,10 @@ export declare namespace ACHTransferSimulation {
960
1222
  */
961
1223
  period_start: string;
962
1224
  }
1225
+ /**
1226
+ * A Internal Source object. This field will be present in the JSON response if and
1227
+ * only if `category` is equal to `internal_source`.
1228
+ */
963
1229
  interface InternalSource {
964
1230
  /**
965
1231
  * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -974,14 +1240,20 @@ export declare namespace ACHTransferSimulation {
974
1240
  reason:
975
1241
  | 'bank_migration'
976
1242
  | 'cashback'
1243
+ | 'collection_receivable'
977
1244
  | 'empyreal_adjustment'
978
1245
  | 'error'
979
1246
  | 'error_correction'
980
1247
  | 'fees'
981
1248
  | 'interest'
1249
+ | 'negative_balance_forgiveness'
982
1250
  | 'sample_funds'
983
1251
  | 'sample_funds_return';
984
1252
  }
1253
+ /**
1254
+ * A Deprecated Card Refund object. This field will be present in the JSON response
1255
+ * if and only if `category` is equal to `card_route_refund`.
1256
+ */
985
1257
  interface CardRouteRefund {
986
1258
  /**
987
1259
  * The refunded amount in the minor unit of the refunded currency. For dollars, for
@@ -1000,6 +1272,10 @@ export declare namespace ACHTransferSimulation {
1000
1272
  merchant_descriptor: string;
1001
1273
  merchant_state: string | null;
1002
1274
  }
1275
+ /**
1276
+ * A Deprecated Card Settlement object. This field will be present in the JSON
1277
+ * response if and only if `category` is equal to `card_route_settlement`.
1278
+ */
1003
1279
  interface CardRouteSettlement {
1004
1280
  /**
1005
1281
  * The settled amount in the minor unit of the settlement currency. For dollars,
@@ -1018,12 +1294,48 @@ export declare namespace ACHTransferSimulation {
1018
1294
  merchant_descriptor: string;
1019
1295
  merchant_state: string | null;
1020
1296
  }
1297
+ /**
1298
+ * A Real Time Payments Transfer Acknowledgement object. This field will be present
1299
+ * in the JSON response if and only if `category` is equal to
1300
+ * `real_time_payments_transfer_acknowledgement`.
1301
+ */
1302
+ interface RealTimePaymentsTransferAcknowledgement {
1303
+ /**
1304
+ * The transfer amount in USD cents.
1305
+ */
1306
+ amount: number;
1307
+ /**
1308
+ * The destination account number.
1309
+ */
1310
+ destination_account_number: string;
1311
+ /**
1312
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN).
1313
+ */
1314
+ destination_routing_number: string;
1315
+ /**
1316
+ * Unstructured information that will show on the recipient's bank statement.
1317
+ */
1318
+ remittance_information: string;
1319
+ /**
1320
+ * The identifier of the Real Time Payments Transfer that led to this Transaction.
1321
+ */
1322
+ transfer_id: string;
1323
+ }
1324
+ /**
1325
+ * A Sample Funds object. This field will be present in the JSON response if and
1326
+ * only if `category` is equal to `sample_funds`.
1327
+ */
1021
1328
  interface SampleFunds {
1022
1329
  /**
1023
1330
  * Where the sample funds came from.
1024
1331
  */
1025
1332
  originator: string;
1026
1333
  }
1334
+ /**
1335
+ * A Wire Drawdown Payment Intention object. This field will be present in the JSON
1336
+ * response if and only if `category` is equal to
1337
+ * `wire_drawdown_payment_intention`.
1338
+ */
1027
1339
  interface WireDrawdownPaymentIntention {
1028
1340
  account_number: string;
1029
1341
  /**
@@ -1034,9 +1346,18 @@ export declare namespace ACHTransferSimulation {
1034
1346
  routing_number: string;
1035
1347
  transfer_id: string;
1036
1348
  }
1349
+ /**
1350
+ * A Wire Drawdown Payment Rejection object. This field will be present in the JSON
1351
+ * response if and only if `category` is equal to
1352
+ * `wire_drawdown_payment_rejection`.
1353
+ */
1037
1354
  interface WireDrawdownPaymentRejection {
1038
1355
  transfer_id: string;
1039
1356
  }
1357
+ /**
1358
+ * A Wire Transfer Intention object. This field will be present in the JSON
1359
+ * response if and only if `category` is equal to `wire_transfer_intention`.
1360
+ */
1040
1361
  interface WireTransferIntention {
1041
1362
  /**
1042
1363
  * The destination account number.
@@ -1056,11 +1377,20 @@ export declare namespace ACHTransferSimulation {
1056
1377
  routing_number: string;
1057
1378
  transfer_id: string;
1058
1379
  }
1380
+ /**
1381
+ * A Wire Transfer Rejection object. This field will be present in the JSON
1382
+ * response if and only if `category` is equal to `wire_transfer_rejection`.
1383
+ */
1059
1384
  interface WireTransferRejection {
1060
1385
  transfer_id: string;
1061
1386
  }
1062
1387
  }
1063
1388
  }
1389
+ /**
1390
+ * If the ACH Transfer attempt fails, this will contain the resulting
1391
+ * [Declined Transaction](#declined-transactions) object. The Declined
1392
+ * Transaction's `source` will be of `category: inbound_ach_transfer`.
1393
+ */
1064
1394
  interface DeclinedTransaction {
1065
1395
  /**
1066
1396
  * The identifier for the Account the Declined Transaction belongs to.
@@ -1098,7 +1428,7 @@ export declare namespace ACHTransferSimulation {
1098
1428
  /**
1099
1429
  * The type of the route this Declined Transaction came through.
1100
1430
  */
1101
- route_type: string | null;
1431
+ route_type: 'account_number' | 'card' | null;
1102
1432
  /**
1103
1433
  * This is an object giving more details on the network-level event that caused the
1104
1434
  * Declined Transaction. For example, for a card transaction this lists the
@@ -1114,6 +1444,13 @@ export declare namespace ACHTransferSimulation {
1114
1444
  type: 'declined_transaction';
1115
1445
  }
1116
1446
  namespace DeclinedTransaction {
1447
+ /**
1448
+ * This is an object giving more details on the network-level event that caused the
1449
+ * Declined Transaction. For example, for a card transaction this lists the
1450
+ * merchant's industry and location. Note that for backwards compatibility reasons,
1451
+ * additional undocumented keys may appear in this object. These should be treated
1452
+ * as deprecated and will be removed in the future.
1453
+ */
1117
1454
  interface Source {
1118
1455
  /**
1119
1456
  * A ACH Decline object. This field will be present in the JSON response if and
@@ -1142,6 +1479,7 @@ export declare namespace ACHTransferSimulation {
1142
1479
  | 'inbound_real_time_payments_transfer_decline'
1143
1480
  | 'international_ach_decline'
1144
1481
  | 'card_route_decline'
1482
+ | 'wire_decline'
1145
1483
  | 'other';
1146
1484
  /**
1147
1485
  * A Check Decline object. This field will be present in the JSON response if and
@@ -1159,8 +1497,17 @@ export declare namespace ACHTransferSimulation {
1159
1497
  * response if and only if `category` is equal to `international_ach_decline`.
1160
1498
  */
1161
1499
  international_ach_decline: Source.InternationalACHDecline | null;
1500
+ /**
1501
+ * A Wire Decline object. This field will be present in the JSON response if and
1502
+ * only if `category` is equal to `wire_decline`.
1503
+ */
1504
+ wire_decline: Source.WireDecline | null;
1162
1505
  }
1163
1506
  namespace Source {
1507
+ /**
1508
+ * A ACH Decline object. This field will be present in the JSON response if and
1509
+ * only if `category` is equal to `ach_decline`.
1510
+ */
1164
1511
  interface ACHDecline {
1165
1512
  /**
1166
1513
  * The declined amount in the minor unit of the destination account currency. For
@@ -1181,15 +1528,20 @@ export declare namespace ACHTransferSimulation {
1181
1528
  | 'credit_entry_refused_by_receiver'
1182
1529
  | 'duplicate_return'
1183
1530
  | 'entity_not_active'
1184
- | 'transaction_not_allowed'
1185
1531
  | 'group_locked'
1186
1532
  | 'insufficient_funds'
1533
+ | 'misrouted_return'
1187
1534
  | 'no_ach_route'
1188
- | 'originator_request';
1535
+ | 'originator_request'
1536
+ | 'transaction_not_allowed';
1189
1537
  receiver_id_number: string | null;
1190
1538
  receiver_name: string | null;
1191
1539
  trace_number: string;
1192
1540
  }
1541
+ /**
1542
+ * A Card Decline object. This field will be present in the JSON response if and
1543
+ * only if `category` is equal to `card_decline`.
1544
+ */
1193
1545
  interface CardDecline {
1194
1546
  /**
1195
1547
  * The declined amount in the minor unit of the destination account currency. For
@@ -1255,12 +1607,18 @@ export declare namespace ACHTransferSimulation {
1255
1607
  | 'insufficient_funds'
1256
1608
  | 'cvv2_mismatch'
1257
1609
  | 'transaction_not_allowed'
1610
+ | 'breaches_internal_limit'
1258
1611
  | 'breaches_limit'
1259
1612
  | 'webhook_declined'
1260
1613
  | 'webhook_timed_out'
1261
- | 'declined_by_stand_in_processing';
1614
+ | 'declined_by_stand_in_processing'
1615
+ | 'invalid_physical_card'
1616
+ | 'missing_original_authorization';
1262
1617
  }
1263
1618
  namespace CardDecline {
1619
+ /**
1620
+ * Fields specific to the `network`
1621
+ */
1264
1622
  interface NetworkDetails {
1265
1623
  /**
1266
1624
  * Fields specific to the `visa` network
@@ -1268,6 +1626,9 @@ export declare namespace ACHTransferSimulation {
1268
1626
  visa: NetworkDetails.Visa;
1269
1627
  }
1270
1628
  namespace NetworkDetails {
1629
+ /**
1630
+ * Fields specific to the `visa` network
1631
+ */
1271
1632
  interface Visa {
1272
1633
  /**
1273
1634
  * For electronic commerce transactions, this identifies the level of security used
@@ -1288,10 +1649,14 @@ export declare namespace ACHTransferSimulation {
1288
1649
  * The method used to enter the cardholder's primary account number and card
1289
1650
  * expiration date
1290
1651
  */
1291
- point_of_service_entry_mode: Shared.PointOfServiceEntryMode;
1652
+ point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
1292
1653
  }
1293
1654
  }
1294
1655
  }
1656
+ /**
1657
+ * A Check Decline object. This field will be present in the JSON response if and
1658
+ * only if `category` is equal to `check_decline`.
1659
+ */
1295
1660
  interface CheckDecline {
1296
1661
  /**
1297
1662
  * The declined amount in the minor unit of the destination account currency. For
@@ -1313,8 +1678,16 @@ export declare namespace ACHTransferSimulation {
1313
1678
  | 'unable_to_process'
1314
1679
  | 'refer_to_image'
1315
1680
  | 'stop_payment_requested'
1316
- | 'returned';
1681
+ | 'returned'
1682
+ | 'duplicate_presentment'
1683
+ | 'not_authorized'
1684
+ | 'altered_or_fictitious';
1317
1685
  }
1686
+ /**
1687
+ * A Inbound Real Time Payments Transfer Decline object. This field will be present
1688
+ * in the JSON response if and only if `category` is equal to
1689
+ * `inbound_real_time_payments_transfer_decline`.
1690
+ */
1318
1691
  interface InboundRealTimePaymentsTransferDecline {
1319
1692
  /**
1320
1693
  * The declined amount in the minor unit of the destination account currency. For
@@ -1349,6 +1722,7 @@ export declare namespace ACHTransferSimulation {
1349
1722
  reason:
1350
1723
  | 'account_number_canceled'
1351
1724
  | 'account_number_disabled'
1725
+ | 'account_restricted'
1352
1726
  | 'group_locked'
1353
1727
  | 'entity_not_active'
1354
1728
  | 'real_time_payments_not_enabled';
@@ -1361,6 +1735,10 @@ export declare namespace ACHTransferSimulation {
1361
1735
  */
1362
1736
  transaction_identification: string;
1363
1737
  }
1738
+ /**
1739
+ * A International ACH Decline object. This field will be present in the JSON
1740
+ * response if and only if `category` is equal to `international_ach_decline`.
1741
+ */
1364
1742
  interface InternationalACHDecline {
1365
1743
  /**
1366
1744
  * The declined amount in the minor unit of the destination account currency. For
@@ -1403,6 +1781,10 @@ export declare namespace ACHTransferSimulation {
1403
1781
  receiving_depository_financial_institution_name: string;
1404
1782
  trace_number: string;
1405
1783
  }
1784
+ /**
1785
+ * A Deprecated Card Decline object. This field will be present in the JSON
1786
+ * response if and only if `category` is equal to `card_route_decline`.
1787
+ */
1406
1788
  interface CardRouteDecline {
1407
1789
  /**
1408
1790
  * The declined amount in the minor unit of the destination account currency. For
@@ -1421,6 +1803,42 @@ export declare namespace ACHTransferSimulation {
1421
1803
  merchant_descriptor: string;
1422
1804
  merchant_state: string | null;
1423
1805
  }
1806
+ /**
1807
+ * A Wire Decline object. This field will be present in the JSON response if and
1808
+ * only if `category` is equal to `wire_decline`.
1809
+ */
1810
+ interface WireDecline {
1811
+ /**
1812
+ * The declined amount in the minor unit of the destination account currency. For
1813
+ * dollars, for example, this is cents.
1814
+ */
1815
+ amount: number;
1816
+ beneficiary_address_line1: string | null;
1817
+ beneficiary_address_line2: string | null;
1818
+ beneficiary_address_line3: string | null;
1819
+ beneficiary_name: string | null;
1820
+ beneficiary_reference: string | null;
1821
+ description: string;
1822
+ input_message_accountability_data: string | null;
1823
+ originator_address_line1: string | null;
1824
+ originator_address_line2: string | null;
1825
+ originator_address_line3: string | null;
1826
+ originator_name: string | null;
1827
+ originator_to_beneficiary_information_line1: string | null;
1828
+ originator_to_beneficiary_information_line2: string | null;
1829
+ originator_to_beneficiary_information_line3: string | null;
1830
+ originator_to_beneficiary_information_line4: string | null;
1831
+ /**
1832
+ * Why the wire transfer was declined.
1833
+ */
1834
+ reason:
1835
+ | 'account_number_canceled'
1836
+ | 'account_number_disabled'
1837
+ | 'entity_not_active'
1838
+ | 'group_locked'
1839
+ | 'no_account_number'
1840
+ | 'transaction_not_allowed';
1841
+ }
1424
1842
  }
1425
1843
  }
1426
1844
  }
@@ -1486,3 +1904,4 @@ export interface ACHTransferReturnParams {
1486
1904
  | 'incorrectly_coded_outbound_international_payment'
1487
1905
  | 'other';
1488
1906
  }
1907
+ //# sourceMappingURL=ach-transfers.d.ts.map