increase 0.4.0 → 0.5.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 (1008) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/README.md +20 -5
  3. package/_shims/agent.node.ts +20 -0
  4. package/_shims/agent.ts +12 -0
  5. package/_shims/fetch.node.ts +11 -0
  6. package/_shims/fetch.ts +32 -0
  7. package/_shims/fileFromPath.node.ts +30 -0
  8. package/_shims/fileFromPath.ts +30 -0
  9. package/_shims/formdata.node.ts +9 -0
  10. package/_shims/formdata.ts +22 -0
  11. package/_shims/getMultipartRequestOptions.node.ts +24 -0
  12. package/_shims/getMultipartRequestOptions.ts +13 -0
  13. package/_shims/newFileArgs.ts +94 -0
  14. package/_shims/toFile.node.ts +25 -0
  15. package/_shims/toFile.ts +26 -0
  16. package/_shims/uploadable.node.ts +21 -0
  17. package/_shims/uploadable.ts +82 -0
  18. package/core.ts +34 -87
  19. package/dist/cjs/_shims/agent.d.ts +9 -0
  20. package/dist/cjs/_shims/agent.d.ts.map +1 -0
  21. package/dist/cjs/_shims/agent.js +14 -0
  22. package/dist/cjs/_shims/agent.js.map +1 -0
  23. package/dist/cjs/_shims/agent.node.d.ts +6 -0
  24. package/dist/cjs/_shims/agent.node.d.ts.map +1 -0
  25. package/dist/cjs/_shims/agent.node.js +28 -0
  26. package/dist/cjs/_shims/agent.node.js.map +1 -0
  27. package/dist/cjs/_shims/fetch.d.ts +19 -0
  28. package/dist/cjs/_shims/fetch.d.ts.map +1 -0
  29. package/dist/cjs/_shims/fetch.js +24 -0
  30. package/dist/cjs/_shims/fetch.js.map +1 -0
  31. package/dist/cjs/_shims/fetch.node.d.ts +9 -0
  32. package/dist/cjs/_shims/fetch.node.d.ts.map +1 -0
  33. package/dist/cjs/_shims/fetch.node.js +68 -0
  34. package/dist/cjs/_shims/fetch.node.js.map +1 -0
  35. package/dist/cjs/_shims/fileFromPath.d.ts +23 -0
  36. package/dist/cjs/_shims/fileFromPath.d.ts.map +1 -0
  37. package/dist/cjs/{tests/api-resources/simulations/programs.test.js → _shims/fileFromPath.js} +16 -19
  38. package/dist/cjs/_shims/fileFromPath.js.map +1 -0
  39. package/dist/cjs/_shims/fileFromPath.node.d.ts +18 -0
  40. package/dist/cjs/_shims/fileFromPath.node.d.ts.map +1 -0
  41. package/dist/cjs/{tests/form.test.js → _shims/fileFromPath.node.js} +16 -27
  42. package/dist/cjs/_shims/fileFromPath.node.js.map +1 -0
  43. package/dist/cjs/_shims/formdata.d.ts +13 -0
  44. package/dist/cjs/_shims/formdata.d.ts.map +1 -0
  45. package/dist/cjs/_shims/formdata.js +20 -0
  46. package/dist/cjs/_shims/formdata.js.map +1 -0
  47. package/dist/cjs/_shims/formdata.node.d.ts +7 -0
  48. package/dist/cjs/_shims/formdata.node.d.ts.map +1 -0
  49. package/dist/cjs/_shims/formdata.node.js +27 -0
  50. package/dist/cjs/_shims/formdata.node.js.map +1 -0
  51. package/dist/cjs/_shims/getMultipartRequestOptions.d.ts +10 -0
  52. package/dist/cjs/_shims/getMultipartRequestOptions.d.ts.map +1 -0
  53. package/dist/cjs/{tests/api-resources/simulations/documents.test.js → _shims/getMultipartRequestOptions.js} +11 -19
  54. package/dist/cjs/_shims/getMultipartRequestOptions.js.map +1 -0
  55. package/dist/cjs/_shims/getMultipartRequestOptions.node.d.ts +10 -0
  56. package/dist/cjs/_shims/getMultipartRequestOptions.node.d.ts.map +1 -0
  57. package/dist/cjs/{tests/api-resources/simulations/card-refunds.test.js → _shims/getMultipartRequestOptions.node.js} +19 -19
  58. package/dist/cjs/_shims/getMultipartRequestOptions.node.js.map +1 -0
  59. package/dist/cjs/_shims/newFileArgs.d.ts +19 -0
  60. package/dist/cjs/_shims/newFileArgs.d.ts.map +1 -0
  61. package/dist/cjs/_shims/newFileArgs.js +169 -0
  62. package/dist/cjs/_shims/newFileArgs.js.map +1 -0
  63. package/dist/cjs/_shims/toFile.d.ts +21 -0
  64. package/dist/cjs/_shims/toFile.d.ts.map +1 -0
  65. package/dist/cjs/_shims/toFile.js +56 -0
  66. package/dist/cjs/_shims/toFile.js.map +1 -0
  67. package/dist/cjs/_shims/toFile.node.d.ts +20 -0
  68. package/dist/cjs/_shims/toFile.node.d.ts.map +1 -0
  69. package/dist/cjs/_shims/toFile.node.js +56 -0
  70. package/dist/cjs/_shims/toFile.node.js.map +1 -0
  71. package/dist/cjs/_shims/uploadable.d.ts +56 -0
  72. package/dist/cjs/_shims/uploadable.d.ts.map +1 -0
  73. package/dist/cjs/_shims/uploadable.js +37 -0
  74. package/dist/cjs/_shims/uploadable.js.map +1 -0
  75. package/dist/cjs/_shims/uploadable.node.d.ts +7 -0
  76. package/dist/cjs/_shims/uploadable.node.d.ts.map +1 -0
  77. package/dist/cjs/_shims/uploadable.node.js +23 -0
  78. package/dist/cjs/_shims/uploadable.node.js.map +1 -0
  79. package/dist/cjs/core.d.ts +6 -17
  80. package/dist/cjs/core.d.ts.map +1 -1
  81. package/dist/cjs/core.js +45 -74
  82. package/dist/cjs/core.js.map +1 -1
  83. package/dist/cjs/error.js +28 -28
  84. package/dist/cjs/error.js.map +1 -1
  85. package/dist/cjs/index.d.ts +43 -3
  86. package/dist/cjs/index.d.ts.map +1 -1
  87. package/dist/cjs/index.js +48 -4
  88. package/dist/cjs/index.js.map +1 -1
  89. package/dist/cjs/pagination.d.ts +3 -1
  90. package/dist/cjs/pagination.d.ts.map +1 -1
  91. package/dist/cjs/pagination.js.map +1 -1
  92. package/dist/cjs/resources/account-numbers.d.ts +12 -4
  93. package/dist/cjs/resources/account-numbers.d.ts.map +1 -1
  94. package/dist/cjs/resources/account-numbers.js +44 -0
  95. package/dist/cjs/resources/account-numbers.js.map +1 -1
  96. package/dist/cjs/resources/account-statements.d.ts +10 -4
  97. package/dist/cjs/resources/account-statements.d.ts.map +1 -1
  98. package/dist/cjs/resources/account-statements.js +44 -0
  99. package/dist/cjs/resources/account-statements.js.map +1 -1
  100. package/dist/cjs/resources/account-transfers.d.ts +11 -4
  101. package/dist/cjs/resources/account-transfers.d.ts.map +1 -1
  102. package/dist/cjs/resources/account-transfers.js +44 -0
  103. package/dist/cjs/resources/account-transfers.js.map +1 -1
  104. package/dist/cjs/resources/accounts.d.ts +12 -4
  105. package/dist/cjs/resources/accounts.d.ts.map +1 -1
  106. package/dist/cjs/resources/accounts.js +44 -0
  107. package/dist/cjs/resources/accounts.js.map +1 -1
  108. package/dist/cjs/resources/ach-prenotifications.d.ts +11 -4
  109. package/dist/cjs/resources/ach-prenotifications.d.ts.map +1 -1
  110. package/dist/cjs/resources/ach-prenotifications.js +44 -0
  111. package/dist/cjs/resources/ach-prenotifications.js.map +1 -1
  112. package/dist/cjs/resources/ach-transfers.d.ts +11 -5
  113. package/dist/cjs/resources/ach-transfers.d.ts.map +1 -1
  114. package/dist/cjs/resources/ach-transfers.js +44 -0
  115. package/dist/cjs/resources/ach-transfers.js.map +1 -1
  116. package/dist/cjs/resources/balance-lookups.d.ts +5 -0
  117. package/dist/cjs/resources/balance-lookups.d.ts.map +1 -1
  118. package/dist/cjs/resources/balance-lookups.js +1 -0
  119. package/dist/cjs/resources/balance-lookups.js.map +1 -1
  120. package/dist/cjs/resources/bookkeeping-accounts.d.ts +11 -4
  121. package/dist/cjs/resources/bookkeeping-accounts.d.ts.map +1 -1
  122. package/dist/cjs/resources/bookkeeping-accounts.js +44 -0
  123. package/dist/cjs/resources/bookkeeping-accounts.js.map +1 -1
  124. package/dist/cjs/resources/bookkeeping-entries.d.ts +10 -4
  125. package/dist/cjs/resources/bookkeeping-entries.d.ts.map +1 -1
  126. package/dist/cjs/resources/bookkeeping-entries.js +44 -0
  127. package/dist/cjs/resources/bookkeeping-entries.js.map +1 -1
  128. package/dist/cjs/resources/bookkeeping-entry-sets.d.ts +17 -12
  129. package/dist/cjs/resources/bookkeeping-entry-sets.d.ts.map +1 -1
  130. package/dist/cjs/resources/bookkeeping-entry-sets.js +3 -0
  131. package/dist/cjs/resources/bookkeeping-entry-sets.js.map +1 -1
  132. package/dist/cjs/resources/card-disputes.d.ts +11 -4
  133. package/dist/cjs/resources/card-disputes.d.ts.map +1 -1
  134. package/dist/cjs/resources/card-disputes.js +44 -0
  135. package/dist/cjs/resources/card-disputes.js.map +1 -1
  136. package/dist/cjs/resources/card-profiles.d.ts +11 -4
  137. package/dist/cjs/resources/card-profiles.d.ts.map +1 -1
  138. package/dist/cjs/resources/card-profiles.js +44 -0
  139. package/dist/cjs/resources/card-profiles.js.map +1 -1
  140. package/dist/cjs/resources/cards.d.ts +15 -6
  141. package/dist/cjs/resources/cards.d.ts.map +1 -1
  142. package/dist/cjs/resources/cards.js +44 -0
  143. package/dist/cjs/resources/cards.js.map +1 -1
  144. package/dist/cjs/resources/check-deposits.d.ts +11 -4
  145. package/dist/cjs/resources/check-deposits.d.ts.map +1 -1
  146. package/dist/cjs/resources/check-deposits.js +44 -0
  147. package/dist/cjs/resources/check-deposits.js.map +1 -1
  148. package/dist/cjs/resources/check-transfers.d.ts +83 -75
  149. package/dist/cjs/resources/check-transfers.d.ts.map +1 -1
  150. package/dist/cjs/resources/check-transfers.js +44 -0
  151. package/dist/cjs/resources/check-transfers.js.map +1 -1
  152. package/dist/cjs/resources/declined-transactions.d.ts +10 -4
  153. package/dist/cjs/resources/declined-transactions.d.ts.map +1 -1
  154. package/dist/cjs/resources/declined-transactions.js +44 -0
  155. package/dist/cjs/resources/declined-transactions.js.map +1 -1
  156. package/dist/cjs/resources/digital-wallet-tokens.d.ts +10 -4
  157. package/dist/cjs/resources/digital-wallet-tokens.d.ts.map +1 -1
  158. package/dist/cjs/resources/digital-wallet-tokens.js +44 -0
  159. package/dist/cjs/resources/digital-wallet-tokens.js.map +1 -1
  160. package/dist/cjs/resources/documents.d.ts +12 -105
  161. package/dist/cjs/resources/documents.d.ts.map +1 -1
  162. package/dist/cjs/resources/documents.js +44 -0
  163. package/dist/cjs/resources/documents.js.map +1 -1
  164. package/dist/cjs/resources/entities/entities.d.ts +291 -279
  165. package/dist/cjs/resources/entities/entities.d.ts.map +1 -1
  166. package/dist/cjs/resources/entities/entities.js +46 -0
  167. package/dist/cjs/resources/entities/entities.js.map +1 -1
  168. package/dist/cjs/resources/entities/index.d.ts +2 -1
  169. package/dist/cjs/resources/entities/index.d.ts.map +1 -1
  170. package/dist/cjs/resources/entities/index.js +17 -1
  171. package/dist/cjs/resources/entities/index.js.map +1 -1
  172. package/dist/cjs/resources/entities/supplemental-documents.d.ts +7 -0
  173. package/dist/cjs/resources/entities/supplemental-documents.d.ts.map +1 -1
  174. package/dist/cjs/resources/entities/supplemental-documents.js +44 -0
  175. package/dist/cjs/resources/entities/supplemental-documents.js.map +1 -1
  176. package/dist/cjs/resources/event-subscriptions.d.ts +12 -4
  177. package/dist/cjs/resources/event-subscriptions.d.ts.map +1 -1
  178. package/dist/cjs/resources/event-subscriptions.js +44 -0
  179. package/dist/cjs/resources/event-subscriptions.js.map +1 -1
  180. package/dist/cjs/resources/events.d.ts +10 -4
  181. package/dist/cjs/resources/events.d.ts.map +1 -1
  182. package/dist/cjs/resources/events.js +44 -0
  183. package/dist/cjs/resources/events.js.map +1 -1
  184. package/dist/cjs/resources/exports.d.ts +11 -4
  185. package/dist/cjs/resources/exports.d.ts.map +1 -1
  186. package/dist/cjs/resources/exports.js +44 -0
  187. package/dist/cjs/resources/exports.js.map +1 -1
  188. package/dist/cjs/resources/external-accounts.d.ts +12 -4
  189. package/dist/cjs/resources/external-accounts.d.ts.map +1 -1
  190. package/dist/cjs/resources/external-accounts.js +44 -0
  191. package/dist/cjs/resources/external-accounts.js.map +1 -1
  192. package/dist/cjs/resources/files.d.ts +19 -6
  193. package/dist/cjs/resources/files.d.ts.map +1 -1
  194. package/dist/cjs/resources/files.js +82 -2
  195. package/dist/cjs/resources/files.js.map +1 -1
  196. package/dist/cjs/resources/groups.d.ts +8 -4
  197. package/dist/cjs/resources/groups.d.ts.map +1 -1
  198. package/dist/cjs/resources/groups.js +1 -0
  199. package/dist/cjs/resources/groups.js.map +1 -1
  200. package/dist/cjs/resources/inbound-ach-transfer-returns.d.ts +7 -0
  201. package/dist/cjs/resources/inbound-ach-transfer-returns.d.ts.map +1 -1
  202. package/dist/cjs/resources/inbound-ach-transfer-returns.js +46 -0
  203. package/dist/cjs/resources/inbound-ach-transfer-returns.js.map +1 -1
  204. package/dist/cjs/resources/inbound-wire-drawdown-requests.d.ts +10 -4
  205. package/dist/cjs/resources/inbound-wire-drawdown-requests.d.ts.map +1 -1
  206. package/dist/cjs/resources/inbound-wire-drawdown-requests.js +47 -0
  207. package/dist/cjs/resources/inbound-wire-drawdown-requests.js.map +1 -1
  208. package/dist/cjs/resources/limits.d.ts +8 -0
  209. package/dist/cjs/resources/limits.d.ts.map +1 -1
  210. package/dist/cjs/resources/limits.js +44 -0
  211. package/dist/cjs/resources/limits.js.map +1 -1
  212. package/dist/cjs/resources/oauth-connections.d.ts +10 -4
  213. package/dist/cjs/resources/oauth-connections.d.ts.map +1 -1
  214. package/dist/cjs/resources/oauth-connections.js +44 -0
  215. package/dist/cjs/resources/oauth-connections.js.map +1 -1
  216. package/dist/cjs/resources/pending-transactions.d.ts +14 -8
  217. package/dist/cjs/resources/pending-transactions.d.ts.map +1 -1
  218. package/dist/cjs/resources/pending-transactions.js +44 -0
  219. package/dist/cjs/resources/pending-transactions.js.map +1 -1
  220. package/dist/cjs/resources/programs.d.ts +10 -4
  221. package/dist/cjs/resources/programs.d.ts.map +1 -1
  222. package/dist/cjs/resources/programs.js +44 -0
  223. package/dist/cjs/resources/programs.js.map +1 -1
  224. package/dist/cjs/resources/real-time-decisions.d.ts +33 -28
  225. package/dist/cjs/resources/real-time-decisions.d.ts.map +1 -1
  226. package/dist/cjs/resources/real-time-decisions.js +3 -0
  227. package/dist/cjs/resources/real-time-decisions.js.map +1 -1
  228. package/dist/cjs/resources/real-time-payments-transfers.d.ts +26 -19
  229. package/dist/cjs/resources/real-time-payments-transfers.d.ts.map +1 -1
  230. package/dist/cjs/resources/real-time-payments-transfers.js +46 -0
  231. package/dist/cjs/resources/real-time-payments-transfers.js.map +1 -1
  232. package/dist/cjs/resources/routing-numbers.d.ts +6 -0
  233. package/dist/cjs/resources/routing-numbers.d.ts.map +1 -1
  234. package/dist/cjs/resources/routing-numbers.js +44 -0
  235. package/dist/cjs/resources/routing-numbers.js.map +1 -1
  236. package/dist/cjs/resources/simulations/account-statements.d.ts +4 -0
  237. package/dist/cjs/resources/simulations/account-statements.d.ts.map +1 -1
  238. package/dist/cjs/resources/simulations/account-statements.js +3 -0
  239. package/dist/cjs/resources/simulations/account-statements.js.map +1 -1
  240. package/dist/cjs/resources/simulations/ach-transfers.d.ts +1236 -1201
  241. package/dist/cjs/resources/simulations/ach-transfers.d.ts.map +1 -1
  242. package/dist/cjs/resources/simulations/ach-transfers.js +1 -0
  243. package/dist/cjs/resources/simulations/ach-transfers.js.map +1 -1
  244. package/dist/cjs/resources/simulations/card-disputes.d.ts +4 -0
  245. package/dist/cjs/resources/simulations/card-disputes.d.ts.map +1 -1
  246. package/dist/cjs/resources/simulations/card-disputes.js +1 -0
  247. package/dist/cjs/resources/simulations/card-disputes.js.map +1 -1
  248. package/dist/cjs/resources/simulations/card-refunds.d.ts +4 -0
  249. package/dist/cjs/resources/simulations/card-refunds.d.ts.map +1 -1
  250. package/dist/cjs/resources/simulations/card-refunds.js +1 -0
  251. package/dist/cjs/resources/simulations/card-refunds.js.map +1 -1
  252. package/dist/cjs/resources/simulations/cards.d.ts +453 -447
  253. package/dist/cjs/resources/simulations/cards.d.ts.map +1 -1
  254. package/dist/cjs/resources/simulations/cards.js +1 -0
  255. package/dist/cjs/resources/simulations/cards.js.map +1 -1
  256. package/dist/cjs/resources/simulations/check-transfers.d.ts +4 -0
  257. package/dist/cjs/resources/simulations/check-transfers.d.ts.map +1 -1
  258. package/dist/cjs/resources/simulations/check-transfers.js +1 -0
  259. package/dist/cjs/resources/simulations/check-transfers.js.map +1 -1
  260. package/dist/cjs/resources/simulations/digital-wallet-token-requests.d.ts +5 -0
  261. package/dist/cjs/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -1
  262. package/dist/cjs/resources/simulations/digital-wallet-token-requests.js +4 -0
  263. package/dist/cjs/resources/simulations/digital-wallet-token-requests.js.map +1 -1
  264. package/dist/cjs/resources/simulations/documents.d.ts +4 -0
  265. package/dist/cjs/resources/simulations/documents.d.ts.map +1 -1
  266. package/dist/cjs/resources/simulations/documents.js +1 -0
  267. package/dist/cjs/resources/simulations/documents.js.map +1 -1
  268. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.d.ts +4 -0
  269. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -1
  270. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.js +4 -0
  271. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.js.map +1 -1
  272. package/dist/cjs/resources/simulations/index.d.ts +23 -10
  273. package/dist/cjs/resources/simulations/index.d.ts.map +1 -1
  274. package/dist/cjs/resources/simulations/index.js +129 -0
  275. package/dist/cjs/resources/simulations/index.js.map +1 -1
  276. package/dist/cjs/resources/simulations/interest-payments.d.ts +117 -82
  277. package/dist/cjs/resources/simulations/interest-payments.d.ts.map +1 -1
  278. package/dist/cjs/resources/simulations/interest-payments.js +3 -0
  279. package/dist/cjs/resources/simulations/interest-payments.js.map +1 -1
  280. package/dist/cjs/resources/simulations/programs.d.ts +4 -0
  281. package/dist/cjs/resources/simulations/programs.d.ts.map +1 -1
  282. package/dist/cjs/resources/simulations/programs.js +1 -0
  283. package/dist/cjs/resources/simulations/programs.js.map +1 -1
  284. package/dist/cjs/resources/simulations/real-time-payments-transfers.d.ts +1236 -1200
  285. package/dist/cjs/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  286. package/dist/cjs/resources/simulations/real-time-payments-transfers.js +3 -0
  287. package/dist/cjs/resources/simulations/real-time-payments-transfers.js.map +1 -1
  288. package/dist/cjs/resources/simulations/simulations.d.ts +40 -0
  289. package/dist/cjs/resources/simulations/simulations.d.ts.map +1 -1
  290. package/dist/cjs/resources/simulations/simulations.js +58 -0
  291. package/dist/cjs/resources/simulations/simulations.js.map +1 -1
  292. package/dist/cjs/resources/simulations/wire-transfers.d.ts +117 -82
  293. package/dist/cjs/resources/simulations/wire-transfers.d.ts.map +1 -1
  294. package/dist/cjs/resources/simulations/wire-transfers.js +1 -0
  295. package/dist/cjs/resources/simulations/wire-transfers.js.map +1 -1
  296. package/dist/cjs/resources/transactions.d.ts +122 -85
  297. package/dist/cjs/resources/transactions.d.ts.map +1 -1
  298. package/dist/cjs/resources/transactions.js +44 -0
  299. package/dist/cjs/resources/transactions.js.map +1 -1
  300. package/dist/cjs/resources/wire-drawdown-requests.d.ts +11 -4
  301. package/dist/cjs/resources/wire-drawdown-requests.d.ts.map +1 -1
  302. package/dist/cjs/resources/wire-drawdown-requests.js +44 -0
  303. package/dist/cjs/resources/wire-drawdown-requests.js.map +1 -1
  304. package/dist/cjs/resources/wire-transfers.d.ts +11 -4
  305. package/dist/cjs/resources/wire-transfers.d.ts.map +1 -1
  306. package/dist/cjs/resources/wire-transfers.js +44 -0
  307. package/dist/cjs/resources/wire-transfers.js.map +1 -1
  308. package/dist/cjs/streaming.d.ts +1 -2
  309. package/dist/cjs/streaming.d.ts.map +1 -1
  310. package/dist/cjs/streaming.js +2 -0
  311. package/dist/cjs/streaming.js.map +1 -1
  312. package/dist/cjs/uploads.d.ts +24 -0
  313. package/dist/cjs/uploads.d.ts.map +1 -0
  314. package/dist/cjs/uploads.js +121 -0
  315. package/dist/cjs/uploads.js.map +1 -0
  316. package/dist/cjs/version.d.ts +1 -1
  317. package/dist/cjs/version.js +1 -1
  318. package/dist/esm/_shims/agent.d.ts +9 -0
  319. package/dist/esm/_shims/agent.d.ts.map +1 -0
  320. package/dist/esm/_shims/agent.js +10 -0
  321. package/dist/esm/_shims/agent.js.map +1 -0
  322. package/dist/esm/_shims/agent.node.d.ts +6 -0
  323. package/dist/esm/_shims/agent.node.d.ts.map +1 -0
  324. package/dist/esm/_shims/agent.node.js +16 -0
  325. package/dist/esm/_shims/agent.node.js.map +1 -0
  326. package/dist/esm/_shims/fetch.d.ts +19 -0
  327. package/dist/esm/_shims/fetch.d.ts.map +1 -0
  328. package/dist/esm/_shims/fetch.js +18 -0
  329. package/dist/esm/_shims/fetch.js.map +1 -0
  330. package/dist/esm/_shims/fetch.node.d.ts +9 -0
  331. package/dist/esm/_shims/fetch.node.d.ts.map +1 -0
  332. package/dist/esm/_shims/fetch.node.js +7 -0
  333. package/dist/esm/_shims/fetch.node.js.map +1 -0
  334. package/dist/esm/_shims/fileFromPath.d.ts +23 -0
  335. package/dist/esm/_shims/fileFromPath.d.ts.map +1 -0
  336. package/dist/esm/_shims/fileFromPath.js +12 -0
  337. package/dist/esm/_shims/fileFromPath.js.map +1 -0
  338. package/dist/esm/_shims/fileFromPath.node.d.ts +18 -0
  339. package/dist/esm/_shims/fileFromPath.node.d.ts.map +1 -0
  340. package/dist/esm/_shims/fileFromPath.node.js +13 -0
  341. package/dist/esm/_shims/fileFromPath.node.js.map +1 -0
  342. package/dist/esm/_shims/formdata.d.ts +13 -0
  343. package/dist/esm/_shims/formdata.d.ts.map +1 -0
  344. package/dist/esm/_shims/formdata.js +15 -0
  345. package/dist/esm/_shims/formdata.js.map +1 -0
  346. package/dist/esm/_shims/formdata.node.d.ts +7 -0
  347. package/dist/esm/_shims/formdata.node.d.ts.map +1 -0
  348. package/dist/esm/_shims/formdata.node.js +7 -0
  349. package/dist/esm/_shims/formdata.node.js.map +1 -0
  350. package/dist/esm/_shims/getMultipartRequestOptions.d.ts +10 -0
  351. package/dist/esm/_shims/getMultipartRequestOptions.d.ts.map +1 -0
  352. package/dist/esm/_shims/getMultipartRequestOptions.js +7 -0
  353. package/dist/esm/_shims/getMultipartRequestOptions.js.map +1 -0
  354. package/dist/esm/_shims/getMultipartRequestOptions.node.d.ts +10 -0
  355. package/dist/esm/_shims/getMultipartRequestOptions.node.d.ts.map +1 -0
  356. package/dist/esm/_shims/getMultipartRequestOptions.node.js +17 -0
  357. package/dist/esm/_shims/getMultipartRequestOptions.node.js.map +1 -0
  358. package/dist/esm/_shims/newFileArgs.d.ts +19 -0
  359. package/dist/esm/_shims/newFileArgs.d.ts.map +1 -0
  360. package/dist/esm/_shims/newFileArgs.js +66 -0
  361. package/dist/esm/_shims/newFileArgs.js.map +1 -0
  362. package/dist/esm/_shims/toFile.d.ts +21 -0
  363. package/dist/esm/_shims/toFile.d.ts.map +1 -0
  364. package/dist/esm/_shims/toFile.js +19 -0
  365. package/dist/esm/_shims/toFile.js.map +1 -0
  366. package/dist/esm/_shims/toFile.node.d.ts +20 -0
  367. package/dist/esm/_shims/toFile.node.d.ts.map +1 -0
  368. package/dist/esm/_shims/toFile.node.js +19 -0
  369. package/dist/esm/_shims/toFile.node.js.map +1 -0
  370. package/dist/esm/_shims/uploadable.d.ts +56 -0
  371. package/dist/esm/_shims/uploadable.d.ts.map +1 -0
  372. package/dist/esm/_shims/uploadable.js +30 -0
  373. package/dist/esm/_shims/uploadable.js.map +1 -0
  374. package/dist/esm/_shims/uploadable.node.d.ts +7 -0
  375. package/dist/esm/_shims/uploadable.node.d.ts.map +1 -0
  376. package/dist/esm/_shims/uploadable.node.js +10 -0
  377. package/dist/esm/_shims/uploadable.node.js.map +1 -0
  378. package/dist/esm/check-version.d.ts +2 -0
  379. package/dist/esm/check-version.d.ts.map +1 -0
  380. package/dist/esm/check-version.js +16 -0
  381. package/dist/esm/check-version.js.map +1 -0
  382. package/dist/esm/core.d.ts +221 -0
  383. package/dist/esm/core.d.ts.map +1 -0
  384. package/dist/esm/core.js +556 -0
  385. package/dist/esm/core.js.map +1 -0
  386. package/dist/esm/error.d.ts +208 -0
  387. package/dist/esm/error.d.ts.map +1 -0
  388. package/dist/esm/error.js +275 -0
  389. package/dist/esm/error.js.map +1 -0
  390. package/dist/esm/index.d.ts +301 -0
  391. package/dist/esm/index.d.ts.map +1 -0
  392. package/dist/esm/index.js +213 -0
  393. package/dist/esm/index.js.map +1 -0
  394. package/dist/esm/package.json +3 -0
  395. package/dist/esm/pagination.d.ts +34 -0
  396. package/dist/esm/pagination.d.ts.map +1 -0
  397. package/dist/esm/pagination.js +26 -0
  398. package/dist/esm/pagination.js.map +1 -0
  399. package/dist/esm/resource.d.ts +12 -0
  400. package/dist/esm/resource.d.ts.map +1 -0
  401. package/dist/esm/resource.js +13 -0
  402. package/dist/esm/resource.js.map +1 -0
  403. package/dist/esm/resources/account-numbers.d.ts +137 -0
  404. package/dist/esm/resources/account-numbers.d.ts.map +1 -0
  405. package/dist/esm/resources/account-numbers.js +36 -0
  406. package/dist/esm/resources/account-numbers.js.map +1 -0
  407. package/dist/esm/resources/account-statements.d.ts +106 -0
  408. package/dist/esm/resources/account-statements.d.ts.map +1 -0
  409. package/dist/esm/resources/account-statements.js +24 -0
  410. package/dist/esm/resources/account-statements.js.map +1 -0
  411. package/dist/esm/resources/account-transfers.d.ts +205 -0
  412. package/dist/esm/resources/account-transfers.d.ts.map +1 -0
  413. package/dist/esm/resources/account-transfers.js +42 -0
  414. package/dist/esm/resources/account-transfers.js.map +1 -0
  415. package/dist/esm/resources/accounts.d.ts +163 -0
  416. package/dist/esm/resources/accounts.d.ts.map +1 -0
  417. package/dist/esm/resources/accounts.js +42 -0
  418. package/dist/esm/resources/accounts.js.map +1 -0
  419. package/dist/esm/resources/ach-prenotifications.d.ts +199 -0
  420. package/dist/esm/resources/ach-prenotifications.d.ts.map +1 -0
  421. package/dist/esm/resources/ach-prenotifications.js +30 -0
  422. package/dist/esm/resources/ach-prenotifications.js.map +1 -0
  423. package/dist/esm/resources/ach-transfers.d.ts +461 -0
  424. package/dist/esm/resources/ach-transfers.d.ts.map +1 -0
  425. package/dist/esm/resources/ach-transfers.js +42 -0
  426. package/dist/esm/resources/ach-transfers.js.map +1 -0
  427. package/dist/esm/resources/balance-lookups.d.ts +52 -0
  428. package/dist/esm/resources/balance-lookups.d.ts.map +1 -0
  429. package/dist/esm/resources/balance-lookups.js +12 -0
  430. package/dist/esm/resources/balance-lookups.js.map +1 -0
  431. package/dist/esm/resources/bookkeeping-accounts.d.ts +78 -0
  432. package/dist/esm/resources/bookkeeping-accounts.d.ts.map +1 -0
  433. package/dist/esm/resources/bookkeeping-accounts.js +24 -0
  434. package/dist/esm/resources/bookkeeping-accounts.js.map +1 -0
  435. package/dist/esm/resources/bookkeeping-entries.d.ts +49 -0
  436. package/dist/esm/resources/bookkeeping-entries.d.ts.map +1 -0
  437. package/dist/esm/resources/bookkeeping-entries.js +18 -0
  438. package/dist/esm/resources/bookkeeping-entries.js.map +1 -0
  439. package/dist/esm/resources/bookkeeping-entry-sets.d.ts +88 -0
  440. package/dist/esm/resources/bookkeeping-entry-sets.d.ts.map +1 -0
  441. package/dist/esm/resources/bookkeeping-entry-sets.js +12 -0
  442. package/dist/esm/resources/bookkeeping-entry-sets.js.map +1 -0
  443. package/dist/esm/resources/card-disputes.d.ts +160 -0
  444. package/dist/esm/resources/card-disputes.d.ts.map +1 -0
  445. package/dist/esm/resources/card-disputes.js +30 -0
  446. package/dist/esm/resources/card-disputes.js.map +1 -0
  447. package/dist/esm/resources/card-profiles.d.ts +206 -0
  448. package/dist/esm/resources/card-profiles.d.ts.map +1 -0
  449. package/dist/esm/resources/card-profiles.js +30 -0
  450. package/dist/esm/resources/card-profiles.js.map +1 -0
  451. package/dist/esm/resources/cards.d.ts +354 -0
  452. package/dist/esm/resources/cards.d.ts.map +1 -0
  453. package/dist/esm/resources/cards.js +42 -0
  454. package/dist/esm/resources/cards.js.map +1 -0
  455. package/dist/esm/resources/check-deposits.d.ts +263 -0
  456. package/dist/esm/resources/check-deposits.d.ts.map +1 -0
  457. package/dist/esm/resources/check-deposits.js +30 -0
  458. package/dist/esm/resources/check-deposits.js.map +1 -0
  459. package/dist/esm/resources/check-transfers.d.ts +438 -0
  460. package/dist/esm/resources/check-transfers.d.ts.map +1 -0
  461. package/dist/esm/resources/check-transfers.js +48 -0
  462. package/dist/esm/resources/check-transfers.js.map +1 -0
  463. package/dist/esm/resources/declined-transactions.d.ts +492 -0
  464. package/dist/esm/resources/declined-transactions.d.ts.map +1 -0
  465. package/dist/esm/resources/declined-transactions.js +24 -0
  466. package/dist/esm/resources/declined-transactions.js.map +1 -0
  467. package/dist/esm/resources/digital-wallet-tokens.d.ts +92 -0
  468. package/dist/esm/resources/digital-wallet-tokens.d.ts.map +1 -0
  469. package/dist/esm/resources/digital-wallet-tokens.js +24 -0
  470. package/dist/esm/resources/digital-wallet-tokens.js.map +1 -0
  471. package/dist/esm/resources/documents.d.ts +95 -0
  472. package/dist/esm/resources/documents.d.ts.map +1 -0
  473. package/dist/esm/resources/documents.js +24 -0
  474. package/dist/esm/resources/documents.js.map +1 -0
  475. package/dist/esm/resources/entities/entities.d.ts +1622 -0
  476. package/dist/esm/resources/entities/entities.d.ts.map +1 -0
  477. package/dist/esm/resources/entities/entities.js +37 -0
  478. package/dist/esm/resources/entities/entities.js.map +1 -0
  479. package/dist/esm/resources/entities/index.d.ts +9 -0
  480. package/dist/esm/resources/entities/index.d.ts.map +1 -0
  481. package/dist/esm/resources/entities/index.js +4 -0
  482. package/dist/esm/resources/entities/index.js.map +1 -0
  483. package/dist/esm/resources/entities/supplemental-documents.d.ts +62 -0
  484. package/dist/esm/resources/entities/supplemental-documents.d.ts.map +1 -0
  485. package/dist/esm/resources/entities/supplemental-documents.js +26 -0
  486. package/dist/esm/resources/entities/supplemental-documents.js.map +1 -0
  487. package/dist/esm/resources/event-subscriptions.d.ts +209 -0
  488. package/dist/esm/resources/event-subscriptions.d.ts.map +1 -0
  489. package/dist/esm/resources/event-subscriptions.js +36 -0
  490. package/dist/esm/resources/event-subscriptions.js.map +1 -0
  491. package/dist/esm/resources/events.d.ts +195 -0
  492. package/dist/esm/resources/events.d.ts.map +1 -0
  493. package/dist/esm/resources/events.js +24 -0
  494. package/dist/esm/resources/events.js.map +1 -0
  495. package/dist/esm/resources/exports.d.ts +169 -0
  496. package/dist/esm/resources/exports.d.ts.map +1 -0
  497. package/dist/esm/resources/exports.js +30 -0
  498. package/dist/esm/resources/exports.js.map +1 -0
  499. package/dist/esm/resources/external-accounts.d.ts +131 -0
  500. package/dist/esm/resources/external-accounts.d.ts.map +1 -0
  501. package/dist/esm/resources/external-accounts.js +36 -0
  502. package/dist/esm/resources/external-accounts.js.map +1 -0
  503. package/dist/esm/resources/files.d.ts +167 -0
  504. package/dist/esm/resources/files.d.ts.map +1 -0
  505. package/dist/esm/resources/files.js +33 -0
  506. package/dist/esm/resources/files.js.map +1 -0
  507. package/dist/esm/resources/groups.d.ts +42 -0
  508. package/dist/esm/resources/groups.d.ts.map +1 -0
  509. package/dist/esm/resources/groups.js +12 -0
  510. package/dist/esm/resources/groups.js.map +1 -0
  511. package/dist/esm/resources/inbound-ach-transfer-returns.d.ts +117 -0
  512. package/dist/esm/resources/inbound-ach-transfer-returns.d.ts.map +1 -0
  513. package/dist/esm/resources/inbound-ach-transfer-returns.js +33 -0
  514. package/dist/esm/resources/inbound-ach-transfer-returns.js.map +1 -0
  515. package/dist/esm/resources/inbound-wire-drawdown-requests.d.ts +131 -0
  516. package/dist/esm/resources/inbound-wire-drawdown-requests.d.ts.map +1 -0
  517. package/dist/esm/resources/inbound-wire-drawdown-requests.js +27 -0
  518. package/dist/esm/resources/inbound-wire-drawdown-requests.js.map +1 -0
  519. package/dist/esm/resources/index.d.ts +199 -0
  520. package/dist/esm/resources/index.d.ts.map +1 -0
  521. package/dist/esm/resources/index.js +44 -0
  522. package/dist/esm/resources/index.js.map +1 -0
  523. package/dist/esm/resources/limits.d.ts +114 -0
  524. package/dist/esm/resources/limits.d.ts.map +1 -0
  525. package/dist/esm/resources/limits.js +36 -0
  526. package/dist/esm/resources/limits.js.map +1 -0
  527. package/dist/esm/resources/oauth-connections.d.ts +57 -0
  528. package/dist/esm/resources/oauth-connections.d.ts.map +1 -0
  529. package/dist/esm/resources/oauth-connections.js +24 -0
  530. package/dist/esm/resources/oauth-connections.js.map +1 -0
  531. package/dist/esm/resources/pending-transactions.d.ts +482 -0
  532. package/dist/esm/resources/pending-transactions.d.ts.map +1 -0
  533. package/dist/esm/resources/pending-transactions.js +24 -0
  534. package/dist/esm/resources/pending-transactions.js.map +1 -0
  535. package/dist/esm/resources/programs.d.ts +54 -0
  536. package/dist/esm/resources/programs.d.ts.map +1 -0
  537. package/dist/esm/resources/programs.js +24 -0
  538. package/dist/esm/resources/programs.js.map +1 -0
  539. package/dist/esm/resources/real-time-decisions.d.ts +330 -0
  540. package/dist/esm/resources/real-time-decisions.d.ts.map +1 -0
  541. package/dist/esm/resources/real-time-decisions.js +18 -0
  542. package/dist/esm/resources/real-time-decisions.js.map +1 -0
  543. package/dist/esm/resources/real-time-payments-transfers.d.ts +294 -0
  544. package/dist/esm/resources/real-time-payments-transfers.d.ts.map +1 -0
  545. package/dist/esm/resources/real-time-payments-transfers.js +33 -0
  546. package/dist/esm/resources/real-time-payments-transfers.js.map +1 -0
  547. package/dist/esm/resources/routing-numbers.d.ts +56 -0
  548. package/dist/esm/resources/routing-numbers.d.ts.map +1 -0
  549. package/dist/esm/resources/routing-numbers.js +20 -0
  550. package/dist/esm/resources/routing-numbers.js.map +1 -0
  551. package/dist/esm/resources/shared.d.ts +16 -0
  552. package/dist/esm/resources/shared.d.ts.map +1 -0
  553. package/dist/esm/resources/shared.js +3 -0
  554. package/dist/esm/resources/shared.js.map +1 -0
  555. package/dist/esm/resources/simulations/account-statements.d.ts +24 -0
  556. package/dist/esm/resources/simulations/account-statements.d.ts.map +1 -0
  557. package/dist/esm/resources/simulations/account-statements.js +13 -0
  558. package/dist/esm/resources/simulations/account-statements.js.map +1 -0
  559. package/dist/esm/resources/simulations/account-transfers.d.ts +16 -0
  560. package/dist/esm/resources/simulations/account-transfers.d.ts.map +1 -0
  561. package/dist/esm/resources/simulations/account-transfers.js +14 -0
  562. package/dist/esm/resources/simulations/account-transfers.js.map +1 -0
  563. package/dist/esm/resources/simulations/ach-transfers.d.ts +1836 -0
  564. package/dist/esm/resources/simulations/ach-transfers.d.ts.map +1 -0
  565. package/dist/esm/resources/simulations/ach-transfers.js +36 -0
  566. package/dist/esm/resources/simulations/ach-transfers.js.map +1 -0
  567. package/dist/esm/resources/simulations/card-disputes.d.ts +31 -0
  568. package/dist/esm/resources/simulations/card-disputes.d.ts.map +1 -0
  569. package/dist/esm/resources/simulations/card-disputes.js +15 -0
  570. package/dist/esm/resources/simulations/card-disputes.js.map +1 -0
  571. package/dist/esm/resources/simulations/card-refunds.d.ts +25 -0
  572. package/dist/esm/resources/simulations/card-refunds.d.ts.map +1 -0
  573. package/dist/esm/resources/simulations/card-refunds.js +13 -0
  574. package/dist/esm/resources/simulations/card-refunds.js.map +1 -0
  575. package/dist/esm/resources/simulations/cards.d.ts +931 -0
  576. package/dist/esm/resources/simulations/cards.d.ts.map +1 -0
  577. package/dist/esm/resources/simulations/cards.js +28 -0
  578. package/dist/esm/resources/simulations/cards.js.map +1 -0
  579. package/dist/esm/resources/simulations/check-deposits.d.ts +31 -0
  580. package/dist/esm/resources/simulations/check-deposits.d.ts.map +1 -0
  581. package/dist/esm/resources/simulations/check-deposits.js +27 -0
  582. package/dist/esm/resources/simulations/check-deposits.js.map +1 -0
  583. package/dist/esm/resources/simulations/check-transfers.d.ts +42 -0
  584. package/dist/esm/resources/simulations/check-transfers.d.ts.map +1 -0
  585. package/dist/esm/resources/simulations/check-transfers.js +28 -0
  586. package/dist/esm/resources/simulations/check-transfers.js.map +1 -0
  587. package/dist/esm/resources/simulations/digital-wallet-token-requests.d.ts +49 -0
  588. package/dist/esm/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -0
  589. package/dist/esm/resources/simulations/digital-wallet-token-requests.js +13 -0
  590. package/dist/esm/resources/simulations/digital-wallet-token-requests.js.map +1 -0
  591. package/dist/esm/resources/simulations/documents.d.ts +23 -0
  592. package/dist/esm/resources/simulations/documents.d.ts.map +1 -0
  593. package/dist/esm/resources/simulations/documents.js +12 -0
  594. package/dist/esm/resources/simulations/documents.js.map +1 -0
  595. package/dist/esm/resources/simulations/inbound-wire-drawdown-requests.d.ts +106 -0
  596. package/dist/esm/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -0
  597. package/dist/esm/resources/simulations/inbound-wire-drawdown-requests.js +15 -0
  598. package/dist/esm/resources/simulations/inbound-wire-drawdown-requests.js.map +1 -0
  599. package/dist/esm/resources/simulations/index.d.ts +38 -0
  600. package/dist/esm/resources/simulations/index.d.ts.map +1 -0
  601. package/dist/esm/resources/simulations/index.js +18 -0
  602. package/dist/esm/resources/simulations/index.js.map +1 -0
  603. package/dist/esm/resources/simulations/interest-payments.d.ts +1272 -0
  604. package/dist/esm/resources/simulations/interest-payments.d.ts.map +1 -0
  605. package/dist/esm/resources/simulations/interest-payments.js +13 -0
  606. package/dist/esm/resources/simulations/interest-payments.js.map +1 -0
  607. package/dist/esm/resources/simulations/programs.d.ts +25 -0
  608. package/dist/esm/resources/simulations/programs.d.ts.map +1 -0
  609. package/dist/esm/resources/simulations/programs.js +14 -0
  610. package/dist/esm/resources/simulations/programs.js.map +1 -0
  611. package/dist/esm/resources/simulations/real-time-payments-transfers.d.ts +1782 -0
  612. package/dist/esm/resources/simulations/real-time-payments-transfers.d.ts.map +1 -0
  613. package/dist/esm/resources/simulations/real-time-payments-transfers.js +24 -0
  614. package/dist/esm/resources/simulations/real-time-payments-transfers.js.map +1 -0
  615. package/dist/esm/resources/simulations/simulations.d.ts +74 -0
  616. package/dist/esm/resources/simulations/simulations.d.ts.map +1 -0
  617. package/dist/esm/resources/simulations/simulations.js +56 -0
  618. package/dist/esm/resources/simulations/simulations.js.map +1 -0
  619. package/dist/esm/resources/simulations/wire-transfers.d.ts +1338 -0
  620. package/dist/esm/resources/simulations/wire-transfers.d.ts.map +1 -0
  621. package/dist/esm/resources/simulations/wire-transfers.js +12 -0
  622. package/dist/esm/resources/simulations/wire-transfers.js.map +1 -0
  623. package/dist/esm/resources/transactions.d.ts +1326 -0
  624. package/dist/esm/resources/transactions.d.ts.map +1 -0
  625. package/dist/esm/resources/transactions.js +24 -0
  626. package/dist/esm/resources/transactions.js.map +1 -0
  627. package/dist/esm/resources/wire-drawdown-requests.d.ts +160 -0
  628. package/dist/esm/resources/wire-drawdown-requests.d.ts.map +1 -0
  629. package/dist/esm/resources/wire-drawdown-requests.js +30 -0
  630. package/dist/esm/resources/wire-drawdown-requests.js.map +1 -0
  631. package/dist/esm/resources/wire-transfers.d.ts +352 -0
  632. package/dist/esm/resources/wire-transfers.d.ts.map +1 -0
  633. package/dist/esm/resources/wire-transfers.js +59 -0
  634. package/dist/esm/resources/wire-transfers.js.map +1 -0
  635. package/dist/esm/streaming.d.ts +12 -0
  636. package/dist/esm/streaming.d.ts.map +1 -0
  637. package/dist/esm/streaming.js +150 -0
  638. package/dist/esm/streaming.js.map +1 -0
  639. package/dist/esm/uploads.d.ts +24 -0
  640. package/dist/esm/uploads.d.ts.map +1 -0
  641. package/dist/esm/uploads.js +61 -0
  642. package/dist/esm/uploads.js.map +1 -0
  643. package/dist/esm/version.d.ts +2 -0
  644. package/dist/esm/version.d.ts.map +1 -0
  645. package/dist/esm/version.js +2 -0
  646. package/dist/esm/version.js.map +1 -0
  647. package/error.ts +29 -29
  648. package/index.ts +46 -7
  649. package/package.json +85 -5
  650. package/pagination.ts +4 -1
  651. package/resources/account-numbers.ts +14 -5
  652. package/resources/account-statements.ts +12 -5
  653. package/resources/account-transfers.ts +13 -5
  654. package/resources/accounts.ts +14 -5
  655. package/resources/ach-prenotifications.ts +13 -5
  656. package/resources/ach-transfers.ts +13 -6
  657. package/resources/balance-lookups.ts +6 -0
  658. package/resources/bookkeeping-accounts.ts +13 -5
  659. package/resources/bookkeeping-entries.ts +12 -5
  660. package/resources/bookkeeping-entry-sets.ts +20 -14
  661. package/resources/card-disputes.ts +13 -5
  662. package/resources/card-profiles.ts +13 -5
  663. package/resources/cards.ts +17 -7
  664. package/resources/check-deposits.ts +13 -5
  665. package/resources/check-transfers.ts +91 -82
  666. package/resources/declined-transactions.ts +12 -5
  667. package/resources/digital-wallet-tokens.ts +12 -5
  668. package/resources/documents.ts +14 -106
  669. package/resources/entities/entities.ts +349 -335
  670. package/resources/entities/index.ts +2 -1
  671. package/resources/entities/supplemental-documents.ts +8 -0
  672. package/resources/event-subscriptions.ts +13 -4
  673. package/resources/events.ts +12 -5
  674. package/resources/exports.ts +13 -5
  675. package/resources/external-accounts.ts +14 -5
  676. package/resources/files.ts +23 -10
  677. package/resources/groups.ts +10 -5
  678. package/resources/inbound-ach-transfer-returns.ts +8 -0
  679. package/resources/inbound-wire-drawdown-requests.ts +12 -5
  680. package/resources/limits.ts +9 -0
  681. package/resources/oauth-connections.ts +12 -5
  682. package/resources/pending-transactions.ts +17 -10
  683. package/resources/programs.ts +12 -5
  684. package/resources/real-time-decisions.ts +39 -33
  685. package/resources/real-time-payments-transfers.ts +30 -22
  686. package/resources/routing-numbers.ts +7 -0
  687. package/resources/simulations/account-statements.ts +5 -0
  688. package/resources/simulations/ach-transfers.ts +1372 -1331
  689. package/resources/simulations/card-disputes.ts +5 -0
  690. package/resources/simulations/card-refunds.ts +5 -0
  691. package/resources/simulations/cards.ts +530 -523
  692. package/resources/simulations/check-transfers.ts +5 -0
  693. package/resources/simulations/digital-wallet-token-requests.ts +6 -0
  694. package/resources/simulations/documents.ts +5 -0
  695. package/resources/simulations/inbound-wire-drawdown-requests.ts +5 -0
  696. package/resources/simulations/index.ts +23 -10
  697. package/resources/simulations/interest-payments.ts +145 -104
  698. package/resources/simulations/programs.ts +5 -0
  699. package/resources/simulations/real-time-payments-transfers.ts +1373 -1331
  700. package/resources/simulations/simulations.ts +55 -0
  701. package/resources/simulations/wire-transfers.ts +145 -104
  702. package/resources/transactions.ts +150 -107
  703. package/resources/wire-drawdown-requests.ts +13 -5
  704. package/resources/wire-transfers.ts +13 -5
  705. package/streaming.ts +3 -1
  706. package/uploads.ts +81 -0
  707. package/version.ts +1 -1
  708. package/.eslintrc.js +0 -10
  709. package/.prettierignore +0 -1
  710. package/.prettierrc +0 -6
  711. package/.release-please-manifest.json +0 -3
  712. package/.stats.yml +0 -1
  713. package/api.md +0 -576
  714. package/bin/check-release-environment +0 -25
  715. package/bin/check-test-server +0 -50
  716. package/bin/publish-npm +0 -6
  717. package/build +0 -12
  718. package/dist/cjs/examples/api-error.d.ts +0 -3
  719. package/dist/cjs/examples/api-error.d.ts.map +0 -1
  720. package/dist/cjs/examples/api-error.js +0 -92
  721. package/dist/cjs/examples/api-error.js.map +0 -1
  722. package/dist/cjs/fetch-polyfill.d.ts +0 -6
  723. package/dist/cjs/fetch-polyfill.d.ts.map +0 -1
  724. package/dist/cjs/fetch-polyfill.js +0 -57
  725. package/dist/cjs/fetch-polyfill.js.map +0 -1
  726. package/dist/cjs/tests/api-resources/account-numbers.test.d.ts +0 -2
  727. package/dist/cjs/tests/api-resources/account-numbers.test.d.ts.map +0 -1
  728. package/dist/cjs/tests/api-resources/account-numbers.test.js +0 -101
  729. package/dist/cjs/tests/api-resources/account-numbers.test.js.map +0 -1
  730. package/dist/cjs/tests/api-resources/account-statements.test.d.ts +0 -2
  731. package/dist/cjs/tests/api-resources/account-statements.test.d.ts.map +0 -1
  732. package/dist/cjs/tests/api-resources/account-statements.test.js +0 -88
  733. package/dist/cjs/tests/api-resources/account-statements.test.js.map +0 -1
  734. package/dist/cjs/tests/api-resources/account-transfers.test.d.ts +0 -2
  735. package/dist/cjs/tests/api-resources/account-transfers.test.d.ts.map +0 -1
  736. package/dist/cjs/tests/api-resources/account-transfers.test.js +0 -133
  737. package/dist/cjs/tests/api-resources/account-transfers.test.js.map +0 -1
  738. package/dist/cjs/tests/api-resources/accounts.test.d.ts +0 -2
  739. package/dist/cjs/tests/api-resources/accounts.test.d.ts.map +0 -1
  740. package/dist/cjs/tests/api-resources/accounts.test.js +0 -118
  741. package/dist/cjs/tests/api-resources/accounts.test.js.map +0 -1
  742. package/dist/cjs/tests/api-resources/ach-prenotifications.test.d.ts +0 -2
  743. package/dist/cjs/tests/api-resources/ach-prenotifications.test.d.ts.map +0 -1
  744. package/dist/cjs/tests/api-resources/ach-prenotifications.test.js +0 -113
  745. package/dist/cjs/tests/api-resources/ach-prenotifications.test.js.map +0 -1
  746. package/dist/cjs/tests/api-resources/ach-transfers.test.d.ts +0 -2
  747. package/dist/cjs/tests/api-resources/ach-transfers.test.d.ts.map +0 -1
  748. package/dist/cjs/tests/api-resources/ach-transfers.test.js +0 -145
  749. package/dist/cjs/tests/api-resources/ach-transfers.test.js.map +0 -1
  750. package/dist/cjs/tests/api-resources/balance-lookups.test.d.ts +0 -2
  751. package/dist/cjs/tests/api-resources/balance-lookups.test.d.ts.map +0 -1
  752. package/dist/cjs/tests/api-resources/balance-lookups.test.js +0 -55
  753. package/dist/cjs/tests/api-resources/balance-lookups.test.js.map +0 -1
  754. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.d.ts +0 -2
  755. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.d.ts.map +0 -1
  756. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.js +0 -78
  757. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.js.map +0 -1
  758. package/dist/cjs/tests/api-resources/bookkeeping-entries.test.d.ts +0 -2
  759. package/dist/cjs/tests/api-resources/bookkeeping-entries.test.d.ts.map +0 -1
  760. package/dist/cjs/tests/api-resources/bookkeeping-entries.test.js +0 -65
  761. package/dist/cjs/tests/api-resources/bookkeeping-entries.test.js.map +0 -1
  762. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.d.ts +0 -2
  763. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.d.ts.map +0 -1
  764. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.js +0 -66
  765. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.js.map +0 -1
  766. package/dist/cjs/tests/api-resources/card-disputes.test.d.ts +0 -2
  767. package/dist/cjs/tests/api-resources/card-disputes.test.d.ts.map +0 -1
  768. package/dist/cjs/tests/api-resources/card-disputes.test.js +0 -102
  769. package/dist/cjs/tests/api-resources/card-disputes.test.js.map +0 -1
  770. package/dist/cjs/tests/api-resources/card-profiles.test.d.ts +0 -2
  771. package/dist/cjs/tests/api-resources/card-profiles.test.d.ts.map +0 -1
  772. package/dist/cjs/tests/api-resources/card-profiles.test.js +0 -106
  773. package/dist/cjs/tests/api-resources/card-profiles.test.js.map +0 -1
  774. package/dist/cjs/tests/api-resources/cards.test.d.ts +0 -2
  775. package/dist/cjs/tests/api-resources/cards.test.d.ts.map +0 -1
  776. package/dist/cjs/tests/api-resources/cards.test.js +0 -116
  777. package/dist/cjs/tests/api-resources/cards.test.js.map +0 -1
  778. package/dist/cjs/tests/api-resources/check-deposits.test.d.ts +0 -2
  779. package/dist/cjs/tests/api-resources/check-deposits.test.d.ts.map +0 -1
  780. package/dist/cjs/tests/api-resources/check-deposits.test.js +0 -110
  781. package/dist/cjs/tests/api-resources/check-deposits.test.js.map +0 -1
  782. package/dist/cjs/tests/api-resources/check-transfers.test.d.ts +0 -2
  783. package/dist/cjs/tests/api-resources/check-transfers.test.d.ts.map +0 -1
  784. package/dist/cjs/tests/api-resources/check-transfers.test.js +0 -159
  785. package/dist/cjs/tests/api-resources/check-transfers.test.js.map +0 -1
  786. package/dist/cjs/tests/api-resources/declined-transactions.test.d.ts +0 -2
  787. package/dist/cjs/tests/api-resources/declined-transactions.test.d.ts.map +0 -1
  788. package/dist/cjs/tests/api-resources/declined-transactions.test.js +0 -91
  789. package/dist/cjs/tests/api-resources/declined-transactions.test.js.map +0 -1
  790. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.d.ts +0 -2
  791. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.d.ts.map +0 -1
  792. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.js +0 -90
  793. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.js.map +0 -1
  794. package/dist/cjs/tests/api-resources/documents.test.d.ts +0 -2
  795. package/dist/cjs/tests/api-resources/documents.test.d.ts.map +0 -1
  796. package/dist/cjs/tests/api-resources/documents.test.js +0 -93
  797. package/dist/cjs/tests/api-resources/documents.test.js.map +0 -1
  798. package/dist/cjs/tests/api-resources/entities/entities.test.d.ts +0 -2
  799. package/dist/cjs/tests/api-resources/entities/entities.test.d.ts.map +0 -1
  800. package/dist/cjs/tests/api-resources/entities/entities.test.js +0 -289
  801. package/dist/cjs/tests/api-resources/entities/entities.test.js.map +0 -1
  802. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.d.ts +0 -2
  803. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.d.ts.map +0 -1
  804. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.js +0 -68
  805. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.js.map +0 -1
  806. package/dist/cjs/tests/api-resources/event-subscriptions.test.d.ts +0 -2
  807. package/dist/cjs/tests/api-resources/event-subscriptions.test.d.ts.map +0 -1
  808. package/dist/cjs/tests/api-resources/event-subscriptions.test.js +0 -99
  809. package/dist/cjs/tests/api-resources/event-subscriptions.test.js.map +0 -1
  810. package/dist/cjs/tests/api-resources/events.test.d.ts +0 -2
  811. package/dist/cjs/tests/api-resources/events.test.d.ts.map +0 -1
  812. package/dist/cjs/tests/api-resources/events.test.js +0 -87
  813. package/dist/cjs/tests/api-resources/events.test.js.map +0 -1
  814. package/dist/cjs/tests/api-resources/exports.test.d.ts +0 -2
  815. package/dist/cjs/tests/api-resources/exports.test.d.ts.map +0 -1
  816. package/dist/cjs/tests/api-resources/exports.test.js +0 -101
  817. package/dist/cjs/tests/api-resources/exports.test.js.map +0 -1
  818. package/dist/cjs/tests/api-resources/external-accounts.test.d.ts +0 -2
  819. package/dist/cjs/tests/api-resources/external-accounts.test.d.ts.map +0 -1
  820. package/dist/cjs/tests/api-resources/external-accounts.test.js +0 -99
  821. package/dist/cjs/tests/api-resources/external-accounts.test.js.map +0 -1
  822. package/dist/cjs/tests/api-resources/files.test.d.ts +0 -2
  823. package/dist/cjs/tests/api-resources/files.test.d.ts.map +0 -1
  824. package/dist/cjs/tests/api-resources/files.test.js +0 -104
  825. package/dist/cjs/tests/api-resources/files.test.js.map +0 -1
  826. package/dist/cjs/tests/api-resources/groups.test.d.ts +0 -2
  827. package/dist/cjs/tests/api-resources/groups.test.d.ts.map +0 -1
  828. package/dist/cjs/tests/api-resources/groups.test.js +0 -55
  829. package/dist/cjs/tests/api-resources/groups.test.js.map +0 -1
  830. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.d.ts +0 -2
  831. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.d.ts.map +0 -1
  832. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.js +0 -94
  833. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.js.map +0 -1
  834. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.d.ts +0 -2
  835. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.d.ts.map +0 -1
  836. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.js +0 -80
  837. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.js.map +0 -1
  838. package/dist/cjs/tests/api-resources/limits.test.d.ts +0 -2
  839. package/dist/cjs/tests/api-resources/limits.test.d.ts.map +0 -1
  840. package/dist/cjs/tests/api-resources/limits.test.js +0 -97
  841. package/dist/cjs/tests/api-resources/limits.test.js.map +0 -1
  842. package/dist/cjs/tests/api-resources/oauth-connections.test.d.ts +0 -2
  843. package/dist/cjs/tests/api-resources/oauth-connections.test.d.ts.map +0 -1
  844. package/dist/cjs/tests/api-resources/oauth-connections.test.js +0 -75
  845. package/dist/cjs/tests/api-resources/oauth-connections.test.js.map +0 -1
  846. package/dist/cjs/tests/api-resources/pending-transactions.test.d.ts +0 -2
  847. package/dist/cjs/tests/api-resources/pending-transactions.test.d.ts.map +0 -1
  848. package/dist/cjs/tests/api-resources/pending-transactions.test.js +0 -93
  849. package/dist/cjs/tests/api-resources/pending-transactions.test.js.map +0 -1
  850. package/dist/cjs/tests/api-resources/programs.test.d.ts +0 -2
  851. package/dist/cjs/tests/api-resources/programs.test.d.ts.map +0 -1
  852. package/dist/cjs/tests/api-resources/programs.test.js +0 -73
  853. package/dist/cjs/tests/api-resources/programs.test.js.map +0 -1
  854. package/dist/cjs/tests/api-resources/real-time-decisions.test.d.ts +0 -2
  855. package/dist/cjs/tests/api-resources/real-time-decisions.test.d.ts.map +0 -1
  856. package/dist/cjs/tests/api-resources/real-time-decisions.test.js +0 -61
  857. package/dist/cjs/tests/api-resources/real-time-decisions.test.js.map +0 -1
  858. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.d.ts +0 -2
  859. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.d.ts.map +0 -1
  860. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.js +0 -113
  861. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.js.map +0 -1
  862. package/dist/cjs/tests/api-resources/routing-numbers.test.d.ts +0 -2
  863. package/dist/cjs/tests/api-resources/routing-numbers.test.d.ts.map +0 -1
  864. package/dist/cjs/tests/api-resources/routing-numbers.test.js +0 -56
  865. package/dist/cjs/tests/api-resources/routing-numbers.test.js.map +0 -1
  866. package/dist/cjs/tests/api-resources/simulations/account-statements.test.d.ts +0 -2
  867. package/dist/cjs/tests/api-resources/simulations/account-statements.test.d.ts.map +0 -1
  868. package/dist/cjs/tests/api-resources/simulations/account-statements.test.js +0 -52
  869. package/dist/cjs/tests/api-resources/simulations/account-statements.test.js.map +0 -1
  870. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.d.ts +0 -2
  871. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.d.ts.map +0 -1
  872. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.js +0 -61
  873. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.js.map +0 -1
  874. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.d.ts +0 -2
  875. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.d.ts.map +0 -1
  876. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.js +0 -86
  877. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.js.map +0 -1
  878. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.d.ts +0 -2
  879. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.d.ts.map +0 -1
  880. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.js +0 -57
  881. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.js.map +0 -1
  882. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.d.ts +0 -2
  883. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.d.ts.map +0 -1
  884. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.js.map +0 -1
  885. package/dist/cjs/tests/api-resources/simulations/cards.test.d.ts +0 -2
  886. package/dist/cjs/tests/api-resources/simulations/cards.test.d.ts.map +0 -1
  887. package/dist/cjs/tests/api-resources/simulations/cards.test.js +0 -72
  888. package/dist/cjs/tests/api-resources/simulations/cards.test.js.map +0 -1
  889. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.d.ts +0 -2
  890. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.d.ts.map +0 -1
  891. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.js +0 -87
  892. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.js.map +0 -1
  893. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.d.ts +0 -2
  894. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.d.ts.map +0 -1
  895. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.js +0 -92
  896. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.js.map +0 -1
  897. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.d.ts +0 -2
  898. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.d.ts.map +0 -1
  899. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.js +0 -52
  900. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.js.map +0 -1
  901. package/dist/cjs/tests/api-resources/simulations/documents.test.d.ts +0 -2
  902. package/dist/cjs/tests/api-resources/simulations/documents.test.d.ts.map +0 -1
  903. package/dist/cjs/tests/api-resources/simulations/documents.test.js.map +0 -1
  904. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.d.ts +0 -2
  905. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.d.ts.map +0 -1
  906. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.js +0 -82
  907. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.js.map +0 -1
  908. package/dist/cjs/tests/api-resources/simulations/interest-payments.test.d.ts +0 -2
  909. package/dist/cjs/tests/api-resources/simulations/interest-payments.test.d.ts.map +0 -1
  910. package/dist/cjs/tests/api-resources/simulations/interest-payments.test.js +0 -58
  911. package/dist/cjs/tests/api-resources/simulations/interest-payments.test.js.map +0 -1
  912. package/dist/cjs/tests/api-resources/simulations/programs.test.d.ts +0 -2
  913. package/dist/cjs/tests/api-resources/simulations/programs.test.d.ts.map +0 -1
  914. package/dist/cjs/tests/api-resources/simulations/programs.test.js.map +0 -1
  915. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.d.ts +0 -2
  916. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.d.ts.map +0 -1
  917. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.js +0 -70
  918. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.js.map +0 -1
  919. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.d.ts +0 -2
  920. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.d.ts.map +0 -1
  921. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.js +0 -71
  922. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.js.map +0 -1
  923. package/dist/cjs/tests/api-resources/transactions.test.d.ts +0 -2
  924. package/dist/cjs/tests/api-resources/transactions.test.d.ts.map +0 -1
  925. package/dist/cjs/tests/api-resources/transactions.test.js +0 -92
  926. package/dist/cjs/tests/api-resources/transactions.test.js.map +0 -1
  927. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.d.ts +0 -2
  928. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.d.ts.map +0 -1
  929. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.js +0 -107
  930. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.js.map +0 -1
  931. package/dist/cjs/tests/api-resources/wire-transfers.test.d.ts +0 -2
  932. package/dist/cjs/tests/api-resources/wire-transfers.test.d.ts.map +0 -1
  933. package/dist/cjs/tests/api-resources/wire-transfers.test.js +0 -170
  934. package/dist/cjs/tests/api-resources/wire-transfers.test.js.map +0 -1
  935. package/dist/cjs/tests/form.test.d.ts +0 -2
  936. package/dist/cjs/tests/form.test.d.ts.map +0 -1
  937. package/dist/cjs/tests/form.test.js.map +0 -1
  938. package/dist/cjs/tests/index.test.d.ts +0 -2
  939. package/dist/cjs/tests/index.test.d.ts.map +0 -1
  940. package/dist/cjs/tests/index.test.js +0 -113
  941. package/dist/cjs/tests/index.test.js.map +0 -1
  942. package/dist/cjs/tests/responses.test.d.ts +0 -2
  943. package/dist/cjs/tests/responses.test.d.ts.map +0 -1
  944. package/dist/cjs/tests/responses.test.js +0 -60
  945. package/dist/cjs/tests/responses.test.js.map +0 -1
  946. package/examples/api-error.ts +0 -21
  947. package/fetch-polyfill.ts +0 -69
  948. package/jest.config.js +0 -8
  949. package/release-please-config.json +0 -61
  950. package/tests/api-resources/account-numbers.test.ts +0 -64
  951. package/tests/api-resources/account-statements.test.ts +0 -51
  952. package/tests/api-resources/account-transfers.test.ts +0 -96
  953. package/tests/api-resources/accounts.test.ts +0 -81
  954. package/tests/api-resources/ach-prenotifications.test.ts +0 -74
  955. package/tests/api-resources/ach-transfers.test.ts +0 -106
  956. package/tests/api-resources/balance-lookups.test.ts +0 -18
  957. package/tests/api-resources/bookkeeping-accounts.test.ts +0 -38
  958. package/tests/api-resources/bookkeeping-entries.test.ts +0 -25
  959. package/tests/api-resources/bookkeeping-entry-sets.test.ts +0 -29
  960. package/tests/api-resources/card-disputes.test.ts +0 -65
  961. package/tests/api-resources/card-profiles.test.ts +0 -69
  962. package/tests/api-resources/cards.test.ts +0 -79
  963. package/tests/api-resources/check-deposits.test.ts +0 -71
  964. package/tests/api-resources/check-transfers.test.ts +0 -122
  965. package/tests/api-resources/declined-transactions.test.ts +0 -54
  966. package/tests/api-resources/digital-wallet-tokens.test.ts +0 -51
  967. package/tests/api-resources/documents.test.ts +0 -52
  968. package/tests/api-resources/entities/entities.test.ts +0 -249
  969. package/tests/api-resources/entities/supplemental-documents.test.ts +0 -31
  970. package/tests/api-resources/event-subscriptions.test.ts +0 -59
  971. package/tests/api-resources/events.test.ts +0 -50
  972. package/tests/api-resources/exports.test.ts +0 -64
  973. package/tests/api-resources/external-accounts.test.ts +0 -62
  974. package/tests/api-resources/files.test.ts +0 -67
  975. package/tests/api-resources/groups.test.ts +0 -18
  976. package/tests/api-resources/inbound-ach-transfer-returns.test.ts +0 -57
  977. package/tests/api-resources/inbound-wire-drawdown-requests.test.ts +0 -43
  978. package/tests/api-resources/limits.test.ts +0 -60
  979. package/tests/api-resources/oauth-connections.test.ts +0 -38
  980. package/tests/api-resources/pending-transactions.test.ts +0 -54
  981. package/tests/api-resources/programs.test.ts +0 -36
  982. package/tests/api-resources/real-time-decisions.test.ts +0 -24
  983. package/tests/api-resources/real-time-payments-transfers.test.ts +0 -76
  984. package/tests/api-resources/routing-numbers.test.ts +0 -19
  985. package/tests/api-resources/simulations/account-statements.test.ts +0 -15
  986. package/tests/api-resources/simulations/account-transfers.test.ts +0 -24
  987. package/tests/api-resources/simulations/ach-transfers.test.ts +0 -46
  988. package/tests/api-resources/simulations/card-disputes.test.ts +0 -20
  989. package/tests/api-resources/simulations/card-refunds.test.ts +0 -15
  990. package/tests/api-resources/simulations/cards.test.ts +0 -35
  991. package/tests/api-resources/simulations/check-deposits.test.ts +0 -50
  992. package/tests/api-resources/simulations/check-transfers.test.ts +0 -47
  993. package/tests/api-resources/simulations/digital-wallet-token-requests.test.ts +0 -15
  994. package/tests/api-resources/simulations/documents.test.ts +0 -15
  995. package/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.ts +0 -45
  996. package/tests/api-resources/simulations/interest-payments.test.ts +0 -15
  997. package/tests/api-resources/simulations/programs.test.ts +0 -15
  998. package/tests/api-resources/simulations/real-time-payments-transfers.test.ts +0 -33
  999. package/tests/api-resources/simulations/wire-transfers.test.ts +0 -34
  1000. package/tests/api-resources/transactions.test.ts +0 -53
  1001. package/tests/api-resources/wire-drawdown-requests.test.ts +0 -70
  1002. package/tests/api-resources/wire-transfers.test.ts +0 -133
  1003. package/tests/form.test.ts +0 -27
  1004. package/tests/index.test.ts +0 -83
  1005. package/tests/responses.test.ts +0 -25
  1006. package/tsconfig.cjs.json +0 -8
  1007. package/tsconfig.json +0 -39
  1008. package/typings/digest-fetch/index.d.ts +0 -33
