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