@@ -2,6 +2,7 @@ import * as Core from '../../core';
2
2
  import { APIResource } from '../../resource';
3
3
  import * as ACHTransfers_ from '../../resources/ach-transfers';
4
4
  import * as Shared from '../../resources/shared';
5
+ import * as API from './';
5
6
  export declare class ACHTransfers extends APIResource {
6
7
  /**
7
8
  * Simulates an inbound ACH transfer to your account. This imitates initiating a
@@ -62,18 +63,22 @@ export interface ACHTransferSimulation {
62
63
  }
63
64
  export declare namespace ACHTransferSimulation {
64
65
  /**
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`.
66
+ * If the ACH Transfer attempt fails, this will contain the resulting
67
+ * [Declined Transaction](#declined-transactions) object. The Declined
68
+ * Transaction's `source` will be of `category: inbound_ach_transfer`.
68
69
  */
69
- interface Transaction {
70
+ interface DeclinedTransaction {
70
71
  /**
71
- * The identifier for the Account the Transaction belongs to.
72
+ * The Declined Transaction identifier.
73
+ */
74
+ id: string;
75
+ /**
76
+ * The identifier for the Account the Declined Transaction belongs to.
72
77
  */
73
78
  account_id: string;
74
79
  /**
75
- * The Transaction amount in the minor unit of its currency. For dollars, for
76
- * example, this is cents.
80
+ * The Declined Transaction amount in the minor unit of its currency. For dollars,
81
+ * for example, this is cents.
77
82
  */
78
83
  amount: number;
79
84
  /**
@@ -82,248 +87,135 @@ export declare namespace ACHTransferSimulation {
82
87
  */
83
88
  created_at: string;
84
89
  /**
85
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
86
- * Transaction's currency. This will match the currency on the Transcation's
87
- * Account.
90
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
91
+ * Transaction's currency. This will match the currency on the Declined
92
+ * Transcation's Account.
88
93
  */
89
94
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
90
95
  /**
91
- * For a Transaction related to a transfer, this is the description you provide.
92
- * For a Transaction related to a payment, this is the description the vendor
93
- * provides.
96
+ * This is the description the vendor provides.
94
97
  */
95
98
  description: string;
96
99
  /**
97
- * The Transaction identifier.
98
- */
99
- id: string;
100
- /**
101
- * The identifier for the route this Transaction came through. Routes are things
102
- * like cards and ACH details.
100
+ * The identifier for the route this Declined Transaction came through. Routes are
101
+ * things like cards and ACH details.
103
102
  */
104
103
  route_id: string | null;
105
104
  /**
106
- * The type of the route this Transaction came through.
105
+ * The type of the route this Declined Transaction came through.
107
106
  */
108
107
  route_type: 'account_number' | 'card' | null;
109
108
  /**
110
109
  * This is an object giving more details on the network-level event that caused the
111
- * Transaction. Note that for backwards compatibility reasons, additional
112
- * undocumented keys may appear in this object. These should be treated as
113
- * deprecated and will be removed in the future.
110
+ * Declined Transaction. For example, for a card transaction this lists the
111
+ * merchant's industry and location. Note that for backwards compatibility reasons,
112
+ * additional undocumented keys may appear in this object. These should be treated
113
+ * as deprecated and will be removed in the future.
114
114
  */
115
- source: Transaction.Source;
115
+ source: DeclinedTransaction.Source;
116
116
  /**
117
117
  * A constant representing the object's type. For this resource it will always be
118
- * `transaction`.
118
+ * `declined_transaction`.
119
119
  */
120
- type: 'transaction';
120
+ type: 'declined_transaction';
121
121
  }
122
- namespace Transaction {
122
+ namespace DeclinedTransaction {
123
123
  /**
124
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.
125
+ * Declined Transaction. For example, for a card transaction this lists the
126
+ * merchant's industry and location. Note that for backwards compatibility reasons,
127
+ * additional undocumented keys may appear in this object. These should be treated
128
+ * as deprecated and will be removed in the future.
128
129
  */
129
130
  interface Source {
130
131
  /**
131
- * A Account Transfer Intention object. This field will be present in the JSON
132
- * response if and only if `category` is equal to `account_transfer_intention`.
133
- */
134
- account_transfer_intention: Source.AccountTransferIntention | null;
135
- /**
136
- * A ACH Transfer Intention object. This field will be present in the JSON response
137
- * if and only if `category` is equal to `ach_transfer_intention`.
138
- */
139
- ach_transfer_intention: Source.ACHTransferIntention | null;
140
- /**
141
- * A ACH Transfer Rejection object. This field will be present in the JSON response
142
- * if and only if `category` is equal to `ach_transfer_rejection`.
143
- */
144
- ach_transfer_rejection: Source.ACHTransferRejection | null;
145
- /**
146
- * A ACH Transfer Return object. This field will be present in the JSON response if
147
- * and only if `category` is equal to `ach_transfer_return`.
148
- */
149
- ach_transfer_return: Source.ACHTransferReturn | null;
150
- /**
151
- * A Card Dispute Acceptance object. This field will be present in the JSON
152
- * response if and only if `category` is equal to `card_dispute_acceptance`.
153
- */
154
- card_dispute_acceptance: Source.CardDisputeAcceptance | null;
155
- /**
156
- * A Card Refund object. This field will be present in the JSON response if and
157
- * only if `category` is equal to `card_refund`.
158
- */
159
- card_refund: Source.CardRefund | null;
160
- /**
161
- * A Card Revenue Payment object. This field will be present in the JSON response
162
- * if and only if `category` is equal to `card_revenue_payment`.
132
+ * A ACH Decline object. This field will be present in the JSON response if and
133
+ * only if `category` is equal to `ach_decline`.
163
134
  */
164
- card_revenue_payment: Source.CardRevenuePayment | null;
135
+ ach_decline: Source.ACHDecline | null;
165
136
  /**
166
- * A Card Settlement object. This field will be present in the JSON response if and
167
- * only if `category` is equal to `card_settlement`.
137
+ * A Card Decline object. This field will be present in the JSON response if and
138
+ * only if `category` is equal to `card_decline`.
168
139
  */
169
- card_settlement: Source.CardSettlement | null;
140
+ card_decline: Source.CardDecline | null;
170
141
  /**
171
- * The type of transaction that took place. We may add additional possible values
172
- * for this enum over time; your application should be able to handle such
173
- * additions gracefully.
142
+ * The type of decline that took place. We may add additional possible values for
143
+ * this enum over time; your application should be able to handle such additions
144
+ * gracefully.
174
145
  */
175
146
  category:
176
- | 'account_transfer_intention'
177
- | 'ach_transfer_intention'
178
- | 'ach_transfer_rejection'
179
- | 'ach_transfer_return'
180
- | 'card_dispute_acceptance'
181
- | 'card_refund'
182
- | 'card_settlement'
183
- | 'card_revenue_payment'
184
- | 'check_deposit_acceptance'
185
- | 'check_deposit_return'
186
- | 'check_transfer_intention'
187
- | 'check_transfer_return'
188
- | 'check_transfer_rejection'
189
- | 'check_transfer_stop_payment_request'
190
- | 'fee_payment'
191
- | 'inbound_ach_transfer'
192
- | 'inbound_ach_transfer_return_intention'
193
- | 'inbound_check'
194
- | 'inbound_international_ach_transfer'
195
- | 'inbound_real_time_payments_transfer_confirmation'
196
- | 'inbound_wire_drawdown_payment_reversal'
197
- | 'inbound_wire_drawdown_payment'
198
- | 'inbound_wire_reversal'
199
- | 'inbound_wire_transfer'
200
- | 'interest_payment'
201
- | 'internal_source'
202
- | 'real_time_payments_transfer_acknowledgement'
203
- | 'sample_funds'
204
- | 'wire_transfer_intention'
205
- | 'wire_transfer_rejection'
147
+ | 'ach_decline'
148
+ | 'card_decline'
149
+ | 'check_decline'
150
+ | 'inbound_real_time_payments_transfer_decline'
151
+ | 'international_ach_decline'
152
+ | 'wire_decline'
206
153
  | 'other';
207
154
  /**
208
- * A Check Deposit Acceptance object. This field will be present in the JSON
209
- * response if and only if `category` is equal to `check_deposit_acceptance`.
210
- */
211
- check_deposit_acceptance: Source.CheckDepositAcceptance | null;
212
- /**
213
- * A Check Deposit Return object. This field will be present in the JSON response
214
- * if and only if `category` is equal to `check_deposit_return`.
215
- */
216
- check_deposit_return: Source.CheckDepositReturn | null;
217
- /**
218
- * A Check Transfer Intention object. This field will be present in the JSON
219
- * response if and only if `category` is equal to `check_transfer_intention`.
220
- */
221
- check_transfer_intention: Source.CheckTransferIntention | null;
222
- /**
223
- * A Check Transfer Rejection object. This field will be present in the JSON
224
- * response if and only if `category` is equal to `check_transfer_rejection`.
225
- */
226
- check_transfer_rejection: Source.CheckTransferRejection | null;
227
- /**
228
- * A Check Transfer Return object. This field will be present in the JSON response
229
- * if and only if `category` is equal to `check_transfer_return`.
230
- */
231
- check_transfer_return: Source.CheckTransferReturn | null;
232
- /**
233
- * A Check Transfer Stop Payment Request object. This field will be present in the
234
- * JSON response if and only if `category` is equal to
235
- * `check_transfer_stop_payment_request`.
236
- */
237
- check_transfer_stop_payment_request: Source.CheckTransferStopPaymentRequest | null;
238
- /**
239
- * A Fee Payment object. This field will be present in the JSON response if and
240
- * only if `category` is equal to `fee_payment`.
241
- */
242
- fee_payment: Source.FeePayment | null;
243
- /**
244
- * A Inbound ACH Transfer object. This field will be present in the JSON response
245
- * if and only if `category` is equal to `inbound_ach_transfer`.
246
- */
247
- inbound_ach_transfer: Source.InboundACHTransfer | null;
248
- /**
249
- * A Inbound Check object. This field will be present in the JSON response if and
250
- * only if `category` is equal to `inbound_check`.
155
+ * A Check Decline object. This field will be present in the JSON response if and
156
+ * only if `category` is equal to `check_decline`.
251
157
  */
252
- inbound_check: Source.InboundCheck | null;
158
+ check_decline: Source.CheckDecline | null;
253
159
  /**
254
- * A Inbound International ACH Transfer object. This field will be present in the
255
- * JSON response if and only if `category` is equal to
256
- * `inbound_international_ach_transfer`.
160
+ * A Inbound Real Time Payments Transfer Decline object. This field will be present
161
+ * in the JSON response if and only if `category` is equal to
162
+ * `inbound_real_time_payments_transfer_decline`.
257
163
  */
258
- inbound_international_ach_transfer: Source.InboundInternationalACHTransfer | null;
164
+ inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
259
165
  /**
260
- * A Inbound Real Time Payments Transfer Confirmation object. This field will be
261
- * present in the JSON response if and only if `category` is equal to
262
- * `inbound_real_time_payments_transfer_confirmation`.
166
+ * A International ACH Decline object. This field will be present in the JSON
167
+ * response if and only if `category` is equal to `international_ach_decline`.
263
168
  */
264
- inbound_real_time_payments_transfer_confirmation: Source.InboundRealTimePaymentsTransferConfirmation | null;
169
+ international_ach_decline: Source.InternationalACHDecline | null;
265
170
  /**
266
- * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
267
- * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
171
+ * A Wire Decline object. This field will be present in the JSON response if and
172
+ * only if `category` is equal to `wire_decline`.
268
173
  */
269
- inbound_wire_drawdown_payment: Source.InboundWireDrawdownPayment | null;
174
+ wire_decline: Source.WireDecline | null;
175
+ }
176
+ namespace Source {
270
177
  /**
271
- * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
272
- * the JSON response if and only if `category` is equal to
273
- * `inbound_wire_drawdown_payment_reversal`.
178
+ * A ACH Decline object. This field will be present in the JSON response if and
179
+ * only if `category` is equal to `ach_decline`.
274
180
  */
275
- inbound_wire_drawdown_payment_reversal: Source.InboundWireDrawdownPaymentReversal | null;
181
+ interface ACHDecline {
182
+ /**
183
+ * The declined amount in the minor unit of the destination account currency. For
184
+ * dollars, for example, this is cents.
185
+ */
186
+ amount: number;
187
+ originator_company_descriptive_date: string | null;
188
+ originator_company_discretionary_data: string | null;
189
+ originator_company_id: string;
190
+ originator_company_name: string;
191
+ /**
192
+ * Why the ACH transfer was declined.
193
+ */
194
+ reason:
195
+ | 'ach_route_canceled'
196
+ | 'ach_route_disabled'
197
+ | 'breaches_limit'
198
+ | 'credit_entry_refused_by_receiver'
199
+ | 'duplicate_return'
200
+ | 'entity_not_active'
201
+ | 'group_locked'
202
+ | 'insufficient_funds'
203
+ | 'misrouted_return'
204
+ | 'no_ach_route'
205
+ | 'originator_request'
206
+ | 'transaction_not_allowed';
207
+ receiver_id_number: string | null;
208
+ receiver_name: string | null;
209
+ trace_number: string;
210
+ }
276
211
  /**
277
- * A Inbound Wire Reversal object. This field will be present in the JSON response
278
- * if and only if `category` is equal to `inbound_wire_reversal`.
212
+ * A Card Decline object. This field will be present in the JSON response if and
213
+ * only if `category` is equal to `card_decline`.
279
214
  */
280
- inbound_wire_reversal: Source.InboundWireReversal | null;
281
- /**
282
- * A Inbound Wire Transfer object. This field will be present in the JSON response
283
- * if and only if `category` is equal to `inbound_wire_transfer`.
284
- */
285
- inbound_wire_transfer: Source.InboundWireTransfer | null;
286
- /**
287
- * A Interest Payment object. This field will be present in the JSON response if
288
- * and only if `category` is equal to `interest_payment`.
289
- */
290
- interest_payment: Source.InterestPayment | null;
291
- /**
292
- * A Internal Source object. This field will be present in the JSON response if and
293
- * only if `category` is equal to `internal_source`.
294
- */
295
- internal_source: Source.InternalSource | null;
296
- /**
297
- * A Real Time Payments Transfer Acknowledgement object. This field will be present
298
- * in the JSON response if and only if `category` is equal to
299
- * `real_time_payments_transfer_acknowledgement`.
300
- */
301
- real_time_payments_transfer_acknowledgement: Source.RealTimePaymentsTransferAcknowledgement | null;
302
- /**
303
- * A Sample Funds object. This field will be present in the JSON response if and
304
- * only if `category` is equal to `sample_funds`.
305
- */
306
- sample_funds: Source.SampleFunds | null;
307
- /**
308
- * A Wire Transfer Intention object. This field will be present in the JSON
309
- * response if and only if `category` is equal to `wire_transfer_intention`.
310
- */
311
- wire_transfer_intention: Source.WireTransferIntention | null;
312
- /**
313
- * A Wire Transfer Rejection object. This field will be present in the JSON
314
- * response if and only if `category` is equal to `wire_transfer_rejection`.
315
- */
316
- wire_transfer_rejection: Source.WireTransferRejection | null;
317
- }
318
- namespace Source {
319
- /**
320
- * A Account Transfer Intention object. This field will be present in the JSON
321
- * response if and only if `category` is equal to `account_transfer_intention`.
322
- */
323
- interface AccountTransferIntention {
215
+ interface CardDecline {
324
216
  /**
325
- * The pending amount in the minor unit of the transaction's currency. For dollars,
326
- * for example, this is cents.
217
+ * The declined amount in the minor unit of the destination account currency. For
218
+ * dollars, for example, this is cents.
327
219
  */
328
220
  amount: number;
329
221
  /**
@@ -332,1331 +224,1355 @@ export declare namespace ACHTransferSimulation {
332
224
  */
333
225
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
334
226
  /**
335
- * The description you chose to give the transfer.
227
+ * If the authorization was attempted using a Digital Wallet Token (such as an
228
+ * Apple Pay purchase), the identifier of the token that was used.
336
229
  */
337
- description: string;
230
+ digital_wallet_token_id: string | null;
338
231
  /**
339
- * The identifier of the Account to where the Account Transfer was sent.
232
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
233
+ * is transacting with.
340
234
  */
341
- destination_account_id: string;
235
+ merchant_acceptor_id: string;
342
236
  /**
343
- * The identifier of the Account from where the Account Transfer was sent.
237
+ * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
238
+ * card is transacting with.
344
239
  */
345
- source_account_id: string;
240
+ merchant_category_code: string | null;
346
241
  /**
347
- * The identifier of the Account Transfer that led to this Pending Transaction.
242
+ * The city the merchant resides in.
348
243
  */
349
- transfer_id: string;
350
- }
351
- /**
352
- * A ACH Transfer Intention object. This field will be present in the JSON response
353
- * if and only if `category` is equal to `ach_transfer_intention`.
354
- */
355
- interface ACHTransferIntention {
356
- account_number: string;
244
+ merchant_city: string | null;
357
245
  /**
358
- * The amount in the minor unit of the transaction's currency. For dollars, for
359
- * example, this is cents.
246
+ * The country the merchant resides in.
360
247
  */
361
- amount: number;
362
- routing_number: string;
363
- statement_descriptor: string;
248
+ merchant_country: string | null;
364
249
  /**
365
- * The identifier of the ACH Transfer that led to this Transaction.
250
+ * The merchant descriptor of the merchant the card is transacting with.
366
251
  */
367
- transfer_id: string;
368
- }
369
- /**
370
- * A ACH Transfer Rejection object. This field will be present in the JSON response
371
- * if and only if `category` is equal to `ach_transfer_rejection`.
372
- */
373
- interface ACHTransferRejection {
252
+ merchant_descriptor: string;
374
253
  /**
375
- * The identifier of the ACH Transfer that led to this Transaction.
254
+ * The state the merchant resides in.
376
255
  */
377
- transfer_id: string;
378
- }
379
- /**
380
- * A ACH Transfer Return object. This field will be present in the JSON response if
381
- * and only if `category` is equal to `ach_transfer_return`.
382
- */
383
- interface ACHTransferReturn {
256
+ merchant_state: string | null;
384
257
  /**
385
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
386
- * the transfer was created.
258
+ * The payment network used to process this card authorization
387
259
  */
388
- created_at: string;
260
+ network: 'visa';
389
261
  /**
390
- * The three character ACH return code, in the range R01 to R85.
262
+ * Fields specific to the `network`
391
263
  */
392
- raw_return_reason_code: string;
264
+ network_details: CardDecline.NetworkDetails;
393
265
  /**
394
- * Why the ACH Transfer was returned.
266
+ * The identifier of the Real-Time Decision sent to approve or decline this
267
+ * transaction.
395
268
  */
396
- return_reason_code:
397
- | 'insufficient_fund'
398
- | 'no_account'
399
- | 'account_closed'
400
- | 'invalid_account_number_structure'
401
- | 'account_frozen_entry_returned_per_ofac_instruction'
402
- | 'credit_entry_refused_by_receiver'
403
- | 'unauthorized_debit_to_consumer_account_using_corporate_sec_code'
404
- | 'corporate_customer_advised_not_authorized'
405
- | 'payment_stopped'
406
- | 'non_transaction_account'
407
- | 'uncollected_funds'
408
- | 'routing_number_check_digit_error'
409
- | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
410
- | 'amount_field_error'
411
- | 'authorization_revoked_by_customer'
412
- | 'invalid_ach_routing_number'
413
- | 'file_record_edit_criteria'
414
- | 'enr_invalid_individual_name'
415
- | 'returned_per_odfi_request'
416
- | 'limited_participation_dfi'
417
- | 'incorrectly_coded_outbound_international_payment'
418
- | 'other'
419
- | 'account_sold_to_another_dfi'
420
- | 'addenda_error'
421
- | 'beneficiary_or_account_holder_deceased'
422
- | 'customer_advised_not_within_authorization_terms'
423
- | 'corrected_return'
424
- | 'duplicate_entry'
425
- | 'duplicate_return'
426
- | 'enr_duplicate_enrollment'
427
- | 'enr_invalid_dfi_account_number'
428
- | 'enr_invalid_individual_id_number'
429
- | 'enr_invalid_representative_payee_indicator'
430
- | 'enr_invalid_transaction_code'
431
- | 'enr_return_of_enr_entry'
432
- | 'enr_routing_number_check_digit_error'
433
- | 'entry_not_processed_by_gateway'
434
- | 'field_error'
435
- | 'foreign_receiving_dfi_unable_to_settle'
436
- | 'iat_entry_coding_error'
437
- | 'improper_effective_entry_date'
438
- | 'improper_source_document_source_document_presented'
439
- | 'invalid_company_id'
440
- | 'invalid_foreign_receiving_dfi_identification'
441
- | 'invalid_individual_id_number'
442
- | 'item_and_rck_entry_presented_for_payment'
443
- | 'item_related_to_rck_entry_is_ineligible'
444
- | 'mandatory_field_error'
445
- | 'misrouted_dishonored_return'
446
- | 'misrouted_return'
447
- | 'no_errors_found'
448
- | 'non_acceptance_of_r62_dishonored_return'
449
- | 'non_participant_in_iat_program'
450
- | 'permissible_return_entry'
451
- | 'permissible_return_entry_not_accepted'
452
- | 'rdfi_non_settlement'
453
- | 'rdfi_participant_in_check_truncation_program'
454
- | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
455
- | 'return_not_a_duplicate'
456
- | 'return_of_erroneous_or_reversing_debit'
457
- | 'return_of_improper_credit_entry'
458
- | 'return_of_improper_debit_entry'
459
- | 'return_of_xck_entry'
460
- | 'source_document_presented_for_payment'
461
- | 'state_law_affecting_rck_acceptance'
462
- | 'stop_payment_on_item_related_to_rck_entry'
463
- | 'stop_payment_on_source_document'
464
- | 'timely_original_return'
465
- | 'trace_number_error'
466
- | 'untimely_dishonored_return'
467
- | 'untimely_return';
269
+ real_time_decision_id: string | null;
468
270
  /**
469
- * The identifier of the Tranasaction associated with this return.
271
+ * Why the transaction was declined.
470
272
  */
471
- transaction_id: string;
273
+ reason:
274
+ | 'card_not_active'
275
+ | 'entity_not_active'
276
+ | 'group_locked'
277
+ | 'insufficient_funds'
278
+ | 'cvv2_mismatch'
279
+ | 'transaction_not_allowed'
280
+ | 'breaches_internal_limit'
281
+ | 'breaches_limit'
282
+ | 'webhook_declined'
283
+ | 'webhook_timed_out'
284
+ | 'declined_by_stand_in_processing'
285
+ | 'invalid_physical_card'
286
+ | 'missing_original_authorization';
287
+ }
288
+ namespace CardDecline {
472
289
  /**
473
- * The identifier of the ACH Transfer associated with this return.
290
+ * Fields specific to the `network`
474
291
  */
475
- transfer_id: string;
292
+ interface NetworkDetails {
293
+ /**
294
+ * Fields specific to the `visa` network
295
+ */
296
+ visa: NetworkDetails.Visa;
297
+ }
298
+ namespace NetworkDetails {
299
+ /**
300
+ * Fields specific to the `visa` network
301
+ */
302
+ interface Visa {
303
+ /**
304
+ * For electronic commerce transactions, this identifies the level of security used
305
+ * in obtaining the customer's payment credential. For mail or telephone order
306
+ * transactions, identifies the type of mail or telephone order.
307
+ */
308
+ electronic_commerce_indicator:
309
+ | 'mail_phone_order'
310
+ | 'recurring'
311
+ | 'installment'
312
+ | 'unknown_mail_phone_order'
313
+ | 'secure_electronic_commerce'
314
+ | 'non_authenticated_security_transaction_at_3ds_capable_merchant'
315
+ | 'non_authenticated_security_transaction'
316
+ | 'non_secure_transaction'
317
+ | null;
318
+ /**
319
+ * The method used to enter the cardholder's primary account number and card
320
+ * expiration date
321
+ */
322
+ point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
323
+ }
324
+ }
476
325
  }
477
326
  /**
478
- * A Card Dispute Acceptance object. This field will be present in the JSON
479
- * response if and only if `category` is equal to `card_dispute_acceptance`.
327
+ * A Check Decline object. This field will be present in the JSON response if and
328
+ * only if `category` is equal to `check_decline`.
480
329
  */
481
- interface CardDisputeAcceptance {
330
+ interface CheckDecline {
482
331
  /**
483
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
484
- * the Card Dispute was accepted.
332
+ * The declined amount in the minor unit of the destination account currency. For
333
+ * dollars, for example, this is cents.
485
334
  */
486
- accepted_at: string;
335
+ amount: number;
336
+ auxiliary_on_us: string | null;
487
337
  /**
488
- * The identifier of the Card Dispute that was accepted.
338
+ * Why the check was declined.
489
339
  */
490
- card_dispute_id: string;
491
- /**
492
- * The identifier of the Transaction that was created to return the disputed funds
493
- * to your account.
494
- */
495
- transaction_id: string;
496
- }
497
- /**
498
- * A Card Refund object. This field will be present in the JSON response if and
499
- * only if `category` is equal to `card_refund`.
500
- */
501
- interface CardRefund {
502
- /**
503
- * The pending amount in the minor unit of the transaction's currency. For dollars,
504
- * for example, this is cents.
505
- */
506
- amount: number;
507
- /**
508
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
509
- * transaction's currency.
510
- */
511
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
512
- /**
513
- * The Card Refund identifier.
514
- */
515
- id: string;
516
- /**
517
- * The merchant identifier (commonly abbreviated as MID) of the merchant the card
518
- * is transacting with.
519
- */
520
- merchant_acceptor_id: string | null;
521
- /**
522
- * The 4-digit MCC describing the merchant's business.
523
- */
524
- merchant_category_code: string;
525
- /**
526
- * The city the merchant resides in.
527
- */
528
- merchant_city: string | null;
529
- /**
530
- * The country the merchant resides in.
531
- */
532
- merchant_country: string;
533
- /**
534
- * The name of the merchant.
535
- */
536
- merchant_name: string | null;
537
- /**
538
- * The state the merchant resides in.
539
- */
540
- merchant_state: string | null;
541
- /**
542
- * A constant representing the object's type. For this resource it will always be
543
- * `card_refund`.
544
- */
545
- type: 'card_refund';
340
+ reason:
341
+ | 'ach_route_canceled'
342
+ | 'ach_route_disabled'
343
+ | 'breaches_limit'
344
+ | 'entity_not_active'
345
+ | 'group_locked'
346
+ | 'insufficient_funds'
347
+ | 'unable_to_locate_account'
348
+ | 'not_our_item'
349
+ | 'unable_to_process'
350
+ | 'refer_to_image'
351
+ | 'stop_payment_requested'
352
+ | 'returned'
353
+ | 'duplicate_presentment'
354
+ | 'not_authorized'
355
+ | 'altered_or_fictitious';
546
356
  }
547
357
  /**
548
- * A Card Settlement object. This field will be present in the JSON response if and
549
- * only if `category` is equal to `card_settlement`.
358
+ * A Inbound Real Time Payments Transfer Decline object. This field will be present
359
+ * in the JSON response if and only if `category` is equal to
360
+ * `inbound_real_time_payments_transfer_decline`.
550
361
  */
551
- interface CardSettlement {
362
+ interface InboundRealTimePaymentsTransferDecline {
552
363
  /**
553
- * The amount in the minor unit of the transaction's settlement currency. For
364
+ * The declined amount in the minor unit of the destination account currency. For
554
365
  * dollars, for example, this is cents.
555
366
  */
556
367
  amount: number;
557
368
  /**
558
- * The Card Authorization that was created prior to this Card Settlement, if on
559
- * exists.
369
+ * The name the sender of the transfer specified as the recipient of the transfer.
560
370
  */
561
- card_authorization: string | null;
371
+ creditor_name: string;
562
372
  /**
563
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
564
- * transaction's settlement currency.
373
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
374
+ * transfer's currency. This will always be "USD" for a Real Time Payments
375
+ * transfer.
565
376
  */
566
377
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
567
378
  /**
568
- * The Card Settlement identifier.
569
- */
570
- id: string;
571
- /**
572
- * The merchant identifier (commonly abbreviated as MID) of the merchant the card
573
- * is transacting with.
574
- */
575
- merchant_acceptor_id: string | null;
576
- /**
577
- * The 4-digit MCC describing the merchant's business.
578
- */
579
- merchant_category_code: string;
580
- /**
581
- * The city the merchant resides in.
582
- */
583
- merchant_city: string | null;
584
- /**
585
- * The country the merchant resides in.
586
- */
587
- merchant_country: string;
588
- /**
589
- * The name of the merchant.
379
+ * The account number of the account that sent the transfer.
590
380
  */
591
- merchant_name: string | null;
381
+ debtor_account_number: string;
592
382
  /**
593
- * The state the merchant resides in.
383
+ * The name provided by the sender of the transfer.
594
384
  */
595
- merchant_state: string | null;
385
+ debtor_name: string;
596
386
  /**
597
- * The identifier of the Pending Transaction associated with this Transaction.
387
+ * The routing number of the account that sent the transfer.
598
388
  */
599
- pending_transaction_id: string | null;
389
+ debtor_routing_number: string;
600
390
  /**
601
- * The amount in the minor unit of the transaction's presentment currency.
391
+ * Why the transfer was declined.
602
392
  */
603
- presentment_amount: number;
393
+ reason:
394
+ | 'account_number_canceled'
395
+ | 'account_number_disabled'
396
+ | 'account_restricted'
397
+ | 'group_locked'
398
+ | 'entity_not_active'
399
+ | 'real_time_payments_not_enabled';
604
400
  /**
605
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
606
- * transaction's presentment currency.
401
+ * Additional information included with the transfer.
607
402
  */
608
- presentment_currency: string;
403
+ remittance_information: string | null;
609
404
  /**
610
- * A constant representing the object's type. For this resource it will always be
611
- * `card_settlement`.
405
+ * The Real Time Payments network identification of the declined transfer.
612
406
  */
613
- type: 'card_settlement';
407
+ transaction_identification: string;
614
408
  }
615
409
  /**
616
- * A Card Revenue Payment object. This field will be present in the JSON response
617
- * if and only if `category` is equal to `card_revenue_payment`.
410
+ * A International ACH Decline object. This field will be present in the JSON
411
+ * response if and only if `category` is equal to `international_ach_decline`.
618
412
  */
619
- interface CardRevenuePayment {
413
+ interface InternationalACHDecline {
620
414
  /**
621
- * The amount in the minor unit of the transaction's currency. For dollars, for
622
- * example, this is cents.
415
+ * The declined amount in the minor unit of the destination account currency. For
416
+ * dollars, for example, this is cents.
623
417
  */
624
418
  amount: number;
625
- /**
626
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
627
- * currency.
628
- */
629
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
630
- /**
631
- * The end of the period for which this transaction paid interest.
632
- */
633
- period_end: string;
634
- /**
635
- * The start of the period for which this transaction paid interest.
636
- */
637
- period_start: string;
638
- /**
639
- * The account the card belonged to.
640
- */
641
- transacted_on_account_id: string | null;
419
+ destination_country_code: string;
420
+ destination_currency_code: string;
421
+ foreign_exchange_indicator: string;
422
+ foreign_exchange_reference: string | null;
423
+ foreign_exchange_reference_indicator: string;
424
+ foreign_payment_amount: number;
425
+ foreign_trace_number: string | null;
426
+ international_transaction_type_code: string;
427
+ originating_currency_code: string;
428
+ originating_depository_financial_institution_branch_country: string;
429
+ originating_depository_financial_institution_id: string;
430
+ originating_depository_financial_institution_id_qualifier: string;
431
+ originating_depository_financial_institution_name: string;
432
+ originator_city: string;
433
+ originator_company_entry_description: string;
434
+ originator_country: string;
435
+ originator_identification: string;
436
+ originator_name: string;
437
+ originator_postal_code: string | null;
438
+ originator_state_or_province: string | null;
439
+ originator_street_address: string;
440
+ payment_related_information: string | null;
441
+ payment_related_information2: string | null;
442
+ receiver_city: string;
443
+ receiver_country: string;
444
+ receiver_identification_number: string | null;
445
+ receiver_postal_code: string | null;
446
+ receiver_state_or_province: string | null;
447
+ receiver_street_address: string;
448
+ receiving_company_or_individual_name: string;
449
+ receiving_depository_financial_institution_country: string;
450
+ receiving_depository_financial_institution_id: string;
451
+ receiving_depository_financial_institution_id_qualifier: string;
452
+ receiving_depository_financial_institution_name: string;
453
+ trace_number: string;
642
454
  }
643
455
  /**
644
- * A Check Deposit Acceptance object. This field will be present in the JSON
645
- * response if and only if `category` is equal to `check_deposit_acceptance`.
456
+ * A Wire Decline object. This field will be present in the JSON response if and
457
+ * only if `category` is equal to `wire_decline`.
646
458
  */
647
- interface CheckDepositAcceptance {
648
- /**
649
- * The account number printed on the check.
650
- */
651
- account_number: string;
459
+ interface WireDecline {
652
460
  /**
653
- * The amount to be deposited in the minor unit of the transaction's currency. For
461
+ * The declined amount in the minor unit of the destination account currency. For
654
462
  * dollars, for example, this is cents.
655
463
  */
656
464
  amount: number;
465
+ beneficiary_address_line1: string | null;
466
+ beneficiary_address_line2: string | null;
467
+ beneficiary_address_line3: string | null;
468
+ beneficiary_name: string | null;
469
+ beneficiary_reference: string | null;
470
+ description: string;
471
+ input_message_accountability_data: string | null;
472
+ originator_address_line1: string | null;
473
+ originator_address_line2: string | null;
474
+ originator_address_line3: string | null;
475
+ originator_name: string | null;
476
+ originator_to_beneficiary_information_line1: string | null;
477
+ originator_to_beneficiary_information_line2: string | null;
478
+ originator_to_beneficiary_information_line3: string | null;
479
+ originator_to_beneficiary_information_line4: string | null;
657
480
  /**
658
- * An additional line of metadata printed on the check. This typically includes the
659
- * check number for business checks.
660
- */
661
- auxiliary_on_us: string | null;
662
- /**
663
- * The ID of the Check Deposit that was accepted.
664
- */
665
- check_deposit_id: string;
666
- /**
667
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
668
- * transaction's currency.
669
- */
670
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
671
- /**
672
- * The routing number printed on the check.
673
- */
674
- routing_number: string;
675
- /**
676
- * The check serial number, if present, for consumer checks. For business checks,
677
- * the serial number is usually in the `auxiliary_on_us` field.
481
+ * Why the wire transfer was declined.
678
482
  */
679
- serial_number: string | null;
680
- }
681
- /**
682
- * A Check Deposit Return object. This field will be present in the JSON response
483
+ reason:
484
+ | 'account_number_canceled'
485
+ | 'account_number_disabled'
486
+ | 'entity_not_active'
487
+ | 'group_locked'
488
+ | 'no_account_number'
489
+ | 'transaction_not_allowed';
490
+ }
491
+ }
492
+ }
493
+ /**
494
+ * If the ACH Transfer attempt succeeds, this will contain the resulting
495
+ * [Transaction](#transactions) object. The Transaction's `source` will be of
496
+ * `category: inbound_ach_transfer`.
497
+ */
498
+ interface Transaction {
499
+ /**
500
+ * The Transaction identifier.
501
+ */
502
+ id: string;
503
+ /**
504
+ * The identifier for the Account the Transaction belongs to.
505
+ */
506
+ account_id: string;
507
+ /**
508
+ * The Transaction amount in the minor unit of its currency. For dollars, for
509
+ * example, this is cents.
510
+ */
511
+ amount: number;
512
+ /**
513
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
514
+ * Transaction occured.
515
+ */
516
+ created_at: string;
517
+ /**
518
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
519
+ * Transaction's currency. This will match the currency on the Transcation's
520
+ * Account.
521
+ */
522
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
523
+ /**
524
+ * For a Transaction related to a transfer, this is the description you provide.
525
+ * For a Transaction related to a payment, this is the description the vendor
526
+ * provides.
527
+ */
528
+ description: string;
529
+ /**
530
+ * The identifier for the route this Transaction came through. Routes are things
531
+ * like cards and ACH details.
532
+ */
533
+ route_id: string | null;
534
+ /**
535
+ * The type of the route this Transaction came through.
536
+ */
537
+ route_type: 'account_number' | 'card' | null;
538
+ /**
539
+ * This is an object giving more details on the network-level event that caused the
540
+ * Transaction. Note that for backwards compatibility reasons, additional
541
+ * undocumented keys may appear in this object. These should be treated as
542
+ * deprecated and will be removed in the future.
543
+ */
544
+ source: Transaction.Source;
545
+ /**
546
+ * A constant representing the object's type. For this resource it will always be
547
+ * `transaction`.
548
+ */
549
+ type: 'transaction';
550
+ }
551
+ namespace Transaction {
552
+ /**
553
+ * This is an object giving more details on the network-level event that caused the
554
+ * Transaction. Note that for backwards compatibility reasons, additional
555
+ * undocumented keys may appear in this object. These should be treated as
556
+ * deprecated and will be removed in the future.
557
+ */
558
+ interface Source {
559
+ /**
560
+ * A Account Transfer Intention object. This field will be present in the JSON
561
+ * response if and only if `category` is equal to `account_transfer_intention`.
562
+ */
563
+ account_transfer_intention: Source.AccountTransferIntention | null;
564
+ /**
565
+ * A ACH Transfer Intention object. This field will be present in the JSON response
566
+ * if and only if `category` is equal to `ach_transfer_intention`.
567
+ */
568
+ ach_transfer_intention: Source.ACHTransferIntention | null;
569
+ /**
570
+ * A ACH Transfer Rejection object. This field will be present in the JSON response
571
+ * if and only if `category` is equal to `ach_transfer_rejection`.
572
+ */
573
+ ach_transfer_rejection: Source.ACHTransferRejection | null;
574
+ /**
575
+ * A ACH Transfer Return object. This field will be present in the JSON response if
576
+ * and only if `category` is equal to `ach_transfer_return`.
577
+ */
578
+ ach_transfer_return: Source.ACHTransferReturn | null;
579
+ /**
580
+ * A Card Dispute Acceptance object. This field will be present in the JSON
581
+ * response if and only if `category` is equal to `card_dispute_acceptance`.
582
+ */
583
+ card_dispute_acceptance: Source.CardDisputeAcceptance | null;
584
+ /**
585
+ * A Card Refund object. This field will be present in the JSON response if and
586
+ * only if `category` is equal to `card_refund`.
587
+ */
588
+ card_refund: Source.CardRefund | null;
589
+ /**
590
+ * A Card Revenue Payment object. This field will be present in the JSON response
591
+ * if and only if `category` is equal to `card_revenue_payment`.
592
+ */
593
+ card_revenue_payment: Source.CardRevenuePayment | null;
594
+ /**
595
+ * A Card Settlement object. This field will be present in the JSON response if and
596
+ * only if `category` is equal to `card_settlement`.
597
+ */
598
+ card_settlement: Source.CardSettlement | null;
599
+ /**
600
+ * The type of transaction that took place. We may add additional possible values
601
+ * for this enum over time; your application should be able to handle such
602
+ * additions gracefully.
603
+ */
604
+ category:
605
+ | 'account_transfer_intention'
606
+ | 'ach_transfer_intention'
607
+ | 'ach_transfer_rejection'
608
+ | 'ach_transfer_return'
609
+ | 'card_dispute_acceptance'
610
+ | 'card_refund'
611
+ | 'card_revenue_payment'
612
+ | 'card_settlement'
613
+ | 'check_deposit_acceptance'
614
+ | 'check_deposit_return'
615
+ | 'check_transfer_deposit'
616
+ | 'check_transfer_intention'
617
+ | 'check_transfer_rejection'
618
+ | 'check_transfer_return'
619
+ | 'check_transfer_stop_payment_request'
620
+ | 'fee_payment'
621
+ | 'inbound_ach_transfer'
622
+ | 'inbound_ach_transfer_return_intention'
623
+ | 'inbound_check'
624
+ | 'inbound_international_ach_transfer'
625
+ | 'inbound_real_time_payments_transfer_confirmation'
626
+ | 'inbound_wire_drawdown_payment'
627
+ | 'inbound_wire_drawdown_payment_reversal'
628
+ | 'inbound_wire_reversal'
629
+ | 'inbound_wire_transfer'
630
+ | 'interest_payment'
631
+ | 'internal_source'
632
+ | 'real_time_payments_transfer_acknowledgement'
633
+ | 'sample_funds'
634
+ | 'wire_transfer_intention'
635
+ | 'wire_transfer_rejection'
636
+ | 'other';
637
+ /**
638
+ * A Check Deposit Acceptance object. This field will be present in the JSON
639
+ * response if and only if `category` is equal to `check_deposit_acceptance`.
640
+ */
641
+ check_deposit_acceptance: Source.CheckDepositAcceptance | null;
642
+ /**
643
+ * A Check Deposit Return object. This field will be present in the JSON response
683
644
  * if and only if `category` is equal to `check_deposit_return`.
684
645
  */
685
- interface CheckDepositReturn {
686
- /**
687
- * The amount in the minor unit of the transaction's currency. For dollars, for
688
- * example, this is cents.
689
- */
690
- amount: number;
691
- /**
692
- * The identifier of the Check Deposit that was returned.
693
- */
694
- check_deposit_id: string;
695
- /**
696
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
697
- * transaction's currency.
698
- */
699
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
700
- return_reason:
701
- | 'ach_conversion_not_supported'
702
- | 'closed_account'
703
- | 'duplicate_submission'
704
- | 'insufficient_funds'
705
- | 'no_account'
706
- | 'not_authorized'
707
- | 'stale_dated'
708
- | 'stop_payment'
709
- | 'unknown_reason'
710
- | 'unmatched_details'
711
- | 'unreadable_image'
712
- | 'endorsement_irregular';
713
- /**
714
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
715
- * the check deposit was returned.
716
- */
717
- returned_at: string;
718
- /**
719
- * The identifier of the transaction that reversed the original check deposit
720
- * transaction.
721
- */
722
- transaction_id: string;
723
- }
646
+ check_deposit_return: Source.CheckDepositReturn | null;
647
+ /**
648
+ * A Check Transfer Deposit object. This field will be present in the JSON response
649
+ * if and only if `category` is equal to `check_transfer_deposit`.
650
+ */
651
+ check_transfer_deposit: Source.CheckTransferDeposit | null;
724
652
  /**
725
653
  * A Check Transfer Intention object. This field will be present in the JSON
726
654
  * response if and only if `category` is equal to `check_transfer_intention`.
727
655
  */
728
- interface CheckTransferIntention {
729
- /**
730
- * The city of the check's destination.
731
- */
732
- address_city: string;
733
- /**
734
- * The street address of the check's destination.
735
- */
736
- address_line1: string;
737
- /**
738
- * The second line of the address of the check's destination.
739
- */
740
- address_line2: string | null;
656
+ check_transfer_intention: Source.CheckTransferIntention | null;
657
+ /**
658
+ * A Check Transfer Rejection object. This field will be present in the JSON
659
+ * response if and only if `category` is equal to `check_transfer_rejection`.
660
+ */
661
+ check_transfer_rejection: Source.CheckTransferRejection | null;
662
+ /**
663
+ * A Check Transfer Return object. This field will be present in the JSON response
664
+ * if and only if `category` is equal to `check_transfer_return`.
665
+ */
666
+ check_transfer_return: Source.CheckTransferReturn | null;
667
+ /**
668
+ * A Check Transfer Stop Payment Request object. This field will be present in the
669
+ * JSON response if and only if `category` is equal to
670
+ * `check_transfer_stop_payment_request`.
671
+ */
672
+ check_transfer_stop_payment_request: Source.CheckTransferStopPaymentRequest | null;
673
+ /**
674
+ * A Fee Payment object. This field will be present in the JSON response if and
675
+ * only if `category` is equal to `fee_payment`.
676
+ */
677
+ fee_payment: Source.FeePayment | null;
678
+ /**
679
+ * A Inbound ACH Transfer object. This field will be present in the JSON response
680
+ * if and only if `category` is equal to `inbound_ach_transfer`.
681
+ */
682
+ inbound_ach_transfer: Source.InboundACHTransfer | null;
683
+ /**
684
+ * A Inbound Check object. This field will be present in the JSON response if and
685
+ * only if `category` is equal to `inbound_check`.
686
+ */
687
+ inbound_check: Source.InboundCheck | null;
688
+ /**
689
+ * A Inbound International ACH Transfer object. This field will be present in the
690
+ * JSON response if and only if `category` is equal to
691
+ * `inbound_international_ach_transfer`.
692
+ */
693
+ inbound_international_ach_transfer: Source.InboundInternationalACHTransfer | null;
694
+ /**
695
+ * A Inbound Real Time Payments Transfer Confirmation object. This field will be
696
+ * present in the JSON response if and only if `category` is equal to
697
+ * `inbound_real_time_payments_transfer_confirmation`.
698
+ */
699
+ inbound_real_time_payments_transfer_confirmation: Source.InboundRealTimePaymentsTransferConfirmation | null;
700
+ /**
701
+ * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
702
+ * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
703
+ */
704
+ inbound_wire_drawdown_payment: Source.InboundWireDrawdownPayment | null;
705
+ /**
706
+ * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
707
+ * the JSON response if and only if `category` is equal to
708
+ * `inbound_wire_drawdown_payment_reversal`.
709
+ */
710
+ inbound_wire_drawdown_payment_reversal: Source.InboundWireDrawdownPaymentReversal | null;
711
+ /**
712
+ * A Inbound Wire Reversal object. This field will be present in the JSON response
713
+ * if and only if `category` is equal to `inbound_wire_reversal`.
714
+ */
715
+ inbound_wire_reversal: Source.InboundWireReversal | null;
716
+ /**
717
+ * A Inbound Wire Transfer object. This field will be present in the JSON response
718
+ * if and only if `category` is equal to `inbound_wire_transfer`.
719
+ */
720
+ inbound_wire_transfer: Source.InboundWireTransfer | null;
721
+ /**
722
+ * A Interest Payment object. This field will be present in the JSON response if
723
+ * and only if `category` is equal to `interest_payment`.
724
+ */
725
+ interest_payment: Source.InterestPayment | null;
726
+ /**
727
+ * A Internal Source object. This field will be present in the JSON response if and
728
+ * only if `category` is equal to `internal_source`.
729
+ */
730
+ internal_source: Source.InternalSource | null;
731
+ /**
732
+ * A Real Time Payments Transfer Acknowledgement object. This field will be present
733
+ * in the JSON response if and only if `category` is equal to
734
+ * `real_time_payments_transfer_acknowledgement`.
735
+ */
736
+ real_time_payments_transfer_acknowledgement: Source.RealTimePaymentsTransferAcknowledgement | null;
737
+ /**
738
+ * A Sample Funds object. This field will be present in the JSON response if and
739
+ * only if `category` is equal to `sample_funds`.
740
+ */
741
+ sample_funds: Source.SampleFunds | null;
742
+ /**
743
+ * A Wire Transfer Intention object. This field will be present in the JSON
744
+ * response if and only if `category` is equal to `wire_transfer_intention`.
745
+ */
746
+ wire_transfer_intention: Source.WireTransferIntention | null;
747
+ /**
748
+ * A Wire Transfer Rejection object. This field will be present in the JSON
749
+ * response if and only if `category` is equal to `wire_transfer_rejection`.
750
+ */
751
+ wire_transfer_rejection: Source.WireTransferRejection | null;
752
+ }
753
+ namespace Source {
754
+ /**
755
+ * A Account Transfer Intention object. This field will be present in the JSON
756
+ * response if and only if `category` is equal to `account_transfer_intention`.
757
+ */
758
+ interface AccountTransferIntention {
741
759
  /**
742
- * The state of the check's destination.
760
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
761
+ * for example, this is cents.
743
762
  */
744
- address_state: string;
763
+ amount: number;
745
764
  /**
746
- * The postal code of the check's destination.
765
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
766
+ * account currency.
747
767
  */
748
- address_zip: string;
768
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
749
769
  /**
750
- * The transfer amount in USD cents.
770
+ * The description you chose to give the transfer.
751
771
  */
752
- amount: number;
772
+ description: string;
753
773
  /**
754
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
755
- * currency.
774
+ * The identifier of the Account to where the Account Transfer was sent.
756
775
  */
757
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
776
+ destination_account_id: string;
758
777
  /**
759
- * The name that will be printed on the check.
778
+ * The identifier of the Account from where the Account Transfer was sent.
760
779
  */
761
- recipient_name: string;
780
+ source_account_id: string;
762
781
  /**
763
- * The identifier of the Check Transfer with which this is associated.
782
+ * The identifier of the Account Transfer that led to this Pending Transaction.
764
783
  */
765
784
  transfer_id: string;
766
785
  }
767
786
  /**
768
- * A Check Transfer Return object. This field will be present in the JSON response
769
- * if and only if `category` is equal to `check_transfer_return`.
770
- */
771
- interface CheckTransferReturn {
772
- /**
773
- * If available, a document with additional information about the return.
774
- */
775
- file_id: string | null;
776
- /**
777
- * The reason why the check was returned.
778
- */
779
- reason: 'mail_delivery_failure' | 'refused_by_recipient' | 'returned_not_authorized';
780
- /**
781
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
782
- * the check was returned.
783
- */
784
- returned_at: string;
787
+ * A ACH Transfer Intention object. This field will be present in the JSON response
788
+ * if and only if `category` is equal to `ach_transfer_intention`.
789
+ */
790
+ interface ACHTransferIntention {
791
+ account_number: string;
785
792
  /**
786
- * The identifier of the Transaction that was created to credit you for the
787
- * returned check.
793
+ * The amount in the minor unit of the transaction's currency. For dollars, for
794
+ * example, this is cents.
788
795
  */
789
- transaction_id: string | null;
796
+ amount: number;
797
+ routing_number: string;
798
+ statement_descriptor: string;
790
799
  /**
791
- * The identifier of the returned Check Transfer.
800
+ * The identifier of the ACH Transfer that led to this Transaction.
792
801
  */
793
802
  transfer_id: string;
794
803
  }
795
804
  /**
796
- * A Check Transfer Rejection object. This field will be present in the JSON
797
- * response if and only if `category` is equal to `check_transfer_rejection`.
805
+ * A ACH Transfer Rejection object. This field will be present in the JSON response
806
+ * if and only if `category` is equal to `ach_transfer_rejection`.
798
807
  */
799
- interface CheckTransferRejection {
808
+ interface ACHTransferRejection {
800
809
  /**
801
- * The identifier of the Check Transfer that led to this Transaction.
810
+ * The identifier of the ACH Transfer that led to this Transaction.
802
811
  */
803
812
  transfer_id: string;
804
813
  }
805
814
  /**
806
- * A Check Transfer Stop Payment Request object. This field will be present in the
807
- * JSON response if and only if `category` is equal to
808
- * `check_transfer_stop_payment_request`.
815
+ * A ACH Transfer Return object. This field will be present in the JSON response if
816
+ * and only if `category` is equal to `ach_transfer_return`.
809
817
  */
810
- interface CheckTransferStopPaymentRequest {
818
+ interface ACHTransferReturn {
811
819
  /**
812
- * The time the stop-payment was requested.
820
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
821
+ * the transfer was created.
813
822
  */
814
- requested_at: string;
823
+ created_at: string;
815
824
  /**
816
- * The transaction ID of the corresponding credit transaction.
825
+ * The three character ACH return code, in the range R01 to R85.
817
826
  */
818
- transaction_id: string;
827
+ raw_return_reason_code: string;
819
828
  /**
820
- * The ID of the check transfer that was stopped.
829
+ * Why the ACH Transfer was returned.
821
830
  */
822
- transfer_id: string;
831
+ return_reason_code:
832
+ | 'insufficient_fund'
833
+ | 'no_account'
834
+ | 'account_closed'
835
+ | 'invalid_account_number_structure'
836
+ | 'account_frozen_entry_returned_per_ofac_instruction'
837
+ | 'credit_entry_refused_by_receiver'
838
+ | 'unauthorized_debit_to_consumer_account_using_corporate_sec_code'
839
+ | 'corporate_customer_advised_not_authorized'
840
+ | 'payment_stopped'
841
+ | 'non_transaction_account'
842
+ | 'uncollected_funds'
843
+ | 'routing_number_check_digit_error'
844
+ | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
845
+ | 'amount_field_error'
846
+ | 'authorization_revoked_by_customer'
847
+ | 'invalid_ach_routing_number'
848
+ | 'file_record_edit_criteria'
849
+ | 'enr_invalid_individual_name'
850
+ | 'returned_per_odfi_request'
851
+ | 'limited_participation_dfi'
852
+ | 'incorrectly_coded_outbound_international_payment'
853
+ | 'account_sold_to_another_dfi'
854
+ | 'addenda_error'
855
+ | 'beneficiary_or_account_holder_deceased'
856
+ | 'customer_advised_not_within_authorization_terms'
857
+ | 'corrected_return'
858
+ | 'duplicate_entry'
859
+ | 'duplicate_return'
860
+ | 'enr_duplicate_enrollment'
861
+ | 'enr_invalid_dfi_account_number'
862
+ | 'enr_invalid_individual_id_number'
863
+ | 'enr_invalid_representative_payee_indicator'
864
+ | 'enr_invalid_transaction_code'
865
+ | 'enr_return_of_enr_entry'
866
+ | 'enr_routing_number_check_digit_error'
867
+ | 'entry_not_processed_by_gateway'
868
+ | 'field_error'
869
+ | 'foreign_receiving_dfi_unable_to_settle'
870
+ | 'iat_entry_coding_error'
871
+ | 'improper_effective_entry_date'
872
+ | 'improper_source_document_source_document_presented'
873
+ | 'invalid_company_id'
874
+ | 'invalid_foreign_receiving_dfi_identification'
875
+ | 'invalid_individual_id_number'
876
+ | 'item_and_rck_entry_presented_for_payment'
877
+ | 'item_related_to_rck_entry_is_ineligible'
878
+ | 'mandatory_field_error'
879
+ | 'misrouted_dishonored_return'
880
+ | 'misrouted_return'
881
+ | 'no_errors_found'
882
+ | 'non_acceptance_of_r62_dishonored_return'
883
+ | 'non_participant_in_iat_program'
884
+ | 'permissible_return_entry'
885
+ | 'permissible_return_entry_not_accepted'
886
+ | 'rdfi_non_settlement'
887
+ | 'rdfi_participant_in_check_truncation_program'
888
+ | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
889
+ | 'return_not_a_duplicate'
890
+ | 'return_of_erroneous_or_reversing_debit'
891
+ | 'return_of_improper_credit_entry'
892
+ | 'return_of_improper_debit_entry'
893
+ | 'return_of_xck_entry'
894
+ | 'source_document_presented_for_payment'
895
+ | 'state_law_affecting_rck_acceptance'
896
+ | 'stop_payment_on_item_related_to_rck_entry'
897
+ | 'stop_payment_on_source_document'
898
+ | 'timely_original_return'
899
+ | 'trace_number_error'
900
+ | 'untimely_dishonored_return'
901
+ | 'untimely_return';
823
902
  /**
824
- * A constant representing the object's type. For this resource it will always be
825
- * `check_transfer_stop_payment_request`.
903
+ * The identifier of the Tranasaction associated with this return.
826
904
  */
827
- type: 'check_transfer_stop_payment_request';
905
+ transaction_id: string;
906
+ /**
907
+ * The identifier of the ACH Transfer associated with this return.
908
+ */
909
+ transfer_id: string;
828
910
  }
829
911
  /**
830
- * A Fee Payment object. This field will be present in the JSON response if and
831
- * only if `category` is equal to `fee_payment`.
912
+ * A Card Dispute Acceptance object. This field will be present in the JSON
913
+ * response if and only if `category` is equal to `card_dispute_acceptance`.
832
914
  */
833
- interface FeePayment {
915
+ interface CardDisputeAcceptance {
834
916
  /**
835
- * The amount in the minor unit of the transaction's currency. For dollars, for
836
- * example, this is cents.
917
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
918
+ * the Card Dispute was accepted.
837
919
  */
838
- amount: number;
920
+ accepted_at: string;
839
921
  /**
840
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
841
- * currency.
922
+ * The identifier of the Card Dispute that was accepted.
842
923
  */
843
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
844
- }
845
- /**
846
- * A Inbound ACH Transfer object. This field will be present in the JSON response
847
- * if and only if `category` is equal to `inbound_ach_transfer`.
848
- */
849
- interface InboundACHTransfer {
924
+ card_dispute_id: string;
850
925
  /**
851
- * The amount in the minor unit of the destination account currency. For dollars,
852
- * for example, this is cents.
926
+ * The identifier of the Transaction that was created to return the disputed funds
927
+ * to your account.
853
928
  */
854
- amount: number;
855
- originator_company_descriptive_date: string | null;
856
- originator_company_discretionary_data: string | null;
857
- originator_company_entry_description: string;
858
- originator_company_id: string;
859
- originator_company_name: string;
860
- receiver_id_number: string | null;
861
- receiver_name: string | null;
862
- trace_number: string;
929
+ transaction_id: string;
863
930
  }
864
931
  /**
865
- * A Inbound Check object. This field will be present in the JSON response if and
866
- * only if `category` is equal to `inbound_check`.
932
+ * A Card Refund object. This field will be present in the JSON response if and
933
+ * only if `category` is equal to `card_refund`.
867
934
  */
868
- interface InboundCheck {
935
+ interface CardRefund {
869
936
  /**
870
- * The amount in the minor unit of the destination account currency. For dollars,
937
+ * The Card Refund identifier.
938
+ */
939
+ id: string;
940
+ /**
941
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
871
942
  * for example, this is cents.
872
943
  */
873
944
  amount: number;
874
- check_front_image_file_id: string | null;
875
- check_number: string | null;
876
- check_rear_image_file_id: string | null;
877
945
  /**
878
946
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
879
947
  * transaction's currency.
880
948
  */
881
949
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
882
- }
883
- /**
884
- * A Inbound International ACH Transfer object. This field will be present in the
885
- * JSON response if and only if `category` is equal to
886
- * `inbound_international_ach_transfer`.
887
- */
888
- interface InboundInternationalACHTransfer {
889
- /**
890
- * The amount in the minor unit of the destination account currency. For dollars,
891
- * for example, this is cents.
892
- */
893
- amount: number;
894
- destination_country_code: string;
895
- destination_currency_code: string;
896
- foreign_exchange_indicator: string;
897
- foreign_exchange_reference: string | null;
898
- foreign_exchange_reference_indicator: string;
899
- foreign_payment_amount: number;
900
- foreign_trace_number: string | null;
901
- international_transaction_type_code: string;
902
- originating_currency_code: string;
903
- originating_depository_financial_institution_branch_country: string;
904
- originating_depository_financial_institution_id: string;
905
- originating_depository_financial_institution_id_qualifier: string;
906
- originating_depository_financial_institution_name: string;
907
- originator_city: string;
908
- originator_company_entry_description: string;
909
- originator_country: string;
910
- originator_identification: string;
911
- originator_name: string;
912
- originator_postal_code: string | null;
913
- originator_state_or_province: string | null;
914
- originator_street_address: string;
915
- payment_related_information: string | null;
916
- payment_related_information2: string | null;
917
- receiver_city: string;
918
- receiver_country: string;
919
- receiver_identification_number: string | null;
920
- receiver_postal_code: string | null;
921
- receiver_state_or_province: string | null;
922
- receiver_street_address: string;
923
- receiving_company_or_individual_name: string;
924
- receiving_depository_financial_institution_country: string;
925
- receiving_depository_financial_institution_id: string;
926
- receiving_depository_financial_institution_id_qualifier: string;
927
- receiving_depository_financial_institution_name: string;
928
- trace_number: string;
929
- }
930
- /**
931
- * A Inbound Real Time Payments Transfer Confirmation object. This field will be
932
- * present in the JSON response if and only if `category` is equal to
933
- * `inbound_real_time_payments_transfer_confirmation`.
934
- */
935
- interface InboundRealTimePaymentsTransferConfirmation {
936
- /**
937
- * The amount in the minor unit of the transfer's currency. For dollars, for
938
- * example, this is cents.
939
- */
940
- amount: number;
941
950
  /**
942
- * The name the sender of the transfer specified as the recipient of the transfer.
951
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
952
+ * is transacting with.
943
953
  */
944
- creditor_name: string;
954
+ merchant_acceptor_id: string | null;
945
955
  /**
946
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
947
- * currency. This will always be "USD" for a Real Time Payments transfer.
956
+ * The 4-digit MCC describing the merchant's business.
948
957
  */
949
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
958
+ merchant_category_code: string;
950
959
  /**
951
- * The account number of the account that sent the transfer.
960
+ * The city the merchant resides in.
952
961
  */
953
- debtor_account_number: string;
962
+ merchant_city: string | null;
954
963
  /**
955
- * The name provided by the sender of the transfer.
964
+ * The country the merchant resides in.
956
965
  */
957
- debtor_name: string;
966
+ merchant_country: string;
958
967
  /**
959
- * The routing number of the account that sent the transfer.
968
+ * The name of the merchant.
960
969
  */
961
- debtor_routing_number: string;
970
+ merchant_name: string | null;
962
971
  /**
963
- * Additional information included with the transfer.
972
+ * The state the merchant resides in.
964
973
  */
965
- remittance_information: string | null;
974
+ merchant_state: string | null;
966
975
  /**
967
- * The Real Time Payments network identification of the transfer
976
+ * A constant representing the object's type. For this resource it will always be
977
+ * `card_refund`.
968
978
  */
969
- transaction_identification: string;
979
+ type: 'card_refund';
970
980
  }
971
981
  /**
972
- * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
973
- * the JSON response if and only if `category` is equal to
974
- * `inbound_wire_drawdown_payment_reversal`.
982
+ * A Card Revenue Payment object. This field will be present in the JSON response
983
+ * if and only if `category` is equal to `card_revenue_payment`.
975
984
  */
976
- interface InboundWireDrawdownPaymentReversal {
985
+ interface CardRevenuePayment {
977
986
  /**
978
- * The amount that was reversed.
987
+ * The amount in the minor unit of the transaction's currency. For dollars, for
988
+ * example, this is cents.
979
989
  */
980
990
  amount: number;
981
991
  /**
982
- * The description on the reversal message from Fedwire.
992
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
993
+ * currency.
983
994
  */
984
- description: string;
995
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
985
996
  /**
986
- * The Fedwire cycle date for the wire reversal.
997
+ * The end of the period for which this transaction paid interest.
987
998
  */
988
- input_cycle_date: string;
999
+ period_end: string;
989
1000
  /**
990
- * The Fedwire transaction identifier.
1001
+ * The start of the period for which this transaction paid interest.
991
1002
  */
992
- input_message_accountability_data: string;
1003
+ period_start: string;
993
1004
  /**
994
- * The Fedwire sequence number.
1005
+ * The account the card belonged to.
995
1006
  */
996
- input_sequence_number: string;
1007
+ transacted_on_account_id: string | null;
1008
+ }
1009
+ /**
1010
+ * A Card Settlement object. This field will be present in the JSON response if and
1011
+ * only if `category` is equal to `card_settlement`.
1012
+ */
1013
+ interface CardSettlement {
997
1014
  /**
998
- * The Fedwire input source identifier.
1015
+ * The Card Settlement identifier.
999
1016
  */
1000
- input_source: string;
1017
+ id: string;
1001
1018
  /**
1002
- * The Fedwire cycle date for the wire transfer that was reversed.
1019
+ * The amount in the minor unit of the transaction's settlement currency. For
1020
+ * dollars, for example, this is cents.
1003
1021
  */
1004
- previous_message_input_cycle_date: string;
1022
+ amount: number;
1005
1023
  /**
1006
- * The Fedwire transaction identifier for the wire transfer that was reversed.
1024
+ * The Card Authorization that was created prior to this Card Settlement, if on
1025
+ * exists.
1007
1026
  */
1008
- previous_message_input_message_accountability_data: string;
1027
+ card_authorization: string | null;
1009
1028
  /**
1010
- * The Fedwire sequence number for the wire transfer that was reversed.
1029
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1030
+ * transaction's settlement currency.
1011
1031
  */
1012
- previous_message_input_sequence_number: string;
1032
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1013
1033
  /**
1014
- * The Fedwire input source identifier for the wire transfer that was reversed.
1034
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
1035
+ * is transacting with.
1015
1036
  */
1016
- previous_message_input_source: string;
1017
- }
1018
- /**
1019
- * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
1020
- * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
1021
- */
1022
- interface InboundWireDrawdownPayment {
1037
+ merchant_acceptor_id: string | null;
1023
1038
  /**
1024
- * The amount in the minor unit of the transaction's currency. For dollars, for
1025
- * example, this is cents.
1039
+ * The 4-digit MCC describing the merchant's business.
1026
1040
  */
1027
- amount: number;
1028
- beneficiary_address_line1: string | null;
1029
- beneficiary_address_line2: string | null;
1030
- beneficiary_address_line3: string | null;
1031
- beneficiary_name: string | null;
1032
- beneficiary_reference: string | null;
1033
- description: string;
1034
- input_message_accountability_data: string | null;
1035
- originator_address_line1: string | null;
1036
- originator_address_line2: string | null;
1037
- originator_address_line3: string | null;
1038
- originator_name: string | null;
1039
- originator_to_beneficiary_information: string | null;
1040
- }
1041
- /**
1042
- * A Inbound Wire Reversal object. This field will be present in the JSON response
1043
- * if and only if `category` is equal to `inbound_wire_reversal`.
1044
- */
1045
- interface InboundWireReversal {
1041
+ merchant_category_code: string;
1046
1042
  /**
1047
- * The amount that was reversed.
1043
+ * The city the merchant resides in.
1048
1044
  */
1049
- amount: number;
1045
+ merchant_city: string | null;
1050
1046
  /**
1051
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1052
- * the reversal was created.
1047
+ * The country the merchant resides in.
1053
1048
  */
1054
- created_at: string;
1049
+ merchant_country: string;
1055
1050
  /**
1056
- * The description on the reversal message from Fedwire.
1051
+ * The name of the merchant.
1057
1052
  */
1058
- description: string;
1053
+ merchant_name: string | null;
1059
1054
  /**
1060
- * Additional financial institution information included in the wire reversal.
1055
+ * The state the merchant resides in.
1061
1056
  */
1062
- financial_institution_to_financial_institution_information: string | null;
1057
+ merchant_state: string | null;
1063
1058
  /**
1064
- * The Fedwire cycle date for the wire reversal.
1059
+ * The identifier of the Pending Transaction associated with this Transaction.
1065
1060
  */
1066
- input_cycle_date: string;
1061
+ pending_transaction_id: string | null;
1067
1062
  /**
1068
- * The Fedwire transaction identifier.
1063
+ * The amount in the minor unit of the transaction's presentment currency.
1069
1064
  */
1070
- input_message_accountability_data: string;
1065
+ presentment_amount: number;
1071
1066
  /**
1072
- * The Fedwire sequence number.
1067
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1068
+ * transaction's presentment currency.
1073
1069
  */
1074
- input_sequence_number: string;
1070
+ presentment_currency: string;
1075
1071
  /**
1076
- * The Fedwire input source identifier.
1072
+ * A constant representing the object's type. For this resource it will always be
1073
+ * `card_settlement`.
1077
1074
  */
1078
- input_source: string;
1075
+ type: 'card_settlement';
1076
+ }
1077
+ /**
1078
+ * A Check Deposit Acceptance object. This field will be present in the JSON
1079
+ * response if and only if `category` is equal to `check_deposit_acceptance`.
1080
+ */
1081
+ interface CheckDepositAcceptance {
1079
1082
  /**
1080
- * The Fedwire cycle date for the wire transfer that was reversed.
1083
+ * The account number printed on the check.
1081
1084
  */
1082
- previous_message_input_cycle_date: string;
1085
+ account_number: string;
1083
1086
  /**
1084
- * The Fedwire transaction identifier for the wire transfer that was reversed.
1087
+ * The amount to be deposited in the minor unit of the transaction's currency. For
1088
+ * dollars, for example, this is cents.
1085
1089
  */
1086
- previous_message_input_message_accountability_data: string;
1090
+ amount: number;
1087
1091
  /**
1088
- * The Fedwire sequence number for the wire transfer that was reversed.
1092
+ * An additional line of metadata printed on the check. This typically includes the
1093
+ * check number for business checks.
1089
1094
  */
1090
- previous_message_input_sequence_number: string;
1095
+ auxiliary_on_us: string | null;
1091
1096
  /**
1092
- * The Fedwire input source identifier for the wire transfer that was reversed.
1097
+ * The ID of the Check Deposit that was accepted.
1093
1098
  */
1094
- previous_message_input_source: string;
1099
+ check_deposit_id: string;
1095
1100
  /**
1096
- * Information included in the wire reversal for the receiving financial
1097
- * institution.
1101
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1102
+ * transaction's currency.
1098
1103
  */
1099
- receiver_financial_institution_information: string | null;
1104
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1100
1105
  /**
1101
- * The ID for the Transaction associated with the transfer reversal.
1106
+ * The routing number printed on the check.
1102
1107
  */
1103
- transaction_id: string | null;
1108
+ routing_number: string;
1104
1109
  /**
1105
- * The ID for the Wire Transfer that is being reversed.
1110
+ * The check serial number, if present, for consumer checks. For business checks,
1111
+ * the serial number is usually in the `auxiliary_on_us` field.
1106
1112
  */
1107
- wire_transfer_id: string;
1113
+ serial_number: string | null;
1108
1114
  }
1109
1115
  /**
1110
- * A Inbound Wire Transfer object. This field will be present in the JSON response
1111
- * if and only if `category` is equal to `inbound_wire_transfer`.
1116
+ * A Check Deposit Return object. This field will be present in the JSON response
1117
+ * if and only if `category` is equal to `check_deposit_return`.
1112
1118
  */
1113
- interface InboundWireTransfer {
1119
+ interface CheckDepositReturn {
1114
1120
  /**
1115
1121
  * The amount in the minor unit of the transaction's currency. For dollars, for
1116
1122
  * example, this is cents.
1117
1123
  */
1118
1124
  amount: number;
1119
- beneficiary_address_line1: string | null;
1120
- beneficiary_address_line2: string | null;
1121
- beneficiary_address_line3: string | null;
1122
- beneficiary_name: string | null;
1123
- beneficiary_reference: string | null;
1124
- description: string;
1125
- input_message_accountability_data: string | null;
1126
- originator_address_line1: string | null;
1127
- originator_address_line2: string | null;
1128
- originator_address_line3: string | null;
1129
- originator_name: string | null;
1130
- originator_to_beneficiary_information: string | null;
1131
- originator_to_beneficiary_information_line1: string | null;
1132
- originator_to_beneficiary_information_line2: string | null;
1133
- originator_to_beneficiary_information_line3: string | null;
1134
- originator_to_beneficiary_information_line4: string | null;
1125
+ /**
1126
+ * The identifier of the Check Deposit that was returned.
1127
+ */
1128
+ check_deposit_id: string;
1129
+ /**
1130
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1131
+ * transaction's currency.
1132
+ */
1133
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1134
+ return_reason:
1135
+ | 'ach_conversion_not_supported'
1136
+ | 'closed_account'
1137
+ | 'duplicate_submission'
1138
+ | 'insufficient_funds'
1139
+ | 'no_account'
1140
+ | 'not_authorized'
1141
+ | 'stale_dated'
1142
+ | 'stop_payment'
1143
+ | 'unknown_reason'
1144
+ | 'unmatched_details'
1145
+ | 'unreadable_image'
1146
+ | 'endorsement_irregular';
1147
+ /**
1148
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1149
+ * the check deposit was returned.
1150
+ */
1151
+ returned_at: string;
1152
+ /**
1153
+ * The identifier of the transaction that reversed the original check deposit
1154
+ * transaction.
1155
+ */
1156
+ transaction_id: string;
1135
1157
  }
1136
1158
  /**
1137
- * A Interest Payment object. This field will be present in the JSON response if
1138
- * and only if `category` is equal to `interest_payment`.
1159
+ * A Check Transfer Deposit object. This field will be present in the JSON response
1160
+ * if and only if `category` is equal to `check_transfer_deposit`.
1139
1161
  */
1140
- interface InterestPayment {
1141
- /**
1142
- * The account on which the interest was accrued.
1143
- */
1144
- accrued_on_account_id: string | null;
1162
+ interface CheckTransferDeposit {
1145
1163
  /**
1146
- * The amount in the minor unit of the transaction's currency. For dollars, for
1147
- * example, this is cents.
1164
+ * The identifier of the API File object containing an image of the back of the
1165
+ * deposited check.
1148
1166
  */
1149
- amount: number;
1167
+ back_image_file_id: string | null;
1150
1168
  /**
1151
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
1152
- * currency.
1169
+ * When the check was deposited.
1153
1170
  */
1154
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1171
+ deposited_at: string;
1155
1172
  /**
1156
- * The end of the period for which this transaction paid interest.
1173
+ * The identifier of the API File object containing an image of the front of the
1174
+ * deposited check.
1157
1175
  */
1158
- period_end: string;
1176
+ front_image_file_id: string | null;
1159
1177
  /**
1160
- * The start of the period for which this transaction paid interest.
1178
+ * A constant representing the object's type. For this resource it will always be
1179
+ * `check_transfer_deposit`.
1161
1180
  */
1162
- period_start: string;
1181
+ type: 'check_transfer_deposit';
1163
1182
  }
1164
1183
  /**
1165
- * A Internal Source object. This field will be present in the JSON response if and
1166
- * only if `category` is equal to `internal_source`.
1184
+ * A Check Transfer Intention object. This field will be present in the JSON
1185
+ * response if and only if `category` is equal to `check_transfer_intention`.
1167
1186
  */
1168
- interface InternalSource {
1187
+ interface CheckTransferIntention {
1188
+ /**
1189
+ * The city of the check's destination.
1190
+ */
1191
+ address_city: string | null;
1192
+ /**
1193
+ * The street address of the check's destination.
1194
+ */
1195
+ address_line1: string | null;
1196
+ /**
1197
+ * The second line of the address of the check's destination.
1198
+ */
1199
+ address_line2: string | null;
1169
1200
  /**
1170
- * The amount in the minor unit of the transaction's currency. For dollars, for
1171
- * example, this is cents.
1201
+ * The state of the check's destination.
1172
1202
  */
1173
- amount: number;
1203
+ address_state: string | null;
1174
1204
  /**
1175
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
1176
- * currency.
1205
+ * The postal code of the check's destination.
1177
1206
  */
1178
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1179
- reason:
1180
- | 'account_closure'
1181
- | 'bank_migration'
1182
- | 'cashback'
1183
- | 'collection_receivable'
1184
- | 'empyreal_adjustment'
1185
- | 'error'
1186
- | 'error_correction'
1187
- | 'fees'
1188
- | 'interest'
1189
- | 'negative_balance_forgiveness'
1190
- | 'sample_funds'
1191
- | 'sample_funds_return';
1192
- }
1193
- /**
1194
- * A Real Time Payments Transfer Acknowledgement object. This field will be present
1195
- * in the JSON response if and only if `category` is equal to
1196
- * `real_time_payments_transfer_acknowledgement`.
1197
- */
1198
- interface RealTimePaymentsTransferAcknowledgement {
1207
+ address_zip: string | null;
1199
1208
  /**
1200
1209
  * The transfer amount in USD cents.
1201
1210
  */
1202
1211
  amount: number;
1203
1212
  /**
1204
- * The destination account number.
1205
- */
1206
- destination_account_number: string;
1207
- /**
1208
- * The American Bankers' Association (ABA) Routing Transit Number (RTN).
1213
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
1214
+ * currency.
1209
1215
  */
1210
- destination_routing_number: string;
1216
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1211
1217
  /**
1212
- * Unstructured information that will show on the recipient's bank statement.
1218
+ * The name that will be printed on the check.
1213
1219
  */
1214
- remittance_information: string;
1220
+ recipient_name: string | null;
1215
1221
  /**
1216
- * The identifier of the Real Time Payments Transfer that led to this Transaction.
1222
+ * The identifier of the Check Transfer with which this is associated.
1217
1223
  */
1218
1224
  transfer_id: string;
1219
1225
  }
1220
1226
  /**
1221
- * A Sample Funds object. This field will be present in the JSON response if and
1222
- * only if `category` is equal to `sample_funds`.
1227
+ * A Check Transfer Rejection object. This field will be present in the JSON
1228
+ * response if and only if `category` is equal to `check_transfer_rejection`.
1223
1229
  */
1224
- interface SampleFunds {
1230
+ interface CheckTransferRejection {
1225
1231
  /**
1226
- * Where the sample funds came from.
1232
+ * The identifier of the Check Transfer that led to this Transaction.
1227
1233
  */
1228
- originator: string;
1234
+ transfer_id: string;
1229
1235
  }
1230
1236
  /**
1231
- * A Wire Transfer Intention object. This field will be present in the JSON
1232
- * response if and only if `category` is equal to `wire_transfer_intention`.
1237
+ * A Check Transfer Return object. This field will be present in the JSON response
1238
+ * if and only if `category` is equal to `check_transfer_return`.
1233
1239
  */
1234
- interface WireTransferIntention {
1240
+ interface CheckTransferReturn {
1235
1241
  /**
1236
- * The destination account number.
1242
+ * If available, a document with additional information about the return.
1237
1243
  */
1238
- account_number: string;
1244
+ file_id: string | null;
1239
1245
  /**
1240
- * The transfer amount in USD cents.
1246
+ * The reason why the check was returned.
1241
1247
  */
1242
- amount: number;
1248
+ reason: 'mail_delivery_failure' | 'refused_by_recipient' | 'returned_not_authorized';
1243
1249
  /**
1244
- * The message that will show on the recipient's bank statement.
1250
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1251
+ * the check was returned.
1245
1252
  */
1246
- message_to_recipient: string;
1253
+ returned_at: string;
1247
1254
  /**
1248
- * The American Bankers' Association (ABA) Routing Transit Number (RTN).
1255
+ * The identifier of the Transaction that was created to credit you for the
1256
+ * returned check.
1257
+ */
1258
+ transaction_id: string | null;
1259
+ /**
1260
+ * The identifier of the returned Check Transfer.
1249
1261
  */
1250
- routing_number: string;
1251
1262
  transfer_id: string;
1252
1263
  }
1253
1264
  /**
1254
- * A Wire Transfer Rejection object. This field will be present in the JSON
1255
- * response if and only if `category` is equal to `wire_transfer_rejection`.
1265
+ * A Check Transfer Stop Payment Request object. This field will be present in the
1266
+ * JSON response if and only if `category` is equal to
1267
+ * `check_transfer_stop_payment_request`.
1256
1268
  */
1257
- interface WireTransferRejection {
1269
+ interface CheckTransferStopPaymentRequest {
1270
+ /**
1271
+ * The time the stop-payment was requested.
1272
+ */
1273
+ requested_at: string;
1274
+ /**
1275
+ * The transaction ID of the corresponding credit transaction.
1276
+ */
1277
+ transaction_id: string;
1278
+ /**
1279
+ * The ID of the check transfer that was stopped.
1280
+ */
1258
1281
  transfer_id: string;
1282
+ /**
1283
+ * A constant representing the object's type. For this resource it will always be
1284
+ * `check_transfer_stop_payment_request`.
1285
+ */
1286
+ type: 'check_transfer_stop_payment_request';
1259
1287
  }
1260
- }
1261
- }
1262
- /**
1263
- * If the ACH Transfer attempt fails, this will contain the resulting
1264
- * [Declined Transaction](#declined-transactions) object. The Declined
1265
- * Transaction's `source` will be of `category: inbound_ach_transfer`.
1266
- */
1267
- interface DeclinedTransaction {
1268
- /**
1269
- * The identifier for the Account the Declined Transaction belongs to.
1270
- */
1271
- account_id: string;
1272
- /**
1273
- * The Declined Transaction amount in the minor unit of its currency. For dollars,
1274
- * for example, this is cents.
1275
- */
1276
- amount: number;
1277
- /**
1278
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
1279
- * Transaction occured.
1280
- */
1281
- created_at: string;
1282
- /**
1283
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
1284
- * Transaction's currency. This will match the currency on the Declined
1285
- * Transcation's Account.
1286
- */
1287
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1288
- /**
1289
- * This is the description the vendor provides.
1290
- */
1291
- description: string;
1292
- /**
1293
- * The Declined Transaction identifier.
1294
- */
1295
- id: string;
1296
- /**
1297
- * The identifier for the route this Declined Transaction came through. Routes are
1298
- * things like cards and ACH details.
1299
- */
1300
- route_id: string | null;
1301
- /**
1302
- * The type of the route this Declined Transaction came through.
1303
- */
1304
- route_type: 'account_number' | 'card' | null;
1305
- /**
1306
- * This is an object giving more details on the network-level event that caused the
1307
- * Declined Transaction. For example, for a card transaction this lists the
1308
- * merchant's industry and location. Note that for backwards compatibility reasons,
1309
- * additional undocumented keys may appear in this object. These should be treated
1310
- * as deprecated and will be removed in the future.
1311
- */
1312
- source: DeclinedTransaction.Source;
1313
- /**
1314
- * A constant representing the object's type. For this resource it will always be
1315
- * `declined_transaction`.
1316
- */
1317
- type: 'declined_transaction';
1318
- }
1319
- namespace DeclinedTransaction {
1320
- /**
1321
- * This is an object giving more details on the network-level event that caused the
1322
- * Declined Transaction. For example, for a card transaction this lists the
1323
- * merchant's industry and location. Note that for backwards compatibility reasons,
1324
- * additional undocumented keys may appear in this object. These should be treated
1325
- * as deprecated and will be removed in the future.
1326
- */
1327
- interface Source {
1328
- /**
1329
- * A ACH Decline object. This field will be present in the JSON response if and
1330
- * only if `category` is equal to `ach_decline`.
1331
- */
1332
- ach_decline: Source.ACHDecline | null;
1333
- /**
1334
- * A Card Decline object. This field will be present in the JSON response if and
1335
- * only if `category` is equal to `card_decline`.
1336
- */
1337
- card_decline: Source.CardDecline | null;
1338
- /**
1339
- * The type of decline that took place. We may add additional possible values for
1340
- * this enum over time; your application should be able to handle such additions
1341
- * gracefully.
1342
- */
1343
- category:
1344
- | 'ach_decline'
1345
- | 'card_decline'
1346
- | 'check_decline'
1347
- | 'inbound_real_time_payments_transfer_decline'
1348
- | 'international_ach_decline'
1349
- | 'wire_decline'
1350
- | 'other';
1351
- /**
1352
- * A Check Decline object. This field will be present in the JSON response if and
1353
- * only if `category` is equal to `check_decline`.
1354
- */
1355
- check_decline: Source.CheckDecline | null;
1356
1288
  /**
1357
- * A Inbound Real Time Payments Transfer Decline object. This field will be present
1358
- * in the JSON response if and only if `category` is equal to
1359
- * `inbound_real_time_payments_transfer_decline`.
1289
+ * A Fee Payment object. This field will be present in the JSON response if and
1290
+ * only if `category` is equal to `fee_payment`.
1360
1291
  */
1361
- inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
1292
+ interface FeePayment {
1293
+ /**
1294
+ * The amount in the minor unit of the transaction's currency. For dollars, for
1295
+ * example, this is cents.
1296
+ */
1297
+ amount: number;
1298
+ /**
1299
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
1300
+ * currency.
1301
+ */
1302
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1303
+ }
1362
1304
  /**
1363
- * A International ACH Decline object. This field will be present in the JSON
1364
- * response if and only if `category` is equal to `international_ach_decline`.
1305
+ * A Inbound ACH Transfer object. This field will be present in the JSON response
1306
+ * if and only if `category` is equal to `inbound_ach_transfer`.
1365
1307
  */
1366
- international_ach_decline: Source.InternationalACHDecline | null;
1308
+ interface InboundACHTransfer {
1309
+ /**
1310
+ * The amount in the minor unit of the destination account currency. For dollars,
1311
+ * for example, this is cents.
1312
+ */
1313
+ amount: number;
1314
+ originator_company_descriptive_date: string | null;
1315
+ originator_company_discretionary_data: string | null;
1316
+ originator_company_entry_description: string;
1317
+ originator_company_id: string;
1318
+ originator_company_name: string;
1319
+ receiver_id_number: string | null;
1320
+ receiver_name: string | null;
1321
+ trace_number: string;
1322
+ }
1367
1323
  /**
1368
- * A Wire Decline object. This field will be present in the JSON response if and
1369
- * only if `category` is equal to `wire_decline`.
1324
+ * A Inbound Check object. This field will be present in the JSON response if and
1325
+ * only if `category` is equal to `inbound_check`.
1370
1326
  */
1371
- wire_decline: Source.WireDecline | null;
1372
- }
1373
- namespace Source {
1327
+ interface InboundCheck {
1328
+ /**
1329
+ * The amount in the minor unit of the destination account currency. For dollars,
1330
+ * for example, this is cents.
1331
+ */
1332
+ amount: number;
1333
+ check_front_image_file_id: string | null;
1334
+ check_number: string | null;
1335
+ check_rear_image_file_id: string | null;
1336
+ /**
1337
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1338
+ * transaction's currency.
1339
+ */
1340
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1341
+ }
1374
1342
  /**
1375
- * A ACH Decline object. This field will be present in the JSON response if and
1376
- * only if `category` is equal to `ach_decline`.
1343
+ * A Inbound International ACH Transfer object. This field will be present in the
1344
+ * JSON response if and only if `category` is equal to
1345
+ * `inbound_international_ach_transfer`.
1377
1346
  */
1378
- interface ACHDecline {
1347
+ interface InboundInternationalACHTransfer {
1379
1348
  /**
1380
- * The declined amount in the minor unit of the destination account currency. For
1381
- * dollars, for example, this is cents.
1349
+ * The amount in the minor unit of the destination account currency. For dollars,
1350
+ * for example, this is cents.
1382
1351
  */
1383
1352
  amount: number;
1384
- originator_company_descriptive_date: string | null;
1385
- originator_company_discretionary_data: string | null;
1386
- originator_company_id: string;
1387
- originator_company_name: string;
1388
- /**
1389
- * Why the ACH transfer was declined.
1390
- */
1391
- reason:
1392
- | 'ach_route_canceled'
1393
- | 'ach_route_disabled'
1394
- | 'breaches_limit'
1395
- | 'credit_entry_refused_by_receiver'
1396
- | 'duplicate_return'
1397
- | 'entity_not_active'
1398
- | 'group_locked'
1399
- | 'insufficient_funds'
1400
- | 'misrouted_return'
1401
- | 'no_ach_route'
1402
- | 'originator_request'
1403
- | 'transaction_not_allowed';
1404
- receiver_id_number: string | null;
1405
- receiver_name: string | null;
1353
+ destination_country_code: string;
1354
+ destination_currency_code: string;
1355
+ foreign_exchange_indicator: string;
1356
+ foreign_exchange_reference: string | null;
1357
+ foreign_exchange_reference_indicator: string;
1358
+ foreign_payment_amount: number;
1359
+ foreign_trace_number: string | null;
1360
+ international_transaction_type_code: string;
1361
+ originating_currency_code: string;
1362
+ originating_depository_financial_institution_branch_country: string;
1363
+ originating_depository_financial_institution_id: string;
1364
+ originating_depository_financial_institution_id_qualifier: string;
1365
+ originating_depository_financial_institution_name: string;
1366
+ originator_city: string;
1367
+ originator_company_entry_description: string;
1368
+ originator_country: string;
1369
+ originator_identification: string;
1370
+ originator_name: string;
1371
+ originator_postal_code: string | null;
1372
+ originator_state_or_province: string | null;
1373
+ originator_street_address: string;
1374
+ payment_related_information: string | null;
1375
+ payment_related_information2: string | null;
1376
+ receiver_city: string;
1377
+ receiver_country: string;
1378
+ receiver_identification_number: string | null;
1379
+ receiver_postal_code: string | null;
1380
+ receiver_state_or_province: string | null;
1381
+ receiver_street_address: string;
1382
+ receiving_company_or_individual_name: string;
1383
+ receiving_depository_financial_institution_country: string;
1384
+ receiving_depository_financial_institution_id: string;
1385
+ receiving_depository_financial_institution_id_qualifier: string;
1386
+ receiving_depository_financial_institution_name: string;
1406
1387
  trace_number: string;
1407
1388
  }
1408
1389
  /**
1409
- * A Card Decline object. This field will be present in the JSON response if and
1410
- * only if `category` is equal to `card_decline`.
1390
+ * A Inbound Real Time Payments Transfer Confirmation object. This field will be
1391
+ * present in the JSON response if and only if `category` is equal to
1392
+ * `inbound_real_time_payments_transfer_confirmation`.
1411
1393
  */
1412
- interface CardDecline {
1394
+ interface InboundRealTimePaymentsTransferConfirmation {
1413
1395
  /**
1414
- * The declined amount in the minor unit of the destination account currency. For
1415
- * dollars, for example, this is cents.
1396
+ * The amount in the minor unit of the transfer's currency. For dollars, for
1397
+ * example, this is cents.
1416
1398
  */
1417
1399
  amount: number;
1418
1400
  /**
1419
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
1420
- * account currency.
1401
+ * The name the sender of the transfer specified as the recipient of the transfer.
1402
+ */
1403
+ creditor_name: string;
1404
+ /**
1405
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
1406
+ * currency. This will always be "USD" for a Real Time Payments transfer.
1421
1407
  */
1422
1408
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1423
1409
  /**
1424
- * If the authorization was attempted using a Digital Wallet Token (such as an
1425
- * Apple Pay purchase), the identifier of the token that was used.
1410
+ * The account number of the account that sent the transfer.
1426
1411
  */
1427
- digital_wallet_token_id: string | null;
1412
+ debtor_account_number: string;
1428
1413
  /**
1429
- * The merchant identifier (commonly abbreviated as MID) of the merchant the card
1430
- * is transacting with.
1414
+ * The name provided by the sender of the transfer.
1431
1415
  */
1432
- merchant_acceptor_id: string;
1416
+ debtor_name: string;
1433
1417
  /**
1434
- * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
1435
- * card is transacting with.
1418
+ * The routing number of the account that sent the transfer.
1436
1419
  */
1437
- merchant_category_code: string | null;
1420
+ debtor_routing_number: string;
1438
1421
  /**
1439
- * The city the merchant resides in.
1422
+ * Additional information included with the transfer.
1440
1423
  */
1441
- merchant_city: string | null;
1424
+ remittance_information: string | null;
1442
1425
  /**
1443
- * The country the merchant resides in.
1426
+ * The Real Time Payments network identification of the transfer
1444
1427
  */
1445
- merchant_country: string | null;
1428
+ transaction_identification: string;
1429
+ }
1430
+ /**
1431
+ * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
1432
+ * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
1433
+ */
1434
+ interface InboundWireDrawdownPayment {
1446
1435
  /**
1447
- * The merchant descriptor of the merchant the card is transacting with.
1436
+ * The amount in the minor unit of the transaction's currency. For dollars, for
1437
+ * example, this is cents.
1448
1438
  */
1449
- merchant_descriptor: string;
1439
+ amount: number;
1440
+ beneficiary_address_line1: string | null;
1441
+ beneficiary_address_line2: string | null;
1442
+ beneficiary_address_line3: string | null;
1443
+ beneficiary_name: string | null;
1444
+ beneficiary_reference: string | null;
1445
+ description: string;
1446
+ input_message_accountability_data: string | null;
1447
+ originator_address_line1: string | null;
1448
+ originator_address_line2: string | null;
1449
+ originator_address_line3: string | null;
1450
+ originator_name: string | null;
1451
+ originator_to_beneficiary_information: string | null;
1452
+ }
1453
+ /**
1454
+ * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
1455
+ * the JSON response if and only if `category` is equal to
1456
+ * `inbound_wire_drawdown_payment_reversal`.
1457
+ */
1458
+ interface InboundWireDrawdownPaymentReversal {
1450
1459
  /**
1451
- * The state the merchant resides in.
1460
+ * The amount that was reversed.
1452
1461
  */
1453
- merchant_state: string | null;
1462
+ amount: number;
1454
1463
  /**
1455
- * The payment network used to process this card authorization
1464
+ * The description on the reversal message from Fedwire.
1456
1465
  */
1457
- network: 'visa';
1466
+ description: string;
1458
1467
  /**
1459
- * Fields specific to the `network`
1468
+ * The Fedwire cycle date for the wire reversal.
1460
1469
  */
1461
- network_details: CardDecline.NetworkDetails;
1470
+ input_cycle_date: string;
1462
1471
  /**
1463
- * The identifier of the Real-Time Decision sent to approve or decline this
1464
- * transaction.
1472
+ * The Fedwire transaction identifier.
1465
1473
  */
1466
- real_time_decision_id: string | null;
1474
+ input_message_accountability_data: string;
1467
1475
  /**
1468
- * Why the transaction was declined.
1476
+ * The Fedwire sequence number.
1469
1477
  */
1470
- reason:
1471
- | 'card_not_active'
1472
- | 'entity_not_active'
1473
- | 'group_locked'
1474
- | 'insufficient_funds'
1475
- | 'cvv2_mismatch'
1476
- | 'transaction_not_allowed'
1477
- | 'breaches_internal_limit'
1478
- | 'breaches_limit'
1479
- | 'webhook_declined'
1480
- | 'webhook_timed_out'
1481
- | 'declined_by_stand_in_processing'
1482
- | 'invalid_physical_card'
1483
- | 'missing_original_authorization';
1484
- }
1485
- namespace CardDecline {
1478
+ input_sequence_number: string;
1486
1479
  /**
1487
- * Fields specific to the `network`
1480
+ * The Fedwire input source identifier.
1488
1481
  */
1489
- interface NetworkDetails {
1490
- /**
1491
- * Fields specific to the `visa` network
1492
- */
1493
- visa: NetworkDetails.Visa;
1494
- }
1495
- namespace NetworkDetails {
1496
- /**
1497
- * Fields specific to the `visa` network
1498
- */
1499
- interface Visa {
1500
- /**
1501
- * For electronic commerce transactions, this identifies the level of security used
1502
- * in obtaining the customer's payment credential. For mail or telephone order
1503
- * transactions, identifies the type of mail or telephone order.
1504
- */
1505
- electronic_commerce_indicator:
1506
- | 'mail_phone_order'
1507
- | 'recurring'
1508
- | 'installment'
1509
- | 'unknown_mail_phone_order'
1510
- | 'secure_electronic_commerce'
1511
- | 'non_authenticated_security_transaction_at_3ds_capable_merchant'
1512
- | 'non_authenticated_security_transaction'
1513
- | 'non_secure_transaction'
1514
- | null;
1515
- /**
1516
- * The method used to enter the cardholder's primary account number and card
1517
- * expiration date
1518
- */
1519
- point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
1520
- }
1521
- }
1522
- }
1523
- /**
1524
- * A Check Decline object. This field will be present in the JSON response if and
1525
- * only if `category` is equal to `check_decline`.
1526
- */
1527
- interface CheckDecline {
1482
+ input_source: string;
1528
1483
  /**
1529
- * The declined amount in the minor unit of the destination account currency. For
1530
- * dollars, for example, this is cents.
1484
+ * The Fedwire cycle date for the wire transfer that was reversed.
1531
1485
  */
1532
- amount: number;
1533
- auxiliary_on_us: string | null;
1486
+ previous_message_input_cycle_date: string;
1534
1487
  /**
1535
- * Why the check was declined.
1488
+ * The Fedwire transaction identifier for the wire transfer that was reversed.
1536
1489
  */
1537
- reason:
1538
- | 'ach_route_canceled'
1539
- | 'ach_route_disabled'
1540
- | 'breaches_limit'
1541
- | 'entity_not_active'
1542
- | 'group_locked'
1543
- | 'insufficient_funds'
1544
- | 'unable_to_locate_account'
1545
- | 'not_our_item'
1546
- | 'unable_to_process'
1547
- | 'refer_to_image'
1548
- | 'stop_payment_requested'
1549
- | 'returned'
1550
- | 'duplicate_presentment'
1551
- | 'not_authorized'
1552
- | 'altered_or_fictitious';
1490
+ previous_message_input_message_accountability_data: string;
1491
+ /**
1492
+ * The Fedwire sequence number for the wire transfer that was reversed.
1493
+ */
1494
+ previous_message_input_sequence_number: string;
1495
+ /**
1496
+ * The Fedwire input source identifier for the wire transfer that was reversed.
1497
+ */
1498
+ previous_message_input_source: string;
1553
1499
  }
1554
- /**
1555
- * A Inbound Real Time Payments Transfer Decline object. This field will be present
1556
- * in the JSON response if and only if `category` is equal to
1557
- * `inbound_real_time_payments_transfer_decline`.
1500
+ /**
1501
+ * A Inbound Wire Reversal object. This field will be present in the JSON response
1502
+ * if and only if `category` is equal to `inbound_wire_reversal`.
1558
1503
  */
1559
- interface InboundRealTimePaymentsTransferDecline {
1504
+ interface InboundWireReversal {
1560
1505
  /**
1561
- * The declined amount in the minor unit of the destination account currency. For
1562
- * dollars, for example, this is cents.
1506
+ * The amount that was reversed.
1563
1507
  */
1564
1508
  amount: number;
1565
1509
  /**
1566
- * The name the sender of the transfer specified as the recipient of the transfer.
1510
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1511
+ * the reversal was created.
1567
1512
  */
1568
- creditor_name: string;
1513
+ created_at: string;
1569
1514
  /**
1570
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
1571
- * transfer's currency. This will always be "USD" for a Real Time Payments
1572
- * transfer.
1515
+ * The description on the reversal message from Fedwire.
1573
1516
  */
1574
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1517
+ description: string;
1575
1518
  /**
1576
- * The account number of the account that sent the transfer.
1519
+ * Additional financial institution information included in the wire reversal.
1577
1520
  */
1578
- debtor_account_number: string;
1521
+ financial_institution_to_financial_institution_information: string | null;
1579
1522
  /**
1580
- * The name provided by the sender of the transfer.
1523
+ * The Fedwire cycle date for the wire reversal.
1581
1524
  */
1582
- debtor_name: string;
1525
+ input_cycle_date: string;
1583
1526
  /**
1584
- * The routing number of the account that sent the transfer.
1527
+ * The Fedwire transaction identifier.
1585
1528
  */
1586
- debtor_routing_number: string;
1529
+ input_message_accountability_data: string;
1587
1530
  /**
1588
- * Why the transfer was declined.
1531
+ * The Fedwire sequence number.
1589
1532
  */
1590
- reason:
1591
- | 'account_number_canceled'
1592
- | 'account_number_disabled'
1593
- | 'account_restricted'
1594
- | 'group_locked'
1595
- | 'entity_not_active'
1596
- | 'real_time_payments_not_enabled';
1533
+ input_sequence_number: string;
1597
1534
  /**
1598
- * Additional information included with the transfer.
1535
+ * The Fedwire input source identifier.
1599
1536
  */
1600
- remittance_information: string | null;
1537
+ input_source: string;
1601
1538
  /**
1602
- * The Real Time Payments network identification of the declined transfer.
1539
+ * The Fedwire cycle date for the wire transfer that was reversed.
1603
1540
  */
1604
- transaction_identification: string;
1605
- }
1606
- /**
1607
- * A International ACH Decline object. This field will be present in the JSON
1608
- * response if and only if `category` is equal to `international_ach_decline`.
1609
- */
1610
- interface InternationalACHDecline {
1541
+ previous_message_input_cycle_date: string;
1611
1542
  /**
1612
- * The declined amount in the minor unit of the destination account currency. For
1613
- * dollars, for example, this is cents.
1543
+ * The Fedwire transaction identifier for the wire transfer that was reversed.
1614
1544
  */
1615
- amount: number;
1616
- destination_country_code: string;
1617
- destination_currency_code: string;
1618
- foreign_exchange_indicator: string;
1619
- foreign_exchange_reference: string | null;
1620
- foreign_exchange_reference_indicator: string;
1621
- foreign_payment_amount: number;
1622
- foreign_trace_number: string | null;
1623
- international_transaction_type_code: string;
1624
- originating_currency_code: string;
1625
- originating_depository_financial_institution_branch_country: string;
1626
- originating_depository_financial_institution_id: string;
1627
- originating_depository_financial_institution_id_qualifier: string;
1628
- originating_depository_financial_institution_name: string;
1629
- originator_city: string;
1630
- originator_company_entry_description: string;
1631
- originator_country: string;
1632
- originator_identification: string;
1633
- originator_name: string;
1634
- originator_postal_code: string | null;
1635
- originator_state_or_province: string | null;
1636
- originator_street_address: string;
1637
- payment_related_information: string | null;
1638
- payment_related_information2: string | null;
1639
- receiver_city: string;
1640
- receiver_country: string;
1641
- receiver_identification_number: string | null;
1642
- receiver_postal_code: string | null;
1643
- receiver_state_or_province: string | null;
1644
- receiver_street_address: string;
1645
- receiving_company_or_individual_name: string;
1646
- receiving_depository_financial_institution_country: string;
1647
- receiving_depository_financial_institution_id: string;
1648
- receiving_depository_financial_institution_id_qualifier: string;
1649
- receiving_depository_financial_institution_name: string;
1650
- trace_number: string;
1545
+ previous_message_input_message_accountability_data: string;
1546
+ /**
1547
+ * The Fedwire sequence number for the wire transfer that was reversed.
1548
+ */
1549
+ previous_message_input_sequence_number: string;
1550
+ /**
1551
+ * The Fedwire input source identifier for the wire transfer that was reversed.
1552
+ */
1553
+ previous_message_input_source: string;
1554
+ /**
1555
+ * Information included in the wire reversal for the receiving financial
1556
+ * institution.
1557
+ */
1558
+ receiver_financial_institution_information: string | null;
1559
+ /**
1560
+ * The ID for the Transaction associated with the transfer reversal.
1561
+ */
1562
+ transaction_id: string | null;
1563
+ /**
1564
+ * The ID for the Wire Transfer that is being reversed.
1565
+ */
1566
+ wire_transfer_id: string;
1651
1567
  }
1652
1568
  /**
1653
- * A Wire Decline object. This field will be present in the JSON response if and
1654
- * only if `category` is equal to `wire_decline`.
1569
+ * A Inbound Wire Transfer object. This field will be present in the JSON response
1570
+ * if and only if `category` is equal to `inbound_wire_transfer`.
1655
1571
  */
1656
- interface WireDecline {
1572
+ interface InboundWireTransfer {
1657
1573
  /**
1658
- * The declined amount in the minor unit of the destination account currency. For
1659
- * dollars, for example, this is cents.
1574
+ * The amount in the minor unit of the transaction's currency. For dollars, for
1575
+ * example, this is cents.
1660
1576
  */
1661
1577
  amount: number;
1662
1578
  beneficiary_address_line1: string | null;
@@ -1670,20 +1586,135 @@ export declare namespace ACHTransferSimulation {
1670
1586
  originator_address_line2: string | null;
1671
1587
  originator_address_line3: string | null;
1672
1588
  originator_name: string | null;
1589
+ originator_to_beneficiary_information: string | null;
1673
1590
  originator_to_beneficiary_information_line1: string | null;
1674
1591
  originator_to_beneficiary_information_line2: string | null;
1675
1592
  originator_to_beneficiary_information_line3: string | null;
1676
1593
  originator_to_beneficiary_information_line4: string | null;
1594
+ }
1595
+ /**
1596
+ * A Interest Payment object. This field will be present in the JSON response if
1597
+ * and only if `category` is equal to `interest_payment`.
1598
+ */
1599
+ interface InterestPayment {
1677
1600
  /**
1678
- * Why the wire transfer was declined.
1601
+ * The account on which the interest was accrued.
1602
+ */
1603
+ accrued_on_account_id: string | null;
1604
+ /**
1605
+ * The amount in the minor unit of the transaction's currency. For dollars, for
1606
+ * example, this is cents.
1607
+ */
1608
+ amount: number;
1609
+ /**
1610
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
1611
+ * currency.
1612
+ */
1613
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1614
+ /**
1615
+ * The end of the period for which this transaction paid interest.
1616
+ */
1617
+ period_end: string;
1618
+ /**
1619
+ * The start of the period for which this transaction paid interest.
1620
+ */
1621
+ period_start: string;
1622
+ }
1623
+ /**
1624
+ * A Internal Source object. This field will be present in the JSON response if and
1625
+ * only if `category` is equal to `internal_source`.
1626
+ */
1627
+ interface InternalSource {
1628
+ /**
1629
+ * The amount in the minor unit of the transaction's currency. For dollars, for
1630
+ * example, this is cents.
1631
+ */
1632
+ amount: number;
1633
+ /**
1634
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
1635
+ * currency.
1679
1636
  */
1637
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1680
1638
  reason:
1681
- | 'account_number_canceled'
1682
- | 'account_number_disabled'
1683
- | 'entity_not_active'
1684
- | 'group_locked'
1685
- | 'no_account_number'
1686
- | 'transaction_not_allowed';
1639
+ | 'account_closure'
1640
+ | 'bank_migration'
1641
+ | 'cashback'
1642
+ | 'collection_receivable'
1643
+ | 'empyreal_adjustment'
1644
+ | 'error'
1645
+ | 'error_correction'
1646
+ | 'fees'
1647
+ | 'interest'
1648
+ | 'negative_balance_forgiveness'
1649
+ | 'sample_funds'
1650
+ | 'sample_funds_return';
1651
+ }
1652
+ /**
1653
+ * A Real Time Payments Transfer Acknowledgement object. This field will be present
1654
+ * in the JSON response if and only if `category` is equal to
1655
+ * `real_time_payments_transfer_acknowledgement`.
1656
+ */
1657
+ interface RealTimePaymentsTransferAcknowledgement {
1658
+ /**
1659
+ * The transfer amount in USD cents.
1660
+ */
1661
+ amount: number;
1662
+ /**
1663
+ * The destination account number.
1664
+ */
1665
+ destination_account_number: string;
1666
+ /**
1667
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN).
1668
+ */
1669
+ destination_routing_number: string;
1670
+ /**
1671
+ * Unstructured information that will show on the recipient's bank statement.
1672
+ */
1673
+ remittance_information: string;
1674
+ /**
1675
+ * The identifier of the Real Time Payments Transfer that led to this Transaction.
1676
+ */
1677
+ transfer_id: string;
1678
+ }
1679
+ /**
1680
+ * A Sample Funds object. This field will be present in the JSON response if and
1681
+ * only if `category` is equal to `sample_funds`.
1682
+ */
1683
+ interface SampleFunds {
1684
+ /**
1685
+ * Where the sample funds came from.
1686
+ */
1687
+ originator: string;
1688
+ }
1689
+ /**
1690
+ * A Wire Transfer Intention object. This field will be present in the JSON
1691
+ * response if and only if `category` is equal to `wire_transfer_intention`.
1692
+ */
1693
+ interface WireTransferIntention {
1694
+ /**
1695
+ * The destination account number.
1696
+ */
1697
+ account_number: string;
1698
+ /**
1699
+ * The transfer amount in USD cents.
1700
+ */
1701
+ amount: number;
1702
+ /**
1703
+ * The message that will show on the recipient's bank statement.
1704
+ */
1705
+ message_to_recipient: string;
1706
+ /**
1707
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN).
1708
+ */
1709
+ routing_number: string;
1710
+ transfer_id: string;
1711
+ }
1712
+ /**
1713
+ * A Wire Transfer Rejection object. This field will be present in the JSON
1714
+ * response if and only if `category` is equal to `wire_transfer_rejection`.
1715
+ */
1716
+ interface WireTransferRejection {
1717
+ transfer_id: string;
1687
1718
  }
1688
1719
  }
1689
1720
  }
@@ -1747,7 +1778,6 @@ export interface ACHTransferReturnParams {
1747
1778
  | 'returned_per_odfi_request'
1748
1779
  | 'limited_participation_dfi'
1749
1780
  | 'incorrectly_coded_outbound_international_payment'
1750
- | 'other'
1751
1781
  | 'account_sold_to_another_dfi'
1752
1782
  | 'addenda_error'
1753
1783
  | 'beneficiary_or_account_holder_deceased'
@@ -1798,4 +1828,9 @@ export interface ACHTransferReturnParams {
1798
1828
  | 'untimely_dishonored_return'
1799
1829
  | 'untimely_return';
1800
1830
  }
1831
+ export declare namespace ACHTransfers {
1832
+ export import ACHTransferSimulation = API.ACHTransferSimulation;
1833
+ export import ACHTransferCreateInboundParams = API.ACHTransferCreateInboundParams;
1834
+ export import ACHTransferReturnParams = API.ACHTransferReturnParams;
1835
+ }
1801
1836
  //# sourceMappingURL=ach-transfers.d.ts.map