increase 0.5.0 → 0.7.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 (1286) hide show
  1. package/CHANGELOG.md +80 -0
  2. package/README.md +11 -6
  3. package/_shims/agent.d.ts +9 -0
  4. package/_shims/agent.d.ts.map +1 -0
  5. package/_shims/agent.js.map +1 -0
  6. package/_shims/agent.mjs +10 -0
  7. package/_shims/agent.mjs.map +1 -0
  8. package/_shims/agent.node.d.ts +7 -0
  9. package/_shims/agent.node.d.ts.map +1 -0
  10. package/_shims/agent.node.js.map +1 -0
  11. package/_shims/agent.node.mjs +16 -0
  12. package/_shims/agent.node.mjs.map +1 -0
  13. package/_shims/fetch.d.ts +52 -0
  14. package/_shims/fetch.js +13 -0
  15. package/_shims/fetch.mjs +15 -0
  16. package/_shims/fetch.node.d.ts +53 -0
  17. package/_shims/fetch.node.js +12 -0
  18. package/_shims/fetch.node.mjs +14 -0
  19. package/_shims/fileFromPath.d.ts +22 -0
  20. package/_shims/fileFromPath.d.ts.map +1 -0
  21. package/_shims/fileFromPath.js +16 -0
  22. package/_shims/fileFromPath.js.map +1 -0
  23. package/_shims/fileFromPath.mjs +12 -0
  24. package/_shims/fileFromPath.mjs.map +1 -0
  25. package/_shims/fileFromPath.node.d.ts +17 -0
  26. package/_shims/fileFromPath.node.d.ts.map +1 -0
  27. package/_shims/fileFromPath.node.js +17 -0
  28. package/_shims/fileFromPath.node.js.map +1 -0
  29. package/_shims/fileFromPath.node.mjs +13 -0
  30. package/_shims/fileFromPath.node.mjs.map +1 -0
  31. package/_shims/formdata.d.ts +43 -0
  32. package/_shims/formdata.js +9 -0
  33. package/_shims/formdata.mjs +11 -0
  34. package/_shims/formdata.node.d.ts +44 -0
  35. package/_shims/formdata.node.js +11 -0
  36. package/_shims/getMultipartRequestOptions.d.ts.map +1 -0
  37. package/_shims/getMultipartRequestOptions.js +12 -0
  38. package/_shims/getMultipartRequestOptions.js.map +1 -0
  39. package/_shims/getMultipartRequestOptions.mjs +8 -0
  40. package/_shims/getMultipartRequestOptions.mjs.map +1 -0
  41. package/_shims/getMultipartRequestOptions.node.d.ts.map +1 -0
  42. package/_shims/getMultipartRequestOptions.node.js +22 -0
  43. package/_shims/getMultipartRequestOptions.node.js.map +1 -0
  44. package/_shims/getMultipartRequestOptions.node.mjs +18 -0
  45. package/_shims/getMultipartRequestOptions.node.mjs.map +1 -0
  46. package/_shims/node-readable.d.ts +23 -0
  47. package/_shims/node-readable.d.ts.map +1 -0
  48. package/_shims/node-readable.js +11 -0
  49. package/_shims/node-readable.js.map +1 -0
  50. package/_shims/node-readable.mjs +7 -0
  51. package/_shims/node-readable.mjs.map +1 -0
  52. package/_shims/node-readable.node.d.ts +8 -0
  53. package/_shims/node-readable.node.d.ts.map +1 -0
  54. package/_shims/node-readable.node.js +9 -0
  55. package/_shims/node-readable.node.js.map +1 -0
  56. package/_shims/node-readable.node.mjs +5 -0
  57. package/_shims/node-readable.node.mjs.map +1 -0
  58. package/core.d.ts +230 -0
  59. package/core.d.ts.map +1 -0
  60. package/core.js +717 -0
  61. package/core.js.map +1 -0
  62. package/core.mjs +621 -0
  63. package/core.mjs.map +1 -0
  64. package/error.d.ts +225 -0
  65. package/error.d.ts.map +1 -0
  66. package/error.js +350 -0
  67. package/error.js.map +1 -0
  68. package/error.mjs +297 -0
  69. package/error.mjs.map +1 -0
  70. package/index.d.mts +355 -0
  71. package/index.d.ts +355 -0
  72. package/index.d.ts.map +1 -0
  73. package/index.js +292 -0
  74. package/index.js.map +1 -0
  75. package/index.mjs +221 -0
  76. package/index.mjs.map +1 -0
  77. package/package.json +34 -77
  78. package/pagination.d.ts.map +1 -0
  79. package/pagination.js +30 -0
  80. package/pagination.js.map +1 -0
  81. package/pagination.mjs +26 -0
  82. package/pagination.mjs.map +1 -0
  83. package/resource.d.ts.map +1 -0
  84. package/resource.js.map +1 -0
  85. package/resource.mjs +13 -0
  86. package/resource.mjs.map +1 -0
  87. package/resources/account-numbers.d.ts +151 -0
  88. package/resources/account-numbers.d.ts.map +1 -0
  89. package/resources/account-numbers.js +38 -0
  90. package/resources/account-numbers.js.map +1 -0
  91. package/resources/account-numbers.mjs +33 -0
  92. package/resources/account-numbers.mjs.map +1 -0
  93. package/resources/account-statements.d.ts +108 -0
  94. package/resources/account-statements.d.ts.map +1 -0
  95. package/resources/account-statements.js +28 -0
  96. package/resources/account-statements.js.map +1 -0
  97. package/resources/account-statements.mjs +21 -0
  98. package/resources/account-statements.mjs.map +1 -0
  99. package/resources/account-transfers.d.ts +232 -0
  100. package/resources/account-transfers.d.ts.map +1 -0
  101. package/resources/account-transfers.js +46 -0
  102. package/resources/account-transfers.js.map +1 -0
  103. package/resources/account-transfers.mjs +39 -0
  104. package/resources/account-transfers.mjs.map +1 -0
  105. package/resources/accounts.d.ts +178 -0
  106. package/resources/accounts.d.ts.map +1 -0
  107. package/resources/accounts.js +44 -0
  108. package/resources/accounts.js.map +1 -0
  109. package/resources/accounts.mjs +39 -0
  110. package/resources/accounts.mjs.map +1 -0
  111. package/resources/ach-prenotifications.d.ts +216 -0
  112. package/resources/ach-prenotifications.d.ts.map +1 -0
  113. package/resources/ach-prenotifications.js +34 -0
  114. package/resources/ach-prenotifications.js.map +1 -0
  115. package/resources/ach-prenotifications.mjs +27 -0
  116. package/resources/ach-prenotifications.mjs.map +1 -0
  117. package/resources/ach-transfers.d.ts +681 -0
  118. package/resources/ach-transfers.d.ts.map +1 -0
  119. package/resources/ach-transfers.js +44 -0
  120. package/resources/ach-transfers.js.map +1 -0
  121. package/resources/ach-transfers.mjs +39 -0
  122. package/resources/ach-transfers.mjs.map +1 -0
  123. package/resources/balance-lookups.d.ts +52 -0
  124. package/resources/balance-lookups.d.ts.map +1 -0
  125. package/resources/balance-lookups.js +16 -0
  126. package/resources/balance-lookups.js.map +1 -0
  127. package/resources/balance-lookups.mjs +12 -0
  128. package/resources/balance-lookups.mjs.map +1 -0
  129. package/resources/bookkeeping-accounts.d.ts +86 -0
  130. package/resources/bookkeeping-accounts.d.ts.map +1 -0
  131. package/resources/bookkeeping-accounts.js +28 -0
  132. package/resources/bookkeeping-accounts.js.map +1 -0
  133. package/resources/bookkeeping-accounts.mjs +21 -0
  134. package/resources/bookkeeping-accounts.mjs.map +1 -0
  135. package/resources/bookkeeping-entries.d.ts +51 -0
  136. package/resources/bookkeeping-entries.d.ts.map +1 -0
  137. package/resources/bookkeeping-entries.js +22 -0
  138. package/resources/bookkeeping-entries.js.map +1 -0
  139. package/resources/bookkeeping-entries.mjs +15 -0
  140. package/resources/bookkeeping-entries.mjs.map +1 -0
  141. package/resources/bookkeeping-entry-sets.d.ts +88 -0
  142. package/resources/bookkeeping-entry-sets.d.ts.map +1 -0
  143. package/resources/bookkeeping-entry-sets.js +18 -0
  144. package/resources/bookkeeping-entry-sets.js.map +1 -0
  145. package/resources/bookkeeping-entry-sets.mjs +12 -0
  146. package/resources/bookkeeping-entry-sets.mjs.map +1 -0
  147. package/resources/card-disputes.d.ts +167 -0
  148. package/resources/card-disputes.d.ts.map +1 -0
  149. package/resources/card-disputes.js +32 -0
  150. package/resources/card-disputes.js.map +1 -0
  151. package/resources/card-disputes.mjs +27 -0
  152. package/resources/card-disputes.mjs.map +1 -0
  153. package/resources/card-profiles.d.ts +260 -0
  154. package/resources/card-profiles.d.ts.map +1 -0
  155. package/resources/card-profiles.js +32 -0
  156. package/resources/card-profiles.js.map +1 -0
  157. package/resources/card-profiles.mjs +27 -0
  158. package/resources/card-profiles.mjs.map +1 -0
  159. package/resources/cards.d.ts +364 -0
  160. package/resources/cards.d.ts.map +1 -0
  161. package/resources/cards.js +44 -0
  162. package/resources/cards.js.map +1 -0
  163. package/resources/cards.mjs +39 -0
  164. package/resources/cards.mjs.map +1 -0
  165. package/resources/check-deposits.d.ts +324 -0
  166. package/resources/check-deposits.d.ts.map +1 -0
  167. package/resources/check-deposits.js +32 -0
  168. package/resources/check-deposits.js.map +1 -0
  169. package/resources/check-deposits.mjs +27 -0
  170. package/resources/check-deposits.mjs.map +1 -0
  171. package/resources/check-transfers.d.ts +468 -0
  172. package/resources/check-transfers.d.ts.map +1 -0
  173. package/resources/check-transfers.js +50 -0
  174. package/resources/check-transfers.js.map +1 -0
  175. package/resources/check-transfers.mjs +45 -0
  176. package/resources/check-transfers.mjs.map +1 -0
  177. package/resources/declined-transactions.d.ts +633 -0
  178. package/resources/declined-transactions.d.ts.map +1 -0
  179. package/resources/declined-transactions.js +28 -0
  180. package/resources/declined-transactions.js.map +1 -0
  181. package/resources/declined-transactions.mjs +21 -0
  182. package/resources/declined-transactions.mjs.map +1 -0
  183. package/resources/digital-wallet-tokens.d.ts +103 -0
  184. package/resources/digital-wallet-tokens.d.ts.map +1 -0
  185. package/resources/digital-wallet-tokens.js +28 -0
  186. package/resources/digital-wallet-tokens.js.map +1 -0
  187. package/resources/digital-wallet-tokens.mjs +21 -0
  188. package/resources/digital-wallet-tokens.mjs.map +1 -0
  189. package/resources/documents.d.ts +103 -0
  190. package/resources/documents.d.ts.map +1 -0
  191. package/resources/documents.js +26 -0
  192. package/resources/documents.js.map +1 -0
  193. package/resources/documents.mjs +21 -0
  194. package/resources/documents.mjs.map +1 -0
  195. package/resources/entities/entities.d.ts +1779 -0
  196. package/resources/entities/entities.d.ts.map +1 -0
  197. package/resources/entities/entities.js +81 -0
  198. package/resources/entities/entities.js.map +1 -0
  199. package/resources/entities/entities.mjs +36 -0
  200. package/resources/entities/entities.mjs.map +1 -0
  201. package/resources/entities/index.d.ts.map +1 -0
  202. package/resources/entities/index.js +35 -0
  203. package/resources/entities/index.js.map +1 -0
  204. package/resources/entities/index.mjs +4 -0
  205. package/resources/entities/index.mjs.map +1 -0
  206. package/resources/entities/supplemental-documents.d.ts +64 -0
  207. package/resources/entities/supplemental-documents.d.ts.map +1 -0
  208. package/resources/entities/supplemental-documents.js +30 -0
  209. package/resources/entities/supplemental-documents.js.map +1 -0
  210. package/resources/entities/supplemental-documents.mjs +23 -0
  211. package/resources/entities/supplemental-documents.mjs.map +1 -0
  212. package/resources/event-subscriptions.d.ts +373 -0
  213. package/resources/event-subscriptions.d.ts.map +1 -0
  214. package/resources/event-subscriptions.js +40 -0
  215. package/resources/event-subscriptions.js.map +1 -0
  216. package/resources/event-subscriptions.mjs +33 -0
  217. package/resources/event-subscriptions.mjs.map +1 -0
  218. package/resources/events.d.ts +271 -0
  219. package/resources/events.d.ts.map +1 -0
  220. package/resources/events.js +26 -0
  221. package/resources/events.js.map +1 -0
  222. package/resources/events.mjs +21 -0
  223. package/resources/events.mjs.map +1 -0
  224. package/resources/exports.d.ts +182 -0
  225. package/resources/exports.d.ts.map +1 -0
  226. package/resources/exports.js +32 -0
  227. package/resources/exports.js.map +1 -0
  228. package/resources/exports.mjs +27 -0
  229. package/resources/exports.mjs.map +1 -0
  230. package/resources/external-accounts.d.ts +153 -0
  231. package/resources/external-accounts.d.ts.map +1 -0
  232. package/resources/external-accounts.js +40 -0
  233. package/resources/external-accounts.js.map +1 -0
  234. package/resources/external-accounts.mjs +33 -0
  235. package/resources/external-accounts.mjs.map +1 -0
  236. package/resources/files.d.ts +218 -0
  237. package/resources/files.d.ts.map +1 -0
  238. package/resources/files.js +35 -0
  239. package/resources/files.js.map +1 -0
  240. package/resources/files.mjs +30 -0
  241. package/resources/files.mjs.map +1 -0
  242. package/resources/groups.d.ts +48 -0
  243. package/resources/groups.d.ts.map +1 -0
  244. package/resources/groups.js +16 -0
  245. package/resources/groups.js.map +1 -0
  246. package/resources/groups.mjs +12 -0
  247. package/resources/groups.mjs.map +1 -0
  248. package/resources/inbound-ach-transfer-returns.d.ts +159 -0
  249. package/resources/inbound-ach-transfer-returns.d.ts.map +1 -0
  250. package/resources/inbound-ach-transfer-returns.js +37 -0
  251. package/resources/inbound-ach-transfer-returns.js.map +1 -0
  252. package/resources/inbound-ach-transfer-returns.mjs +30 -0
  253. package/resources/inbound-ach-transfer-returns.mjs.map +1 -0
  254. package/resources/inbound-wire-drawdown-requests.d.ts +133 -0
  255. package/resources/inbound-wire-drawdown-requests.d.ts.map +1 -0
  256. package/resources/inbound-wire-drawdown-requests.js +32 -0
  257. package/resources/inbound-wire-drawdown-requests.js.map +1 -0
  258. package/resources/inbound-wire-drawdown-requests.mjs +26 -0
  259. package/resources/inbound-wire-drawdown-requests.mjs.map +1 -0
  260. package/resources/index.d.ts +200 -0
  261. package/resources/index.d.ts.map +1 -0
  262. package/resources/index.js +569 -0
  263. package/resources/index.js.map +1 -0
  264. package/resources/index.mjs +44 -0
  265. package/resources/index.mjs.map +1 -0
  266. package/resources/limits.d.ts +152 -0
  267. package/resources/limits.d.ts.map +1 -0
  268. package/resources/limits.js +38 -0
  269. package/resources/limits.js.map +1 -0
  270. package/resources/limits.mjs +33 -0
  271. package/resources/limits.mjs.map +1 -0
  272. package/resources/oauth-connections.d.ts +62 -0
  273. package/resources/oauth-connections.d.ts.map +1 -0
  274. package/resources/oauth-connections.js +28 -0
  275. package/resources/oauth-connections.js.map +1 -0
  276. package/resources/oauth-connections.mjs +21 -0
  277. package/resources/oauth-connections.mjs.map +1 -0
  278. package/resources/pending-transactions.d.ts +599 -0
  279. package/resources/pending-transactions.d.ts.map +1 -0
  280. package/resources/pending-transactions.js +28 -0
  281. package/resources/pending-transactions.js.map +1 -0
  282. package/resources/pending-transactions.mjs +21 -0
  283. package/resources/pending-transactions.mjs.map +1 -0
  284. package/resources/programs.d.ts +56 -0
  285. package/resources/programs.d.ts.map +1 -0
  286. package/resources/programs.js +26 -0
  287. package/resources/programs.js.map +1 -0
  288. package/resources/programs.mjs +21 -0
  289. package/resources/programs.mjs.map +1 -0
  290. package/resources/real-time-decisions.d.ts +400 -0
  291. package/resources/real-time-decisions.d.ts.map +1 -0
  292. package/resources/real-time-decisions.js +24 -0
  293. package/resources/real-time-decisions.js.map +1 -0
  294. package/resources/real-time-decisions.mjs +18 -0
  295. package/resources/real-time-decisions.mjs.map +1 -0
  296. package/resources/real-time-payments-transfers.d.ts +377 -0
  297. package/resources/real-time-payments-transfers.d.ts.map +1 -0
  298. package/resources/real-time-payments-transfers.js +37 -0
  299. package/resources/real-time-payments-transfers.js.map +1 -0
  300. package/resources/real-time-payments-transfers.mjs +30 -0
  301. package/resources/real-time-payments-transfers.mjs.map +1 -0
  302. package/resources/routing-numbers.d.ts +67 -0
  303. package/resources/routing-numbers.d.ts.map +1 -0
  304. package/resources/routing-numbers.js +22 -0
  305. package/resources/routing-numbers.js.map +1 -0
  306. package/resources/routing-numbers.mjs +17 -0
  307. package/resources/routing-numbers.mjs.map +1 -0
  308. package/resources/shared.d.ts +29 -0
  309. package/resources/shared.d.ts.map +1 -0
  310. package/resources/shared.js.map +1 -0
  311. package/resources/shared.mjs +3 -0
  312. package/resources/shared.mjs.map +1 -0
  313. package/resources/simulations/account-statements.d.ts +24 -0
  314. package/resources/simulations/account-statements.d.ts.map +1 -0
  315. package/resources/simulations/account-statements.js +19 -0
  316. package/resources/simulations/account-statements.js.map +1 -0
  317. package/resources/simulations/account-statements.mjs +13 -0
  318. package/resources/simulations/account-statements.mjs.map +1 -0
  319. package/resources/simulations/account-transfers.d.ts +16 -0
  320. package/resources/simulations/account-transfers.d.ts.map +1 -0
  321. package/resources/simulations/account-transfers.js +18 -0
  322. package/resources/simulations/account-transfers.js.map +1 -0
  323. package/resources/simulations/account-transfers.mjs +14 -0
  324. package/resources/simulations/account-transfers.mjs.map +1 -0
  325. package/resources/simulations/ach-transfers.d.ts +2439 -0
  326. package/resources/simulations/ach-transfers.d.ts.map +1 -0
  327. package/resources/simulations/ach-transfers.js +40 -0
  328. package/resources/simulations/ach-transfers.js.map +1 -0
  329. package/resources/simulations/ach-transfers.mjs +36 -0
  330. package/resources/simulations/ach-transfers.mjs.map +1 -0
  331. package/resources/simulations/card-disputes.d.ts +35 -0
  332. package/resources/simulations/card-disputes.d.ts.map +1 -0
  333. package/resources/simulations/card-disputes.js +19 -0
  334. package/resources/simulations/card-disputes.js.map +1 -0
  335. package/resources/simulations/card-disputes.mjs +15 -0
  336. package/resources/simulations/card-disputes.mjs.map +1 -0
  337. package/resources/simulations/card-profiles.d.ts +17 -0
  338. package/resources/simulations/card-profiles.d.ts.map +1 -0
  339. package/resources/simulations/card-profiles.js +19 -0
  340. package/resources/simulations/card-profiles.js.map +1 -0
  341. package/resources/simulations/card-profiles.mjs +15 -0
  342. package/resources/simulations/card-profiles.mjs.map +1 -0
  343. package/resources/simulations/card-refunds.d.ts +25 -0
  344. package/resources/simulations/card-refunds.d.ts.map +1 -0
  345. package/resources/simulations/card-refunds.js +17 -0
  346. package/resources/simulations/card-refunds.js.map +1 -0
  347. package/resources/simulations/card-refunds.mjs +13 -0
  348. package/resources/simulations/card-refunds.mjs.map +1 -0
  349. package/resources/simulations/cards.d.ts +1185 -0
  350. package/resources/simulations/cards.d.ts.map +1 -0
  351. package/resources/simulations/cards.js +32 -0
  352. package/resources/simulations/cards.js.map +1 -0
  353. package/resources/simulations/cards.mjs +28 -0
  354. package/resources/simulations/cards.mjs.map +1 -0
  355. package/resources/simulations/check-deposits.d.ts +31 -0
  356. package/resources/simulations/check-deposits.d.ts.map +1 -0
  357. package/resources/simulations/check-deposits.js +31 -0
  358. package/resources/simulations/check-deposits.js.map +1 -0
  359. package/resources/simulations/check-deposits.mjs +27 -0
  360. package/resources/simulations/check-deposits.mjs.map +1 -0
  361. package/resources/simulations/check-transfers.d.ts +23 -0
  362. package/resources/simulations/check-transfers.d.ts.map +1 -0
  363. package/resources/simulations/check-transfers.js +24 -0
  364. package/resources/simulations/check-transfers.js.map +1 -0
  365. package/resources/simulations/check-transfers.mjs +20 -0
  366. package/resources/simulations/check-transfers.mjs.map +1 -0
  367. package/resources/simulations/digital-wallet-token-requests.d.ts +56 -0
  368. package/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -0
  369. package/resources/simulations/digital-wallet-token-requests.js +20 -0
  370. package/resources/simulations/digital-wallet-token-requests.js.map +1 -0
  371. package/resources/simulations/digital-wallet-token-requests.mjs +13 -0
  372. package/resources/simulations/digital-wallet-token-requests.mjs.map +1 -0
  373. package/resources/simulations/documents.d.ts +23 -0
  374. package/resources/simulations/documents.d.ts.map +1 -0
  375. package/resources/simulations/documents.js +16 -0
  376. package/resources/simulations/documents.js.map +1 -0
  377. package/resources/simulations/documents.mjs +12 -0
  378. package/resources/simulations/documents.mjs.map +1 -0
  379. package/resources/simulations/inbound-funds-holds.d.ts +74 -0
  380. package/resources/simulations/inbound-funds-holds.d.ts.map +1 -0
  381. package/resources/simulations/inbound-funds-holds.js +19 -0
  382. package/resources/simulations/inbound-funds-holds.js.map +1 -0
  383. package/resources/simulations/inbound-funds-holds.mjs +13 -0
  384. package/resources/simulations/inbound-funds-holds.mjs.map +1 -0
  385. package/resources/simulations/inbound-wire-drawdown-requests.d.ts +106 -0
  386. package/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -0
  387. package/resources/simulations/inbound-wire-drawdown-requests.js +20 -0
  388. package/resources/simulations/inbound-wire-drawdown-requests.js.map +1 -0
  389. package/resources/simulations/inbound-wire-drawdown-requests.mjs +15 -0
  390. package/resources/simulations/inbound-wire-drawdown-requests.mjs.map +1 -0
  391. package/resources/simulations/index.d.ts +40 -0
  392. package/resources/simulations/index.d.ts.map +1 -0
  393. package/resources/simulations/index.js +149 -0
  394. package/resources/simulations/index.js.map +1 -0
  395. package/resources/simulations/index.mjs +20 -0
  396. package/resources/simulations/index.mjs.map +1 -0
  397. package/resources/simulations/interest-payments.d.ts +1591 -0
  398. package/resources/simulations/interest-payments.d.ts.map +1 -0
  399. package/resources/simulations/interest-payments.js +19 -0
  400. package/resources/simulations/interest-payments.js.map +1 -0
  401. package/resources/simulations/interest-payments.mjs +13 -0
  402. package/resources/simulations/interest-payments.mjs.map +1 -0
  403. package/resources/simulations/programs.d.ts +25 -0
  404. package/resources/simulations/programs.d.ts.map +1 -0
  405. package/resources/simulations/programs.js +18 -0
  406. package/resources/simulations/programs.js.map +1 -0
  407. package/resources/simulations/programs.mjs +14 -0
  408. package/resources/simulations/programs.mjs.map +1 -0
  409. package/resources/simulations/real-time-payments-transfers.d.ts +2289 -0
  410. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -0
  411. package/resources/simulations/real-time-payments-transfers.js +30 -0
  412. package/resources/simulations/real-time-payments-transfers.js.map +1 -0
  413. package/resources/simulations/real-time-payments-transfers.mjs +24 -0
  414. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -0
  415. package/resources/simulations/simulations.d.ts +80 -0
  416. package/resources/simulations/simulations.d.ts.map +1 -0
  417. package/resources/simulations/simulations.js +112 -0
  418. package/resources/simulations/simulations.js.map +1 -0
  419. package/resources/simulations/simulations.mjs +62 -0
  420. package/resources/simulations/simulations.mjs.map +1 -0
  421. package/resources/simulations/wire-transfers.d.ts +1657 -0
  422. package/resources/simulations/wire-transfers.d.ts.map +1 -0
  423. package/resources/simulations/wire-transfers.js +16 -0
  424. package/resources/simulations/wire-transfers.js.map +1 -0
  425. package/resources/simulations/wire-transfers.mjs +12 -0
  426. package/resources/simulations/wire-transfers.mjs.map +1 -0
  427. package/resources/transactions.d.ts +1646 -0
  428. package/resources/transactions.d.ts.map +1 -0
  429. package/resources/transactions.js +26 -0
  430. package/resources/transactions.js.map +1 -0
  431. package/resources/transactions.mjs +21 -0
  432. package/resources/transactions.mjs.map +1 -0
  433. package/resources/wire-drawdown-requests.d.ts +169 -0
  434. package/resources/wire-drawdown-requests.d.ts.map +1 -0
  435. package/resources/wire-drawdown-requests.js +34 -0
  436. package/resources/wire-drawdown-requests.js.map +1 -0
  437. package/resources/wire-drawdown-requests.mjs +27 -0
  438. package/resources/wire-drawdown-requests.mjs.map +1 -0
  439. package/resources/wire-transfers.d.ts +384 -0
  440. package/resources/wire-transfers.d.ts.map +1 -0
  441. package/resources/wire-transfers.js +61 -0
  442. package/resources/wire-transfers.js.map +1 -0
  443. package/resources/wire-transfers.mjs +56 -0
  444. package/resources/wire-transfers.mjs.map +1 -0
  445. package/src/_shims/agent.node.ts +22 -0
  446. package/src/_shims/agent.ts +12 -0
  447. package/src/_shims/fetch.d.ts +52 -0
  448. package/src/_shims/fetch.js +13 -0
  449. package/src/_shims/fetch.mjs +15 -0
  450. package/src/_shims/fetch.node.d.ts +53 -0
  451. package/src/_shims/fetch.node.js +12 -0
  452. package/src/_shims/fetch.node.mjs +14 -0
  453. package/src/_shims/fileFromPath.node.ts +29 -0
  454. package/src/_shims/fileFromPath.ts +29 -0
  455. package/src/_shims/formdata.d.ts +43 -0
  456. package/src/_shims/formdata.js +9 -0
  457. package/src/_shims/formdata.mjs +11 -0
  458. package/src/_shims/formdata.node.d.ts +44 -0
  459. package/src/_shims/formdata.node.js +11 -0
  460. package/src/_shims/formdata.node.mjs +9 -0
  461. package/src/_shims/getMultipartRequestOptions.node.ts +25 -0
  462. package/src/_shims/getMultipartRequestOptions.ts +14 -0
  463. package/src/_shims/node-readable.node.ts +10 -0
  464. package/src/_shims/node-readable.ts +30 -0
  465. package/src/core.ts +819 -0
  466. package/src/error.ts +545 -0
  467. package/src/index.ts +456 -0
  468. package/src/resources/account-numbers.ts +193 -0
  469. package/src/resources/account-statements.ts +140 -0
  470. package/src/resources/account-transfers.ts +290 -0
  471. package/src/resources/accounts.ts +228 -0
  472. package/src/resources/ach-prenotifications.ts +269 -0
  473. package/src/resources/ach-transfers.ts +776 -0
  474. package/src/resources/balance-lookups.ts +63 -0
  475. package/src/resources/bookkeeping-accounts.ts +114 -0
  476. package/src/resources/bookkeeping-entries.ts +71 -0
  477. package/src/resources/bookkeeping-entry-sets.ts +106 -0
  478. package/src/resources/card-disputes.ts +210 -0
  479. package/src/resources/card-profiles.ts +321 -0
  480. package/src/resources/cards.ts +445 -0
  481. package/src/resources/check-deposits.ts +385 -0
  482. package/src/resources/check-transfers.ts +573 -0
  483. package/src/resources/declined-transactions.ts +764 -0
  484. package/src/resources/digital-wallet-tokens.ts +132 -0
  485. package/src/resources/documents.ts +134 -0
  486. package/src/resources/entities/entities.ts +2080 -0
  487. package/src/resources/entities/supplemental-documents.ts +81 -0
  488. package/src/resources/event-subscriptions.ts +408 -0
  489. package/src/resources/events.ts +302 -0
  490. package/src/resources/exports.ts +225 -0
  491. package/src/resources/external-accounts.ts +193 -0
  492. package/src/resources/files.ts +256 -0
  493. package/src/resources/groups.ts +58 -0
  494. package/src/resources/inbound-ach-transfer-returns.ts +194 -0
  495. package/src/resources/inbound-wire-drawdown-requests.ts +176 -0
  496. package/src/resources/index.ts +194 -0
  497. package/src/resources/limits.ts +190 -0
  498. package/src/resources/oauth-connections.ts +85 -0
  499. package/src/resources/pending-transactions.ts +694 -0
  500. package/src/resources/programs.ts +79 -0
  501. package/src/resources/real-time-decisions.ts +456 -0
  502. package/src/resources/real-time-payments-transfers.ts +445 -0
  503. package/src/resources/routing-numbers.ts +80 -0
  504. package/src/resources/shared.ts +30 -0
  505. package/src/resources/simulations/account-statements.ts +30 -0
  506. package/src/resources/simulations/account-transfers.ts +20 -0
  507. package/src/resources/simulations/ach-transfers.ts +2826 -0
  508. package/src/resources/simulations/card-disputes.ts +42 -0
  509. package/src/resources/simulations/card-profiles.ts +21 -0
  510. package/src/resources/simulations/card-refunds.ts +31 -0
  511. package/src/resources/simulations/cards.ts +1378 -0
  512. package/src/resources/simulations/check-deposits.ts +41 -0
  513. package/src/resources/simulations/check-transfers.ts +30 -0
  514. package/src/resources/simulations/digital-wallet-token-requests.ts +65 -0
  515. package/src/resources/simulations/documents.ts +29 -0
  516. package/src/resources/simulations/inbound-funds-holds.ts +88 -0
  517. package/src/resources/simulations/inbound-wire-drawdown-requests.ts +131 -0
  518. package/src/resources/simulations/index.ts +41 -0
  519. package/src/resources/simulations/interest-payments.ts +1858 -0
  520. package/src/resources/simulations/programs.ts +31 -0
  521. package/src/resources/simulations/real-time-payments-transfers.ts +2677 -0
  522. package/src/resources/simulations/simulations.ts +99 -0
  523. package/src/resources/simulations/wire-transfers.ts +1937 -0
  524. package/src/resources/transactions.ts +1930 -0
  525. package/src/resources/wire-drawdown-requests.ts +215 -0
  526. package/src/resources/wire-transfers.ts +479 -0
  527. package/src/streaming.ts +274 -0
  528. package/src/uploads.ts +249 -0
  529. package/src/version.ts +1 -0
  530. package/streaming.d.ts +14 -0
  531. package/streaming.d.ts.map +1 -0
  532. package/streaming.js +213 -0
  533. package/streaming.js.map +1 -0
  534. package/streaming.mjs +209 -0
  535. package/streaming.mjs.map +1 -0
  536. package/uploads.d.ts +90 -0
  537. package/uploads.d.ts.map +1 -0
  538. package/uploads.js +208 -0
  539. package/uploads.js.map +1 -0
  540. package/uploads.mjs +175 -0
  541. package/uploads.mjs.map +1 -0
  542. package/version.d.ts +2 -0
  543. package/version.d.ts.map +1 -0
  544. package/version.js +5 -0
  545. package/version.js.map +1 -0
  546. package/version.mjs +2 -0
  547. package/version.mjs.map +1 -0
  548. package/_shims/agent.node.ts +0 -20
  549. package/_shims/agent.ts +0 -12
  550. package/_shims/fetch.node.ts +0 -11
  551. package/_shims/fetch.ts +0 -32
  552. package/_shims/fileFromPath.node.ts +0 -30
  553. package/_shims/fileFromPath.ts +0 -30
  554. package/_shims/formdata.ts +0 -22
  555. package/_shims/getMultipartRequestOptions.node.ts +0 -24
  556. package/_shims/getMultipartRequestOptions.ts +0 -13
  557. package/_shims/newFileArgs.ts +0 -94
  558. package/_shims/toFile.node.ts +0 -25
  559. package/_shims/toFile.ts +0 -26
  560. package/_shims/uploadable.node.ts +0 -21
  561. package/_shims/uploadable.ts +0 -82
  562. package/check-version.ts +0 -18
  563. package/core.ts +0 -761
  564. package/dist/cjs/_shims/agent.d.ts +0 -9
  565. package/dist/cjs/_shims/agent.d.ts.map +0 -1
  566. package/dist/cjs/_shims/agent.js.map +0 -1
  567. package/dist/cjs/_shims/agent.node.d.ts +0 -6
  568. package/dist/cjs/_shims/agent.node.d.ts.map +0 -1
  569. package/dist/cjs/_shims/agent.node.js.map +0 -1
  570. package/dist/cjs/_shims/fetch.d.ts +0 -19
  571. package/dist/cjs/_shims/fetch.d.ts.map +0 -1
  572. package/dist/cjs/_shims/fetch.js +0 -24
  573. package/dist/cjs/_shims/fetch.js.map +0 -1
  574. package/dist/cjs/_shims/fetch.node.d.ts +0 -9
  575. package/dist/cjs/_shims/fetch.node.d.ts.map +0 -1
  576. package/dist/cjs/_shims/fetch.node.js +0 -68
  577. package/dist/cjs/_shims/fetch.node.js.map +0 -1
  578. package/dist/cjs/_shims/fileFromPath.d.ts +0 -23
  579. package/dist/cjs/_shims/fileFromPath.d.ts.map +0 -1
  580. package/dist/cjs/_shims/fileFromPath.js +0 -49
  581. package/dist/cjs/_shims/fileFromPath.js.map +0 -1
  582. package/dist/cjs/_shims/fileFromPath.node.d.ts +0 -18
  583. package/dist/cjs/_shims/fileFromPath.node.d.ts.map +0 -1
  584. package/dist/cjs/_shims/fileFromPath.node.js +0 -50
  585. package/dist/cjs/_shims/fileFromPath.node.js.map +0 -1
  586. package/dist/cjs/_shims/formdata.d.ts +0 -13
  587. package/dist/cjs/_shims/formdata.d.ts.map +0 -1
  588. package/dist/cjs/_shims/formdata.js +0 -20
  589. package/dist/cjs/_shims/formdata.js.map +0 -1
  590. package/dist/cjs/_shims/formdata.node.d.ts +0 -7
  591. package/dist/cjs/_shims/formdata.node.d.ts.map +0 -1
  592. package/dist/cjs/_shims/formdata.node.js +0 -27
  593. package/dist/cjs/_shims/formdata.node.js.map +0 -1
  594. package/dist/cjs/_shims/getMultipartRequestOptions.d.ts +0 -10
  595. package/dist/cjs/_shims/getMultipartRequestOptions.d.ts.map +0 -1
  596. package/dist/cjs/_shims/getMultipartRequestOptions.js +0 -44
  597. package/dist/cjs/_shims/getMultipartRequestOptions.js.map +0 -1
  598. package/dist/cjs/_shims/getMultipartRequestOptions.node.d.ts +0 -10
  599. package/dist/cjs/_shims/getMultipartRequestOptions.node.d.ts.map +0 -1
  600. package/dist/cjs/_shims/getMultipartRequestOptions.node.js +0 -52
  601. package/dist/cjs/_shims/getMultipartRequestOptions.node.js.map +0 -1
  602. package/dist/cjs/_shims/newFileArgs.d.ts +0 -19
  603. package/dist/cjs/_shims/newFileArgs.d.ts.map +0 -1
  604. package/dist/cjs/_shims/newFileArgs.js +0 -169
  605. package/dist/cjs/_shims/newFileArgs.js.map +0 -1
  606. package/dist/cjs/_shims/toFile.d.ts +0 -21
  607. package/dist/cjs/_shims/toFile.d.ts.map +0 -1
  608. package/dist/cjs/_shims/toFile.js +0 -56
  609. package/dist/cjs/_shims/toFile.js.map +0 -1
  610. package/dist/cjs/_shims/toFile.node.d.ts +0 -20
  611. package/dist/cjs/_shims/toFile.node.d.ts.map +0 -1
  612. package/dist/cjs/_shims/toFile.node.js +0 -56
  613. package/dist/cjs/_shims/toFile.node.js.map +0 -1
  614. package/dist/cjs/_shims/uploadable.d.ts +0 -56
  615. package/dist/cjs/_shims/uploadable.d.ts.map +0 -1
  616. package/dist/cjs/_shims/uploadable.js +0 -37
  617. package/dist/cjs/_shims/uploadable.js.map +0 -1
  618. package/dist/cjs/_shims/uploadable.node.d.ts +0 -7
  619. package/dist/cjs/_shims/uploadable.node.d.ts.map +0 -1
  620. package/dist/cjs/_shims/uploadable.node.js +0 -23
  621. package/dist/cjs/_shims/uploadable.node.js.map +0 -1
  622. package/dist/cjs/check-version.d.ts +0 -2
  623. package/dist/cjs/check-version.d.ts.map +0 -1
  624. package/dist/cjs/check-version.js +0 -23
  625. package/dist/cjs/check-version.js.map +0 -1
  626. package/dist/cjs/core.d.ts +0 -221
  627. package/dist/cjs/core.d.ts.map +0 -1
  628. package/dist/cjs/core.js +0 -825
  629. package/dist/cjs/core.js.map +0 -1
  630. package/dist/cjs/error.d.ts +0 -208
  631. package/dist/cjs/error.d.ts.map +0 -1
  632. package/dist/cjs/error.js +0 -326
  633. package/dist/cjs/error.js.map +0 -1
  634. package/dist/cjs/index.d.ts +0 -301
  635. package/dist/cjs/index.d.ts.map +0 -1
  636. package/dist/cjs/index.js +0 -281
  637. package/dist/cjs/index.js.map +0 -1
  638. package/dist/cjs/pagination.d.ts +0 -34
  639. package/dist/cjs/pagination.d.ts.map +0 -1
  640. package/dist/cjs/pagination.js +0 -30
  641. package/dist/cjs/pagination.js.map +0 -1
  642. package/dist/cjs/resource.d.ts +0 -12
  643. package/dist/cjs/resource.d.ts.map +0 -1
  644. package/dist/cjs/resource.js.map +0 -1
  645. package/dist/cjs/resources/account-numbers.d.ts +0 -137
  646. package/dist/cjs/resources/account-numbers.d.ts.map +0 -1
  647. package/dist/cjs/resources/account-numbers.js +0 -81
  648. package/dist/cjs/resources/account-numbers.js.map +0 -1
  649. package/dist/cjs/resources/account-statements.d.ts +0 -106
  650. package/dist/cjs/resources/account-statements.d.ts.map +0 -1
  651. package/dist/cjs/resources/account-statements.js +0 -69
  652. package/dist/cjs/resources/account-statements.js.map +0 -1
  653. package/dist/cjs/resources/account-transfers.d.ts +0 -205
  654. package/dist/cjs/resources/account-transfers.d.ts.map +0 -1
  655. package/dist/cjs/resources/account-transfers.js +0 -87
  656. package/dist/cjs/resources/account-transfers.js.map +0 -1
  657. package/dist/cjs/resources/accounts.d.ts +0 -163
  658. package/dist/cjs/resources/accounts.d.ts.map +0 -1
  659. package/dist/cjs/resources/accounts.js +0 -87
  660. package/dist/cjs/resources/accounts.js.map +0 -1
  661. package/dist/cjs/resources/ach-prenotifications.d.ts +0 -199
  662. package/dist/cjs/resources/ach-prenotifications.d.ts.map +0 -1
  663. package/dist/cjs/resources/ach-prenotifications.js +0 -79
  664. package/dist/cjs/resources/ach-prenotifications.js.map +0 -1
  665. package/dist/cjs/resources/ach-transfers.d.ts +0 -461
  666. package/dist/cjs/resources/ach-transfers.d.ts.map +0 -1
  667. package/dist/cjs/resources/ach-transfers.js +0 -87
  668. package/dist/cjs/resources/ach-transfers.js.map +0 -1
  669. package/dist/cjs/resources/balance-lookups.d.ts +0 -52
  670. package/dist/cjs/resources/balance-lookups.d.ts.map +0 -1
  671. package/dist/cjs/resources/balance-lookups.js +0 -16
  672. package/dist/cjs/resources/balance-lookups.js.map +0 -1
  673. package/dist/cjs/resources/bookkeeping-accounts.d.ts +0 -78
  674. package/dist/cjs/resources/bookkeeping-accounts.d.ts.map +0 -1
  675. package/dist/cjs/resources/bookkeeping-accounts.js +0 -73
  676. package/dist/cjs/resources/bookkeeping-accounts.js.map +0 -1
  677. package/dist/cjs/resources/bookkeeping-entries.d.ts +0 -49
  678. package/dist/cjs/resources/bookkeeping-entries.d.ts.map +0 -1
  679. package/dist/cjs/resources/bookkeeping-entries.js +0 -63
  680. package/dist/cjs/resources/bookkeeping-entries.js.map +0 -1
  681. package/dist/cjs/resources/bookkeeping-entry-sets.d.ts +0 -88
  682. package/dist/cjs/resources/bookkeeping-entry-sets.d.ts.map +0 -1
  683. package/dist/cjs/resources/bookkeeping-entry-sets.js +0 -18
  684. package/dist/cjs/resources/bookkeeping-entry-sets.js.map +0 -1
  685. package/dist/cjs/resources/card-disputes.d.ts +0 -160
  686. package/dist/cjs/resources/card-disputes.d.ts.map +0 -1
  687. package/dist/cjs/resources/card-disputes.js +0 -75
  688. package/dist/cjs/resources/card-disputes.js.map +0 -1
  689. package/dist/cjs/resources/card-profiles.d.ts +0 -206
  690. package/dist/cjs/resources/card-profiles.d.ts.map +0 -1
  691. package/dist/cjs/resources/card-profiles.js +0 -75
  692. package/dist/cjs/resources/card-profiles.js.map +0 -1
  693. package/dist/cjs/resources/cards.d.ts +0 -354
  694. package/dist/cjs/resources/cards.d.ts.map +0 -1
  695. package/dist/cjs/resources/cards.js +0 -87
  696. package/dist/cjs/resources/cards.js.map +0 -1
  697. package/dist/cjs/resources/check-deposits.d.ts +0 -263
  698. package/dist/cjs/resources/check-deposits.d.ts.map +0 -1
  699. package/dist/cjs/resources/check-deposits.js +0 -75
  700. package/dist/cjs/resources/check-deposits.js.map +0 -1
  701. package/dist/cjs/resources/check-transfers.d.ts +0 -438
  702. package/dist/cjs/resources/check-transfers.d.ts.map +0 -1
  703. package/dist/cjs/resources/check-transfers.js +0 -93
  704. package/dist/cjs/resources/check-transfers.js.map +0 -1
  705. package/dist/cjs/resources/declined-transactions.d.ts +0 -492
  706. package/dist/cjs/resources/declined-transactions.d.ts.map +0 -1
  707. package/dist/cjs/resources/declined-transactions.js +0 -73
  708. package/dist/cjs/resources/declined-transactions.js.map +0 -1
  709. package/dist/cjs/resources/digital-wallet-tokens.d.ts +0 -92
  710. package/dist/cjs/resources/digital-wallet-tokens.d.ts.map +0 -1
  711. package/dist/cjs/resources/digital-wallet-tokens.js +0 -73
  712. package/dist/cjs/resources/digital-wallet-tokens.js.map +0 -1
  713. package/dist/cjs/resources/documents.d.ts +0 -95
  714. package/dist/cjs/resources/documents.d.ts.map +0 -1
  715. package/dist/cjs/resources/documents.js +0 -69
  716. package/dist/cjs/resources/documents.js.map +0 -1
  717. package/dist/cjs/resources/entities/entities.d.ts +0 -1622
  718. package/dist/cjs/resources/entities/entities.d.ts.map +0 -1
  719. package/dist/cjs/resources/entities/entities.js +0 -82
  720. package/dist/cjs/resources/entities/entities.js.map +0 -1
  721. package/dist/cjs/resources/entities/index.d.ts +0 -9
  722. package/dist/cjs/resources/entities/index.d.ts.map +0 -1
  723. package/dist/cjs/resources/entities/index.js +0 -35
  724. package/dist/cjs/resources/entities/index.js.map +0 -1
  725. package/dist/cjs/resources/entities/supplemental-documents.d.ts +0 -62
  726. package/dist/cjs/resources/entities/supplemental-documents.d.ts.map +0 -1
  727. package/dist/cjs/resources/entities/supplemental-documents.js +0 -72
  728. package/dist/cjs/resources/entities/supplemental-documents.js.map +0 -1
  729. package/dist/cjs/resources/event-subscriptions.d.ts +0 -209
  730. package/dist/cjs/resources/event-subscriptions.d.ts.map +0 -1
  731. package/dist/cjs/resources/event-subscriptions.js +0 -81
  732. package/dist/cjs/resources/event-subscriptions.js.map +0 -1
  733. package/dist/cjs/resources/events.d.ts +0 -195
  734. package/dist/cjs/resources/events.d.ts.map +0 -1
  735. package/dist/cjs/resources/events.js +0 -69
  736. package/dist/cjs/resources/events.js.map +0 -1
  737. package/dist/cjs/resources/exports.d.ts +0 -169
  738. package/dist/cjs/resources/exports.d.ts.map +0 -1
  739. package/dist/cjs/resources/exports.js +0 -75
  740. package/dist/cjs/resources/exports.js.map +0 -1
  741. package/dist/cjs/resources/external-accounts.d.ts +0 -131
  742. package/dist/cjs/resources/external-accounts.d.ts.map +0 -1
  743. package/dist/cjs/resources/external-accounts.js +0 -81
  744. package/dist/cjs/resources/external-accounts.js.map +0 -1
  745. package/dist/cjs/resources/files.d.ts +0 -167
  746. package/dist/cjs/resources/files.d.ts.map +0 -1
  747. package/dist/cjs/resources/files.js +0 -114
  748. package/dist/cjs/resources/files.js.map +0 -1
  749. package/dist/cjs/resources/groups.d.ts +0 -42
  750. package/dist/cjs/resources/groups.d.ts.map +0 -1
  751. package/dist/cjs/resources/groups.js +0 -16
  752. package/dist/cjs/resources/groups.js.map +0 -1
  753. package/dist/cjs/resources/inbound-ach-transfer-returns.d.ts +0 -117
  754. package/dist/cjs/resources/inbound-ach-transfer-returns.d.ts.map +0 -1
  755. package/dist/cjs/resources/inbound-ach-transfer-returns.js +0 -81
  756. package/dist/cjs/resources/inbound-ach-transfer-returns.js.map +0 -1
  757. package/dist/cjs/resources/inbound-wire-drawdown-requests.d.ts +0 -131
  758. package/dist/cjs/resources/inbound-wire-drawdown-requests.d.ts.map +0 -1
  759. package/dist/cjs/resources/inbound-wire-drawdown-requests.js +0 -76
  760. package/dist/cjs/resources/inbound-wire-drawdown-requests.js.map +0 -1
  761. package/dist/cjs/resources/index.d.ts +0 -192
  762. package/dist/cjs/resources/index.d.ts.map +0 -1
  763. package/dist/cjs/resources/index.js +0 -569
  764. package/dist/cjs/resources/index.js.map +0 -1
  765. package/dist/cjs/resources/limits.d.ts +0 -114
  766. package/dist/cjs/resources/limits.d.ts.map +0 -1
  767. package/dist/cjs/resources/limits.js +0 -81
  768. package/dist/cjs/resources/limits.js.map +0 -1
  769. package/dist/cjs/resources/oauth-connections.d.ts +0 -57
  770. package/dist/cjs/resources/oauth-connections.d.ts.map +0 -1
  771. package/dist/cjs/resources/oauth-connections.js +0 -69
  772. package/dist/cjs/resources/oauth-connections.js.map +0 -1
  773. package/dist/cjs/resources/pending-transactions.d.ts +0 -482
  774. package/dist/cjs/resources/pending-transactions.d.ts.map +0 -1
  775. package/dist/cjs/resources/pending-transactions.js +0 -73
  776. package/dist/cjs/resources/pending-transactions.js.map +0 -1
  777. package/dist/cjs/resources/programs.d.ts +0 -54
  778. package/dist/cjs/resources/programs.d.ts.map +0 -1
  779. package/dist/cjs/resources/programs.js +0 -69
  780. package/dist/cjs/resources/programs.js.map +0 -1
  781. package/dist/cjs/resources/real-time-decisions.d.ts +0 -330
  782. package/dist/cjs/resources/real-time-decisions.d.ts.map +0 -1
  783. package/dist/cjs/resources/real-time-decisions.js +0 -24
  784. package/dist/cjs/resources/real-time-decisions.js.map +0 -1
  785. package/dist/cjs/resources/real-time-payments-transfers.d.ts +0 -294
  786. package/dist/cjs/resources/real-time-payments-transfers.d.ts.map +0 -1
  787. package/dist/cjs/resources/real-time-payments-transfers.js +0 -81
  788. package/dist/cjs/resources/real-time-payments-transfers.js.map +0 -1
  789. package/dist/cjs/resources/routing-numbers.d.ts +0 -56
  790. package/dist/cjs/resources/routing-numbers.d.ts.map +0 -1
  791. package/dist/cjs/resources/routing-numbers.js +0 -65
  792. package/dist/cjs/resources/routing-numbers.js.map +0 -1
  793. package/dist/cjs/resources/shared.d.ts +0 -16
  794. package/dist/cjs/resources/shared.d.ts.map +0 -1
  795. package/dist/cjs/resources/shared.js.map +0 -1
  796. package/dist/cjs/resources/simulations/account-statements.d.ts +0 -24
  797. package/dist/cjs/resources/simulations/account-statements.d.ts.map +0 -1
  798. package/dist/cjs/resources/simulations/account-statements.js +0 -19
  799. package/dist/cjs/resources/simulations/account-statements.js.map +0 -1
  800. package/dist/cjs/resources/simulations/account-transfers.d.ts +0 -16
  801. package/dist/cjs/resources/simulations/account-transfers.d.ts.map +0 -1
  802. package/dist/cjs/resources/simulations/account-transfers.js +0 -18
  803. package/dist/cjs/resources/simulations/account-transfers.js.map +0 -1
  804. package/dist/cjs/resources/simulations/ach-transfers.d.ts +0 -1836
  805. package/dist/cjs/resources/simulations/ach-transfers.d.ts.map +0 -1
  806. package/dist/cjs/resources/simulations/ach-transfers.js +0 -40
  807. package/dist/cjs/resources/simulations/ach-transfers.js.map +0 -1
  808. package/dist/cjs/resources/simulations/card-disputes.d.ts +0 -31
  809. package/dist/cjs/resources/simulations/card-disputes.d.ts.map +0 -1
  810. package/dist/cjs/resources/simulations/card-disputes.js +0 -19
  811. package/dist/cjs/resources/simulations/card-disputes.js.map +0 -1
  812. package/dist/cjs/resources/simulations/card-refunds.d.ts +0 -25
  813. package/dist/cjs/resources/simulations/card-refunds.d.ts.map +0 -1
  814. package/dist/cjs/resources/simulations/card-refunds.js +0 -17
  815. package/dist/cjs/resources/simulations/card-refunds.js.map +0 -1
  816. package/dist/cjs/resources/simulations/cards.d.ts +0 -931
  817. package/dist/cjs/resources/simulations/cards.d.ts.map +0 -1
  818. package/dist/cjs/resources/simulations/cards.js +0 -32
  819. package/dist/cjs/resources/simulations/cards.js.map +0 -1
  820. package/dist/cjs/resources/simulations/check-deposits.d.ts +0 -31
  821. package/dist/cjs/resources/simulations/check-deposits.d.ts.map +0 -1
  822. package/dist/cjs/resources/simulations/check-deposits.js +0 -31
  823. package/dist/cjs/resources/simulations/check-deposits.js.map +0 -1
  824. package/dist/cjs/resources/simulations/check-transfers.d.ts +0 -42
  825. package/dist/cjs/resources/simulations/check-transfers.d.ts.map +0 -1
  826. package/dist/cjs/resources/simulations/check-transfers.js +0 -35
  827. package/dist/cjs/resources/simulations/check-transfers.js.map +0 -1
  828. package/dist/cjs/resources/simulations/digital-wallet-token-requests.d.ts +0 -49
  829. package/dist/cjs/resources/simulations/digital-wallet-token-requests.d.ts.map +0 -1
  830. package/dist/cjs/resources/simulations/digital-wallet-token-requests.js +0 -20
  831. package/dist/cjs/resources/simulations/digital-wallet-token-requests.js.map +0 -1
  832. package/dist/cjs/resources/simulations/documents.d.ts +0 -23
  833. package/dist/cjs/resources/simulations/documents.d.ts.map +0 -1
  834. package/dist/cjs/resources/simulations/documents.js +0 -16
  835. package/dist/cjs/resources/simulations/documents.js.map +0 -1
  836. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.d.ts +0 -106
  837. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +0 -1
  838. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.js +0 -20
  839. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.js.map +0 -1
  840. package/dist/cjs/resources/simulations/index.d.ts +0 -38
  841. package/dist/cjs/resources/simulations/index.d.ts.map +0 -1
  842. package/dist/cjs/resources/simulations/index.js +0 -133
  843. package/dist/cjs/resources/simulations/index.js.map +0 -1
  844. package/dist/cjs/resources/simulations/interest-payments.d.ts +0 -1272
  845. package/dist/cjs/resources/simulations/interest-payments.d.ts.map +0 -1
  846. package/dist/cjs/resources/simulations/interest-payments.js +0 -19
  847. package/dist/cjs/resources/simulations/interest-payments.js.map +0 -1
  848. package/dist/cjs/resources/simulations/programs.d.ts +0 -25
  849. package/dist/cjs/resources/simulations/programs.d.ts.map +0 -1
  850. package/dist/cjs/resources/simulations/programs.js +0 -18
  851. package/dist/cjs/resources/simulations/programs.js.map +0 -1
  852. package/dist/cjs/resources/simulations/real-time-payments-transfers.d.ts +0 -1782
  853. package/dist/cjs/resources/simulations/real-time-payments-transfers.d.ts.map +0 -1
  854. package/dist/cjs/resources/simulations/real-time-payments-transfers.js +0 -30
  855. package/dist/cjs/resources/simulations/real-time-payments-transfers.js.map +0 -1
  856. package/dist/cjs/resources/simulations/simulations.d.ts +0 -74
  857. package/dist/cjs/resources/simulations/simulations.d.ts.map +0 -1
  858. package/dist/cjs/resources/simulations/simulations.js +0 -106
  859. package/dist/cjs/resources/simulations/simulations.js.map +0 -1
  860. package/dist/cjs/resources/simulations/wire-transfers.d.ts +0 -1338
  861. package/dist/cjs/resources/simulations/wire-transfers.d.ts.map +0 -1
  862. package/dist/cjs/resources/simulations/wire-transfers.js +0 -16
  863. package/dist/cjs/resources/simulations/wire-transfers.js.map +0 -1
  864. package/dist/cjs/resources/transactions.d.ts +0 -1326
  865. package/dist/cjs/resources/transactions.d.ts.map +0 -1
  866. package/dist/cjs/resources/transactions.js +0 -69
  867. package/dist/cjs/resources/transactions.js.map +0 -1
  868. package/dist/cjs/resources/wire-drawdown-requests.d.ts +0 -160
  869. package/dist/cjs/resources/wire-drawdown-requests.d.ts.map +0 -1
  870. package/dist/cjs/resources/wire-drawdown-requests.js +0 -79
  871. package/dist/cjs/resources/wire-drawdown-requests.js.map +0 -1
  872. package/dist/cjs/resources/wire-transfers.d.ts +0 -352
  873. package/dist/cjs/resources/wire-transfers.d.ts.map +0 -1
  874. package/dist/cjs/resources/wire-transfers.js +0 -104
  875. package/dist/cjs/resources/wire-transfers.js.map +0 -1
  876. package/dist/cjs/streaming.d.ts +0 -12
  877. package/dist/cjs/streaming.d.ts.map +0 -1
  878. package/dist/cjs/streaming.js +0 -284
  879. package/dist/cjs/streaming.js.map +0 -1
  880. package/dist/cjs/uploads.d.ts +0 -24
  881. package/dist/cjs/uploads.d.ts.map +0 -1
  882. package/dist/cjs/uploads.js +0 -121
  883. package/dist/cjs/uploads.js.map +0 -1
  884. package/dist/cjs/version.d.ts +0 -2
  885. package/dist/cjs/version.d.ts.map +0 -1
  886. package/dist/cjs/version.js +0 -5
  887. package/dist/cjs/version.js.map +0 -1
  888. package/dist/esm/_shims/agent.d.ts +0 -9
  889. package/dist/esm/_shims/agent.d.ts.map +0 -1
  890. package/dist/esm/_shims/agent.js +0 -10
  891. package/dist/esm/_shims/agent.js.map +0 -1
  892. package/dist/esm/_shims/agent.node.d.ts +0 -6
  893. package/dist/esm/_shims/agent.node.d.ts.map +0 -1
  894. package/dist/esm/_shims/agent.node.js +0 -16
  895. package/dist/esm/_shims/agent.node.js.map +0 -1
  896. package/dist/esm/_shims/fetch.d.ts +0 -19
  897. package/dist/esm/_shims/fetch.d.ts.map +0 -1
  898. package/dist/esm/_shims/fetch.js +0 -18
  899. package/dist/esm/_shims/fetch.js.map +0 -1
  900. package/dist/esm/_shims/fetch.node.d.ts +0 -9
  901. package/dist/esm/_shims/fetch.node.d.ts.map +0 -1
  902. package/dist/esm/_shims/fetch.node.js +0 -7
  903. package/dist/esm/_shims/fetch.node.js.map +0 -1
  904. package/dist/esm/_shims/fileFromPath.d.ts +0 -23
  905. package/dist/esm/_shims/fileFromPath.d.ts.map +0 -1
  906. package/dist/esm/_shims/fileFromPath.js +0 -12
  907. package/dist/esm/_shims/fileFromPath.js.map +0 -1
  908. package/dist/esm/_shims/fileFromPath.node.d.ts +0 -18
  909. package/dist/esm/_shims/fileFromPath.node.d.ts.map +0 -1
  910. package/dist/esm/_shims/fileFromPath.node.js +0 -13
  911. package/dist/esm/_shims/fileFromPath.node.js.map +0 -1
  912. package/dist/esm/_shims/formdata.d.ts +0 -13
  913. package/dist/esm/_shims/formdata.d.ts.map +0 -1
  914. package/dist/esm/_shims/formdata.js +0 -15
  915. package/dist/esm/_shims/formdata.js.map +0 -1
  916. package/dist/esm/_shims/formdata.node.d.ts +0 -7
  917. package/dist/esm/_shims/formdata.node.d.ts.map +0 -1
  918. package/dist/esm/_shims/formdata.node.js +0 -7
  919. package/dist/esm/_shims/formdata.node.js.map +0 -1
  920. package/dist/esm/_shims/getMultipartRequestOptions.d.ts.map +0 -1
  921. package/dist/esm/_shims/getMultipartRequestOptions.js +0 -7
  922. package/dist/esm/_shims/getMultipartRequestOptions.js.map +0 -1
  923. package/dist/esm/_shims/getMultipartRequestOptions.node.d.ts.map +0 -1
  924. package/dist/esm/_shims/getMultipartRequestOptions.node.js +0 -17
  925. package/dist/esm/_shims/getMultipartRequestOptions.node.js.map +0 -1
  926. package/dist/esm/_shims/newFileArgs.d.ts +0 -19
  927. package/dist/esm/_shims/newFileArgs.d.ts.map +0 -1
  928. package/dist/esm/_shims/newFileArgs.js +0 -66
  929. package/dist/esm/_shims/newFileArgs.js.map +0 -1
  930. package/dist/esm/_shims/toFile.d.ts +0 -21
  931. package/dist/esm/_shims/toFile.d.ts.map +0 -1
  932. package/dist/esm/_shims/toFile.js +0 -19
  933. package/dist/esm/_shims/toFile.js.map +0 -1
  934. package/dist/esm/_shims/toFile.node.d.ts +0 -20
  935. package/dist/esm/_shims/toFile.node.d.ts.map +0 -1
  936. package/dist/esm/_shims/toFile.node.js +0 -19
  937. package/dist/esm/_shims/toFile.node.js.map +0 -1
  938. package/dist/esm/_shims/uploadable.d.ts +0 -56
  939. package/dist/esm/_shims/uploadable.d.ts.map +0 -1
  940. package/dist/esm/_shims/uploadable.js +0 -30
  941. package/dist/esm/_shims/uploadable.js.map +0 -1
  942. package/dist/esm/_shims/uploadable.node.d.ts +0 -7
  943. package/dist/esm/_shims/uploadable.node.d.ts.map +0 -1
  944. package/dist/esm/_shims/uploadable.node.js +0 -10
  945. package/dist/esm/_shims/uploadable.node.js.map +0 -1
  946. package/dist/esm/check-version.d.ts +0 -2
  947. package/dist/esm/check-version.d.ts.map +0 -1
  948. package/dist/esm/check-version.js +0 -16
  949. package/dist/esm/check-version.js.map +0 -1
  950. package/dist/esm/core.d.ts +0 -221
  951. package/dist/esm/core.d.ts.map +0 -1
  952. package/dist/esm/core.js +0 -556
  953. package/dist/esm/core.js.map +0 -1
  954. package/dist/esm/error.d.ts +0 -208
  955. package/dist/esm/error.d.ts.map +0 -1
  956. package/dist/esm/error.js +0 -275
  957. package/dist/esm/error.js.map +0 -1
  958. package/dist/esm/index.d.ts +0 -301
  959. package/dist/esm/index.d.ts.map +0 -1
  960. package/dist/esm/index.js +0 -213
  961. package/dist/esm/index.js.map +0 -1
  962. package/dist/esm/package.json +0 -3
  963. package/dist/esm/pagination.d.ts.map +0 -1
  964. package/dist/esm/pagination.js +0 -26
  965. package/dist/esm/pagination.js.map +0 -1
  966. package/dist/esm/resource.d.ts.map +0 -1
  967. package/dist/esm/resource.js +0 -13
  968. package/dist/esm/resource.js.map +0 -1
  969. package/dist/esm/resources/account-numbers.d.ts +0 -137
  970. package/dist/esm/resources/account-numbers.d.ts.map +0 -1
  971. package/dist/esm/resources/account-numbers.js +0 -36
  972. package/dist/esm/resources/account-numbers.js.map +0 -1
  973. package/dist/esm/resources/account-statements.d.ts +0 -106
  974. package/dist/esm/resources/account-statements.d.ts.map +0 -1
  975. package/dist/esm/resources/account-statements.js +0 -24
  976. package/dist/esm/resources/account-statements.js.map +0 -1
  977. package/dist/esm/resources/account-transfers.d.ts +0 -205
  978. package/dist/esm/resources/account-transfers.d.ts.map +0 -1
  979. package/dist/esm/resources/account-transfers.js +0 -42
  980. package/dist/esm/resources/account-transfers.js.map +0 -1
  981. package/dist/esm/resources/accounts.d.ts +0 -163
  982. package/dist/esm/resources/accounts.d.ts.map +0 -1
  983. package/dist/esm/resources/accounts.js +0 -42
  984. package/dist/esm/resources/accounts.js.map +0 -1
  985. package/dist/esm/resources/ach-prenotifications.d.ts +0 -199
  986. package/dist/esm/resources/ach-prenotifications.d.ts.map +0 -1
  987. package/dist/esm/resources/ach-prenotifications.js +0 -30
  988. package/dist/esm/resources/ach-prenotifications.js.map +0 -1
  989. package/dist/esm/resources/ach-transfers.d.ts +0 -461
  990. package/dist/esm/resources/ach-transfers.d.ts.map +0 -1
  991. package/dist/esm/resources/ach-transfers.js +0 -42
  992. package/dist/esm/resources/ach-transfers.js.map +0 -1
  993. package/dist/esm/resources/balance-lookups.d.ts +0 -52
  994. package/dist/esm/resources/balance-lookups.d.ts.map +0 -1
  995. package/dist/esm/resources/balance-lookups.js +0 -12
  996. package/dist/esm/resources/balance-lookups.js.map +0 -1
  997. package/dist/esm/resources/bookkeeping-accounts.d.ts +0 -78
  998. package/dist/esm/resources/bookkeeping-accounts.d.ts.map +0 -1
  999. package/dist/esm/resources/bookkeeping-accounts.js +0 -24
  1000. package/dist/esm/resources/bookkeeping-accounts.js.map +0 -1
  1001. package/dist/esm/resources/bookkeeping-entries.d.ts +0 -49
  1002. package/dist/esm/resources/bookkeeping-entries.d.ts.map +0 -1
  1003. package/dist/esm/resources/bookkeeping-entries.js +0 -18
  1004. package/dist/esm/resources/bookkeeping-entries.js.map +0 -1
  1005. package/dist/esm/resources/bookkeeping-entry-sets.d.ts +0 -88
  1006. package/dist/esm/resources/bookkeeping-entry-sets.d.ts.map +0 -1
  1007. package/dist/esm/resources/bookkeeping-entry-sets.js +0 -12
  1008. package/dist/esm/resources/bookkeeping-entry-sets.js.map +0 -1
  1009. package/dist/esm/resources/card-disputes.d.ts +0 -160
  1010. package/dist/esm/resources/card-disputes.d.ts.map +0 -1
  1011. package/dist/esm/resources/card-disputes.js +0 -30
  1012. package/dist/esm/resources/card-disputes.js.map +0 -1
  1013. package/dist/esm/resources/card-profiles.d.ts +0 -206
  1014. package/dist/esm/resources/card-profiles.d.ts.map +0 -1
  1015. package/dist/esm/resources/card-profiles.js +0 -30
  1016. package/dist/esm/resources/card-profiles.js.map +0 -1
  1017. package/dist/esm/resources/cards.d.ts +0 -354
  1018. package/dist/esm/resources/cards.d.ts.map +0 -1
  1019. package/dist/esm/resources/cards.js +0 -42
  1020. package/dist/esm/resources/cards.js.map +0 -1
  1021. package/dist/esm/resources/check-deposits.d.ts +0 -263
  1022. package/dist/esm/resources/check-deposits.d.ts.map +0 -1
  1023. package/dist/esm/resources/check-deposits.js +0 -30
  1024. package/dist/esm/resources/check-deposits.js.map +0 -1
  1025. package/dist/esm/resources/check-transfers.d.ts +0 -438
  1026. package/dist/esm/resources/check-transfers.d.ts.map +0 -1
  1027. package/dist/esm/resources/check-transfers.js +0 -48
  1028. package/dist/esm/resources/check-transfers.js.map +0 -1
  1029. package/dist/esm/resources/declined-transactions.d.ts +0 -492
  1030. package/dist/esm/resources/declined-transactions.d.ts.map +0 -1
  1031. package/dist/esm/resources/declined-transactions.js +0 -24
  1032. package/dist/esm/resources/declined-transactions.js.map +0 -1
  1033. package/dist/esm/resources/digital-wallet-tokens.d.ts +0 -92
  1034. package/dist/esm/resources/digital-wallet-tokens.d.ts.map +0 -1
  1035. package/dist/esm/resources/digital-wallet-tokens.js +0 -24
  1036. package/dist/esm/resources/digital-wallet-tokens.js.map +0 -1
  1037. package/dist/esm/resources/documents.d.ts +0 -95
  1038. package/dist/esm/resources/documents.d.ts.map +0 -1
  1039. package/dist/esm/resources/documents.js +0 -24
  1040. package/dist/esm/resources/documents.js.map +0 -1
  1041. package/dist/esm/resources/entities/entities.d.ts +0 -1622
  1042. package/dist/esm/resources/entities/entities.d.ts.map +0 -1
  1043. package/dist/esm/resources/entities/entities.js +0 -37
  1044. package/dist/esm/resources/entities/entities.js.map +0 -1
  1045. package/dist/esm/resources/entities/index.d.ts.map +0 -1
  1046. package/dist/esm/resources/entities/index.js +0 -4
  1047. package/dist/esm/resources/entities/index.js.map +0 -1
  1048. package/dist/esm/resources/entities/supplemental-documents.d.ts +0 -62
  1049. package/dist/esm/resources/entities/supplemental-documents.d.ts.map +0 -1
  1050. package/dist/esm/resources/entities/supplemental-documents.js +0 -26
  1051. package/dist/esm/resources/entities/supplemental-documents.js.map +0 -1
  1052. package/dist/esm/resources/event-subscriptions.d.ts +0 -209
  1053. package/dist/esm/resources/event-subscriptions.d.ts.map +0 -1
  1054. package/dist/esm/resources/event-subscriptions.js +0 -36
  1055. package/dist/esm/resources/event-subscriptions.js.map +0 -1
  1056. package/dist/esm/resources/events.d.ts +0 -195
  1057. package/dist/esm/resources/events.d.ts.map +0 -1
  1058. package/dist/esm/resources/events.js +0 -24
  1059. package/dist/esm/resources/events.js.map +0 -1
  1060. package/dist/esm/resources/exports.d.ts +0 -169
  1061. package/dist/esm/resources/exports.d.ts.map +0 -1
  1062. package/dist/esm/resources/exports.js +0 -30
  1063. package/dist/esm/resources/exports.js.map +0 -1
  1064. package/dist/esm/resources/external-accounts.d.ts +0 -131
  1065. package/dist/esm/resources/external-accounts.d.ts.map +0 -1
  1066. package/dist/esm/resources/external-accounts.js +0 -36
  1067. package/dist/esm/resources/external-accounts.js.map +0 -1
  1068. package/dist/esm/resources/files.d.ts +0 -167
  1069. package/dist/esm/resources/files.d.ts.map +0 -1
  1070. package/dist/esm/resources/files.js +0 -33
  1071. package/dist/esm/resources/files.js.map +0 -1
  1072. package/dist/esm/resources/groups.d.ts +0 -42
  1073. package/dist/esm/resources/groups.d.ts.map +0 -1
  1074. package/dist/esm/resources/groups.js +0 -12
  1075. package/dist/esm/resources/groups.js.map +0 -1
  1076. package/dist/esm/resources/inbound-ach-transfer-returns.d.ts +0 -117
  1077. package/dist/esm/resources/inbound-ach-transfer-returns.d.ts.map +0 -1
  1078. package/dist/esm/resources/inbound-ach-transfer-returns.js +0 -33
  1079. package/dist/esm/resources/inbound-ach-transfer-returns.js.map +0 -1
  1080. package/dist/esm/resources/inbound-wire-drawdown-requests.d.ts +0 -131
  1081. package/dist/esm/resources/inbound-wire-drawdown-requests.d.ts.map +0 -1
  1082. package/dist/esm/resources/inbound-wire-drawdown-requests.js +0 -27
  1083. package/dist/esm/resources/inbound-wire-drawdown-requests.js.map +0 -1
  1084. package/dist/esm/resources/index.d.ts +0 -199
  1085. package/dist/esm/resources/index.d.ts.map +0 -1
  1086. package/dist/esm/resources/index.js +0 -44
  1087. package/dist/esm/resources/index.js.map +0 -1
  1088. package/dist/esm/resources/limits.d.ts +0 -114
  1089. package/dist/esm/resources/limits.d.ts.map +0 -1
  1090. package/dist/esm/resources/limits.js +0 -36
  1091. package/dist/esm/resources/limits.js.map +0 -1
  1092. package/dist/esm/resources/oauth-connections.d.ts +0 -57
  1093. package/dist/esm/resources/oauth-connections.d.ts.map +0 -1
  1094. package/dist/esm/resources/oauth-connections.js +0 -24
  1095. package/dist/esm/resources/oauth-connections.js.map +0 -1
  1096. package/dist/esm/resources/pending-transactions.d.ts +0 -482
  1097. package/dist/esm/resources/pending-transactions.d.ts.map +0 -1
  1098. package/dist/esm/resources/pending-transactions.js +0 -24
  1099. package/dist/esm/resources/pending-transactions.js.map +0 -1
  1100. package/dist/esm/resources/programs.d.ts +0 -54
  1101. package/dist/esm/resources/programs.d.ts.map +0 -1
  1102. package/dist/esm/resources/programs.js +0 -24
  1103. package/dist/esm/resources/programs.js.map +0 -1
  1104. package/dist/esm/resources/real-time-decisions.d.ts +0 -330
  1105. package/dist/esm/resources/real-time-decisions.d.ts.map +0 -1
  1106. package/dist/esm/resources/real-time-decisions.js +0 -18
  1107. package/dist/esm/resources/real-time-decisions.js.map +0 -1
  1108. package/dist/esm/resources/real-time-payments-transfers.d.ts +0 -294
  1109. package/dist/esm/resources/real-time-payments-transfers.d.ts.map +0 -1
  1110. package/dist/esm/resources/real-time-payments-transfers.js +0 -33
  1111. package/dist/esm/resources/real-time-payments-transfers.js.map +0 -1
  1112. package/dist/esm/resources/routing-numbers.d.ts +0 -56
  1113. package/dist/esm/resources/routing-numbers.d.ts.map +0 -1
  1114. package/dist/esm/resources/routing-numbers.js +0 -20
  1115. package/dist/esm/resources/routing-numbers.js.map +0 -1
  1116. package/dist/esm/resources/shared.d.ts +0 -16
  1117. package/dist/esm/resources/shared.d.ts.map +0 -1
  1118. package/dist/esm/resources/shared.js +0 -3
  1119. package/dist/esm/resources/shared.js.map +0 -1
  1120. package/dist/esm/resources/simulations/account-statements.d.ts +0 -24
  1121. package/dist/esm/resources/simulations/account-statements.d.ts.map +0 -1
  1122. package/dist/esm/resources/simulations/account-statements.js +0 -13
  1123. package/dist/esm/resources/simulations/account-statements.js.map +0 -1
  1124. package/dist/esm/resources/simulations/account-transfers.d.ts +0 -16
  1125. package/dist/esm/resources/simulations/account-transfers.d.ts.map +0 -1
  1126. package/dist/esm/resources/simulations/account-transfers.js +0 -14
  1127. package/dist/esm/resources/simulations/account-transfers.js.map +0 -1
  1128. package/dist/esm/resources/simulations/ach-transfers.d.ts +0 -1836
  1129. package/dist/esm/resources/simulations/ach-transfers.d.ts.map +0 -1
  1130. package/dist/esm/resources/simulations/ach-transfers.js +0 -36
  1131. package/dist/esm/resources/simulations/ach-transfers.js.map +0 -1
  1132. package/dist/esm/resources/simulations/card-disputes.d.ts +0 -31
  1133. package/dist/esm/resources/simulations/card-disputes.d.ts.map +0 -1
  1134. package/dist/esm/resources/simulations/card-disputes.js +0 -15
  1135. package/dist/esm/resources/simulations/card-disputes.js.map +0 -1
  1136. package/dist/esm/resources/simulations/card-refunds.d.ts +0 -25
  1137. package/dist/esm/resources/simulations/card-refunds.d.ts.map +0 -1
  1138. package/dist/esm/resources/simulations/card-refunds.js +0 -13
  1139. package/dist/esm/resources/simulations/card-refunds.js.map +0 -1
  1140. package/dist/esm/resources/simulations/cards.d.ts +0 -931
  1141. package/dist/esm/resources/simulations/cards.d.ts.map +0 -1
  1142. package/dist/esm/resources/simulations/cards.js +0 -28
  1143. package/dist/esm/resources/simulations/cards.js.map +0 -1
  1144. package/dist/esm/resources/simulations/check-deposits.d.ts +0 -31
  1145. package/dist/esm/resources/simulations/check-deposits.d.ts.map +0 -1
  1146. package/dist/esm/resources/simulations/check-deposits.js +0 -27
  1147. package/dist/esm/resources/simulations/check-deposits.js.map +0 -1
  1148. package/dist/esm/resources/simulations/check-transfers.d.ts +0 -42
  1149. package/dist/esm/resources/simulations/check-transfers.d.ts.map +0 -1
  1150. package/dist/esm/resources/simulations/check-transfers.js +0 -28
  1151. package/dist/esm/resources/simulations/check-transfers.js.map +0 -1
  1152. package/dist/esm/resources/simulations/digital-wallet-token-requests.d.ts +0 -49
  1153. package/dist/esm/resources/simulations/digital-wallet-token-requests.d.ts.map +0 -1
  1154. package/dist/esm/resources/simulations/digital-wallet-token-requests.js +0 -13
  1155. package/dist/esm/resources/simulations/digital-wallet-token-requests.js.map +0 -1
  1156. package/dist/esm/resources/simulations/documents.d.ts +0 -23
  1157. package/dist/esm/resources/simulations/documents.d.ts.map +0 -1
  1158. package/dist/esm/resources/simulations/documents.js +0 -12
  1159. package/dist/esm/resources/simulations/documents.js.map +0 -1
  1160. package/dist/esm/resources/simulations/inbound-wire-drawdown-requests.d.ts +0 -106
  1161. package/dist/esm/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +0 -1
  1162. package/dist/esm/resources/simulations/inbound-wire-drawdown-requests.js +0 -15
  1163. package/dist/esm/resources/simulations/inbound-wire-drawdown-requests.js.map +0 -1
  1164. package/dist/esm/resources/simulations/index.d.ts +0 -38
  1165. package/dist/esm/resources/simulations/index.d.ts.map +0 -1
  1166. package/dist/esm/resources/simulations/index.js +0 -18
  1167. package/dist/esm/resources/simulations/index.js.map +0 -1
  1168. package/dist/esm/resources/simulations/interest-payments.d.ts +0 -1272
  1169. package/dist/esm/resources/simulations/interest-payments.d.ts.map +0 -1
  1170. package/dist/esm/resources/simulations/interest-payments.js +0 -13
  1171. package/dist/esm/resources/simulations/interest-payments.js.map +0 -1
  1172. package/dist/esm/resources/simulations/programs.d.ts +0 -25
  1173. package/dist/esm/resources/simulations/programs.d.ts.map +0 -1
  1174. package/dist/esm/resources/simulations/programs.js +0 -14
  1175. package/dist/esm/resources/simulations/programs.js.map +0 -1
  1176. package/dist/esm/resources/simulations/real-time-payments-transfers.d.ts +0 -1782
  1177. package/dist/esm/resources/simulations/real-time-payments-transfers.d.ts.map +0 -1
  1178. package/dist/esm/resources/simulations/real-time-payments-transfers.js +0 -24
  1179. package/dist/esm/resources/simulations/real-time-payments-transfers.js.map +0 -1
  1180. package/dist/esm/resources/simulations/simulations.d.ts +0 -74
  1181. package/dist/esm/resources/simulations/simulations.d.ts.map +0 -1
  1182. package/dist/esm/resources/simulations/simulations.js +0 -56
  1183. package/dist/esm/resources/simulations/simulations.js.map +0 -1
  1184. package/dist/esm/resources/simulations/wire-transfers.d.ts +0 -1338
  1185. package/dist/esm/resources/simulations/wire-transfers.d.ts.map +0 -1
  1186. package/dist/esm/resources/simulations/wire-transfers.js +0 -12
  1187. package/dist/esm/resources/simulations/wire-transfers.js.map +0 -1
  1188. package/dist/esm/resources/transactions.d.ts +0 -1326
  1189. package/dist/esm/resources/transactions.d.ts.map +0 -1
  1190. package/dist/esm/resources/transactions.js +0 -24
  1191. package/dist/esm/resources/transactions.js.map +0 -1
  1192. package/dist/esm/resources/wire-drawdown-requests.d.ts +0 -160
  1193. package/dist/esm/resources/wire-drawdown-requests.d.ts.map +0 -1
  1194. package/dist/esm/resources/wire-drawdown-requests.js +0 -30
  1195. package/dist/esm/resources/wire-drawdown-requests.js.map +0 -1
  1196. package/dist/esm/resources/wire-transfers.d.ts +0 -352
  1197. package/dist/esm/resources/wire-transfers.d.ts.map +0 -1
  1198. package/dist/esm/resources/wire-transfers.js +0 -59
  1199. package/dist/esm/resources/wire-transfers.js.map +0 -1
  1200. package/dist/esm/streaming.d.ts +0 -12
  1201. package/dist/esm/streaming.d.ts.map +0 -1
  1202. package/dist/esm/streaming.js +0 -150
  1203. package/dist/esm/streaming.js.map +0 -1
  1204. package/dist/esm/uploads.d.ts +0 -24
  1205. package/dist/esm/uploads.d.ts.map +0 -1
  1206. package/dist/esm/uploads.js +0 -61
  1207. package/dist/esm/uploads.js.map +0 -1
  1208. package/dist/esm/version.d.ts +0 -2
  1209. package/dist/esm/version.d.ts.map +0 -1
  1210. package/dist/esm/version.js +0 -2
  1211. package/dist/esm/version.js.map +0 -1
  1212. package/error.ts +0 -505
  1213. package/index.ts +0 -388
  1214. package/resources/account-numbers.ts +0 -179
  1215. package/resources/account-statements.ts +0 -138
  1216. package/resources/account-transfers.ts +0 -260
  1217. package/resources/accounts.ts +0 -213
  1218. package/resources/ach-prenotifications.ts +0 -252
  1219. package/resources/ach-transfers.ts +0 -553
  1220. package/resources/balance-lookups.ts +0 -63
  1221. package/resources/bookkeeping-accounts.ts +0 -106
  1222. package/resources/bookkeeping-entries.ts +0 -69
  1223. package/resources/bookkeeping-entry-sets.ts +0 -106
  1224. package/resources/card-disputes.ts +0 -203
  1225. package/resources/card-profiles.ts +0 -258
  1226. package/resources/cards.ts +0 -435
  1227. package/resources/check-deposits.ts +0 -324
  1228. package/resources/check-transfers.ts +0 -541
  1229. package/resources/declined-transactions.ts +0 -623
  1230. package/resources/digital-wallet-tokens.ts +0 -121
  1231. package/resources/documents.ts +0 -126
  1232. package/resources/entities/entities.ts +0 -1913
  1233. package/resources/entities/supplemental-documents.ts +0 -79
  1234. package/resources/event-subscriptions.ts +0 -244
  1235. package/resources/events.ts +0 -226
  1236. package/resources/exports.ts +0 -212
  1237. package/resources/external-accounts.ts +0 -171
  1238. package/resources/files.ts +0 -205
  1239. package/resources/groups.ts +0 -52
  1240. package/resources/inbound-ach-transfer-returns.ts +0 -152
  1241. package/resources/inbound-wire-drawdown-requests.ts +0 -174
  1242. package/resources/index.ts +0 -193
  1243. package/resources/limits.ts +0 -152
  1244. package/resources/oauth-connections.ts +0 -80
  1245. package/resources/pending-transactions.ts +0 -576
  1246. package/resources/programs.ts +0 -77
  1247. package/resources/real-time-decisions.ts +0 -386
  1248. package/resources/real-time-payments-transfers.ts +0 -359
  1249. package/resources/routing-numbers.ts +0 -69
  1250. package/resources/shared.ts +0 -17
  1251. package/resources/simulations/account-statements.ts +0 -30
  1252. package/resources/simulations/account-transfers.ts +0 -20
  1253. package/resources/simulations/ach-transfers.ts +0 -2226
  1254. package/resources/simulations/card-disputes.ts +0 -38
  1255. package/resources/simulations/card-refunds.ts +0 -31
  1256. package/resources/simulations/cards.ts +0 -1123
  1257. package/resources/simulations/check-deposits.ts +0 -41
  1258. package/resources/simulations/check-transfers.ts +0 -54
  1259. package/resources/simulations/digital-wallet-token-requests.ts +0 -58
  1260. package/resources/simulations/documents.ts +0 -29
  1261. package/resources/simulations/inbound-wire-drawdown-requests.ts +0 -131
  1262. package/resources/simulations/index.ts +0 -39
  1263. package/resources/simulations/interest-payments.ts +0 -1542
  1264. package/resources/simulations/programs.ts +0 -31
  1265. package/resources/simulations/real-time-payments-transfers.ts +0 -2173
  1266. package/resources/simulations/simulations.ts +0 -91
  1267. package/resources/simulations/wire-transfers.ts +0 -1621
  1268. package/resources/transactions.ts +0 -1613
  1269. package/resources/wire-drawdown-requests.ts +0 -206
  1270. package/resources/wire-transfers.ts +0 -444
  1271. package/streaming.ts +0 -201
  1272. package/uploads.ts +0 -81
  1273. package/version.ts +0 -1
  1274. /package/{dist/cjs/_shims → _shims}/agent.js +0 -0
  1275. /package/{dist/cjs/_shims → _shims}/agent.node.js +0 -0
  1276. /package/_shims/{formdata.node.ts → formdata.node.mjs} +0 -0
  1277. /package/{dist/esm/_shims → _shims}/getMultipartRequestOptions.d.ts +0 -0
  1278. /package/{dist/esm/_shims → _shims}/getMultipartRequestOptions.node.d.ts +0 -0
  1279. /package/{dist/esm/pagination.d.ts → pagination.d.ts} +0 -0
  1280. /package/{dist/esm/resource.d.ts → resource.d.ts} +0 -0
  1281. /package/{dist/cjs/resource.js → resource.js} +0 -0
  1282. /package/{dist/esm/resources → resources}/entities/index.d.ts +0 -0
  1283. /package/{dist/cjs/resources → resources}/shared.js +0 -0
  1284. /package/{pagination.ts → src/pagination.ts} +0 -0
  1285. /package/{resource.ts → src/resource.ts} +0 -0
  1286. /package/{resources → src/resources}/entities/index.ts +0 -0
@@ -0,0 +1,2826 @@
1
+ // File generated from our OpenAPI spec by Stainless.
2
+
3
+ import * as Core from '../../core';
4
+ import { APIResource } from '../../resource';
5
+ import * as ACHTransfers_ from '../ach-transfers';
6
+ import * as Shared from '../shared';
7
+ import * as API from '.';
8
+
9
+ export class ACHTransfers extends APIResource {
10
+ /**
11
+ * Simulates an inbound ACH transfer to your account. This imitates initiating a
12
+ * transaction to an Increase account from a different financial institution. The
13
+ * transfer may be either a credit or a debit depending on if the `amount` is
14
+ * positive or negative. The result of calling this API will be either a
15
+ * [Transaction](#transactions) or a [Declined Transaction](#declined-transactions)
16
+ * depending on whether or not the transfer is allowed.
17
+ */
18
+ createInbound(
19
+ body: ACHTransferCreateInboundParams,
20
+ options?: Core.RequestOptions,
21
+ ): Promise<Core.APIResponse<ACHTransferSimulation>> {
22
+ return this.post('/simulations/inbound_ach_transfers', { body, ...options });
23
+ }
24
+
25
+ /**
26
+ * Simulates the return of an [ACH Transfer](#ach-transfers) by the Federal Reserve
27
+ * due to an error condition. This will also create a Transaction to account for
28
+ * the returned funds. This transfer must first have a `status` of `submitted`.
29
+ */
30
+ return(
31
+ achTransferId: string,
32
+ body: ACHTransferReturnParams,
33
+ options?: Core.RequestOptions,
34
+ ): Promise<Core.APIResponse<ACHTransfers_.ACHTransfer>> {
35
+ return this.post(`/simulations/ach_transfers/${achTransferId}/return`, { body, ...options });
36
+ }
37
+
38
+ /**
39
+ * Simulates the submission of an [ACH Transfer](#ach-transfers) to the Federal
40
+ * Reserve. This transfer must first have a `status` of `pending_approval` or
41
+ * `pending_submission`. In production, Increase submits ACH Transfers to the
42
+ * Federal Reserve three times per day on weekdays. Since sandbox ACH Transfers are
43
+ * not submitted to the Federal Reserve, this endpoint allows you to skip that
44
+ * delay and transition the ACH Transfer to a status of `submitted`.
45
+ */
46
+ submit(
47
+ achTransferId: string,
48
+ options?: Core.RequestOptions,
49
+ ): Promise<Core.APIResponse<ACHTransfers_.ACHTransfer>> {
50
+ return this.post(`/simulations/ach_transfers/${achTransferId}/submit`, options);
51
+ }
52
+ }
53
+
54
+ /**
55
+ * The results of an inbound ACH Transfer simulation.
56
+ */
57
+ export interface ACHTransferSimulation {
58
+ /**
59
+ * If the ACH Transfer attempt fails, this will contain the resulting
60
+ * [Declined Transaction](#declined-transactions) object. The Declined
61
+ * Transaction's `source` will be of `category: inbound_ach_transfer`.
62
+ */
63
+ declined_transaction: ACHTransferSimulation.DeclinedTransaction | null;
64
+
65
+ /**
66
+ * If the ACH Transfer attempt succeeds, this will contain the resulting
67
+ * [Transaction](#transactions) object. The Transaction's `source` will be of
68
+ * `category: inbound_ach_transfer`.
69
+ */
70
+ transaction: ACHTransferSimulation.Transaction | null;
71
+
72
+ /**
73
+ * A constant representing the object's type. For this resource it will always be
74
+ * `inbound_ach_transfer_simulation_result`.
75
+ */
76
+ type: 'inbound_ach_transfer_simulation_result';
77
+ }
78
+
79
+ export namespace ACHTransferSimulation {
80
+ /**
81
+ * If the ACH Transfer attempt fails, this will contain the resulting
82
+ * [Declined Transaction](#declined-transactions) object. The Declined
83
+ * Transaction's `source` will be of `category: inbound_ach_transfer`.
84
+ */
85
+ export interface DeclinedTransaction {
86
+ /**
87
+ * The Declined Transaction identifier.
88
+ */
89
+ id: string;
90
+
91
+ /**
92
+ * The identifier for the Account the Declined Transaction belongs to.
93
+ */
94
+ account_id: string;
95
+
96
+ /**
97
+ * The Declined Transaction amount in the minor unit of its currency. For dollars,
98
+ * for example, this is cents.
99
+ */
100
+ amount: number;
101
+
102
+ /**
103
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
104
+ * Transaction occured.
105
+ */
106
+ created_at: string;
107
+
108
+ /**
109
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
110
+ * Transaction's currency. This will match the currency on the Declined
111
+ * Transcation's Account.
112
+ *
113
+ * - `CAD` - Canadian Dollar (CAD)
114
+ * - `CHF` - Swiss Franc (CHF)
115
+ * - `EUR` - Euro (EUR)
116
+ * - `GBP` - British Pound (GBP)
117
+ * - `JPY` - Japanese Yen (JPY)
118
+ * - `USD` - US Dollar (USD)
119
+ */
120
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
121
+
122
+ /**
123
+ * This is the description the vendor provides.
124
+ */
125
+ description: string;
126
+
127
+ /**
128
+ * The identifier for the route this Declined Transaction came through. Routes are
129
+ * things like cards and ACH details.
130
+ */
131
+ route_id: string | null;
132
+
133
+ /**
134
+ * The type of the route this Declined Transaction came through.
135
+ *
136
+ * - `account_number` - An Account Number.
137
+ * - `card` - A Card.
138
+ */
139
+ route_type: 'account_number' | 'card' | null;
140
+
141
+ /**
142
+ * This is an object giving more details on the network-level event that caused the
143
+ * Declined Transaction. For example, for a card transaction this lists the
144
+ * merchant's industry and location. Note that for backwards compatibility reasons,
145
+ * additional undocumented keys may appear in this object. These should be treated
146
+ * as deprecated and will be removed in the future.
147
+ */
148
+ source: DeclinedTransaction.Source;
149
+
150
+ /**
151
+ * A constant representing the object's type. For this resource it will always be
152
+ * `declined_transaction`.
153
+ */
154
+ type: 'declined_transaction';
155
+ }
156
+
157
+ export namespace DeclinedTransaction {
158
+ /**
159
+ * This is an object giving more details on the network-level event that caused the
160
+ * Declined Transaction. For example, for a card transaction this lists the
161
+ * merchant's industry and location. Note that for backwards compatibility reasons,
162
+ * additional undocumented keys may appear in this object. These should be treated
163
+ * as deprecated and will be removed in the future.
164
+ */
165
+ export interface Source {
166
+ /**
167
+ * A ACH Decline object. This field will be present in the JSON response if and
168
+ * only if `category` is equal to `ach_decline`.
169
+ */
170
+ ach_decline: Source.ACHDecline | null;
171
+
172
+ /**
173
+ * A Card Decline object. This field will be present in the JSON response if and
174
+ * only if `category` is equal to `card_decline`.
175
+ */
176
+ card_decline: Source.CardDecline | null;
177
+
178
+ /**
179
+ * The type of decline that took place. We may add additional possible values for
180
+ * this enum over time; your application should be able to handle such additions
181
+ * gracefully.
182
+ *
183
+ * - `ach_decline` - The Declined Transaction was created by a ACH Decline object.
184
+ * Details will be under the `ach_decline` object.
185
+ * - `card_decline` - The Declined Transaction was created by a Card Decline
186
+ * object. Details will be under the `card_decline` object.
187
+ * - `check_decline` - The Declined Transaction was created by a Check Decline
188
+ * object. Details will be under the `check_decline` object.
189
+ * - `inbound_real_time_payments_transfer_decline` - The Declined Transaction was
190
+ * created by a Inbound Real Time Payments Transfer Decline object. Details will
191
+ * be under the `inbound_real_time_payments_transfer_decline` object.
192
+ * - `international_ach_decline` - The Declined Transaction was created by a
193
+ * International ACH Decline object. Details will be under the
194
+ * `international_ach_decline` object.
195
+ * - `wire_decline` - The Declined Transaction was created by a Wire Decline
196
+ * object. Details will be under the `wire_decline` object.
197
+ * - `other` - The Declined Transaction was made for an undocumented or deprecated
198
+ * reason.
199
+ */
200
+ category:
201
+ | 'ach_decline'
202
+ | 'card_decline'
203
+ | 'check_decline'
204
+ | 'inbound_real_time_payments_transfer_decline'
205
+ | 'international_ach_decline'
206
+ | 'wire_decline'
207
+ | 'other';
208
+
209
+ /**
210
+ * A Check Decline object. This field will be present in the JSON response if and
211
+ * only if `category` is equal to `check_decline`.
212
+ */
213
+ check_decline: Source.CheckDecline | null;
214
+
215
+ /**
216
+ * A Inbound Real Time Payments Transfer Decline object. This field will be present
217
+ * in the JSON response if and only if `category` is equal to
218
+ * `inbound_real_time_payments_transfer_decline`.
219
+ */
220
+ inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
221
+
222
+ /**
223
+ * A International ACH Decline object. This field will be present in the JSON
224
+ * response if and only if `category` is equal to `international_ach_decline`.
225
+ */
226
+ international_ach_decline: Source.InternationalACHDecline | null;
227
+
228
+ /**
229
+ * A Wire Decline object. This field will be present in the JSON response if and
230
+ * only if `category` is equal to `wire_decline`.
231
+ */
232
+ wire_decline: Source.WireDecline | null;
233
+ }
234
+
235
+ export namespace Source {
236
+ /**
237
+ * A ACH Decline object. This field will be present in the JSON response if and
238
+ * only if `category` is equal to `ach_decline`.
239
+ */
240
+ export interface ACHDecline {
241
+ /**
242
+ * The declined amount in the minor unit of the destination account currency. For
243
+ * dollars, for example, this is cents.
244
+ */
245
+ amount: number;
246
+
247
+ originator_company_descriptive_date: string | null;
248
+
249
+ originator_company_discretionary_data: string | null;
250
+
251
+ originator_company_id: string;
252
+
253
+ originator_company_name: string;
254
+
255
+ /**
256
+ * Why the ACH transfer was declined.
257
+ *
258
+ * - `ach_route_canceled` - The account number is canceled.
259
+ * - `ach_route_disabled` - The account number is disabled.
260
+ * - `breaches_limit` - The transaction would cause a limit to be exceeded.
261
+ * - `credit_entry_refused_by_receiver` - A credit was refused.
262
+ * - `duplicate_return` - Other.
263
+ * - `entity_not_active` - The account's entity is not active.
264
+ * - `group_locked` - Your account is inactive.
265
+ * - `insufficient_funds` - Your account contains insufficient funds.
266
+ * - `misrouted_return` - Other.
267
+ * - `no_ach_route` - The account number that was debited does not exist.
268
+ * - `originator_request` - Other.
269
+ * - `transaction_not_allowed` - The transaction is not allowed per Increase's
270
+ * terms.
271
+ */
272
+ reason:
273
+ | 'ach_route_canceled'
274
+ | 'ach_route_disabled'
275
+ | 'breaches_limit'
276
+ | 'credit_entry_refused_by_receiver'
277
+ | 'duplicate_return'
278
+ | 'entity_not_active'
279
+ | 'group_locked'
280
+ | 'insufficient_funds'
281
+ | 'misrouted_return'
282
+ | 'no_ach_route'
283
+ | 'originator_request'
284
+ | 'transaction_not_allowed';
285
+
286
+ receiver_id_number: string | null;
287
+
288
+ receiver_name: string | null;
289
+
290
+ trace_number: string;
291
+ }
292
+
293
+ /**
294
+ * A Card Decline object. This field will be present in the JSON response if and
295
+ * only if `category` is equal to `card_decline`.
296
+ */
297
+ export interface CardDecline {
298
+ /**
299
+ * The declined amount in the minor unit of the destination account currency. For
300
+ * dollars, for example, this is cents.
301
+ */
302
+ amount: number;
303
+
304
+ /**
305
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
306
+ * account currency.
307
+ *
308
+ * - `CAD` - Canadian Dollar (CAD)
309
+ * - `CHF` - Swiss Franc (CHF)
310
+ * - `EUR` - Euro (EUR)
311
+ * - `GBP` - British Pound (GBP)
312
+ * - `JPY` - Japanese Yen (JPY)
313
+ * - `USD` - US Dollar (USD)
314
+ */
315
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
316
+
317
+ /**
318
+ * If the authorization was attempted using a Digital Wallet Token (such as an
319
+ * Apple Pay purchase), the identifier of the token that was used.
320
+ */
321
+ digital_wallet_token_id: string | null;
322
+
323
+ /**
324
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
325
+ * is transacting with.
326
+ */
327
+ merchant_acceptor_id: string;
328
+
329
+ /**
330
+ * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
331
+ * card is transacting with.
332
+ */
333
+ merchant_category_code: string | null;
334
+
335
+ /**
336
+ * The city the merchant resides in.
337
+ */
338
+ merchant_city: string | null;
339
+
340
+ /**
341
+ * The country the merchant resides in.
342
+ */
343
+ merchant_country: string | null;
344
+
345
+ /**
346
+ * The merchant descriptor of the merchant the card is transacting with.
347
+ */
348
+ merchant_descriptor: string;
349
+
350
+ /**
351
+ * The state the merchant resides in.
352
+ */
353
+ merchant_state: string | null;
354
+
355
+ /**
356
+ * The payment network used to process this card authorization
357
+ *
358
+ * - `visa` - Visa
359
+ */
360
+ network: 'visa';
361
+
362
+ /**
363
+ * Fields specific to the `network`
364
+ */
365
+ network_details: CardDecline.NetworkDetails;
366
+
367
+ /**
368
+ * The identifier of the Real-Time Decision sent to approve or decline this
369
+ * transaction.
370
+ */
371
+ real_time_decision_id: string | null;
372
+
373
+ /**
374
+ * Why the transaction was declined.
375
+ *
376
+ * - `card_not_active` - The Card was not active.
377
+ * - `entity_not_active` - The account's entity was not active.
378
+ * - `group_locked` - The account was inactive.
379
+ * - `insufficient_funds` - The Card's Account did not have a sufficient available
380
+ * balance.
381
+ * - `cvv2_mismatch` - The given CVV2 did not match the card's value.
382
+ * - `transaction_not_allowed` - The attempted card transaction is not allowed per
383
+ * Increase's terms.
384
+ * - `breaches_internal_limit` - The transaction was blocked by an internal limit
385
+ * for new Increase accounts.
386
+ * - `breaches_limit` - The transaction was blocked by a Limit.
387
+ * - `webhook_declined` - Your application declined the transaction via webhook.
388
+ * - `webhook_timed_out` - Your application webhook did not respond without the
389
+ * required timeout.
390
+ * - `declined_by_stand_in_processing` - Declined by stand-in processing.
391
+ * - `invalid_physical_card` - The card read had an invalid CVV, dCVV, or
392
+ * authorization request cryptogram.
393
+ * - `missing_original_authorization` - The original card authorization for this
394
+ * incremental authorization does not exist.
395
+ */
396
+ reason:
397
+ | 'card_not_active'
398
+ | 'entity_not_active'
399
+ | 'group_locked'
400
+ | 'insufficient_funds'
401
+ | 'cvv2_mismatch'
402
+ | 'transaction_not_allowed'
403
+ | 'breaches_internal_limit'
404
+ | 'breaches_limit'
405
+ | 'webhook_declined'
406
+ | 'webhook_timed_out'
407
+ | 'declined_by_stand_in_processing'
408
+ | 'invalid_physical_card'
409
+ | 'missing_original_authorization';
410
+ }
411
+
412
+ export namespace CardDecline {
413
+ /**
414
+ * Fields specific to the `network`
415
+ */
416
+ export interface NetworkDetails {
417
+ /**
418
+ * Fields specific to the `visa` network
419
+ */
420
+ visa: NetworkDetails.Visa;
421
+ }
422
+
423
+ export namespace NetworkDetails {
424
+ /**
425
+ * Fields specific to the `visa` network
426
+ */
427
+ export interface Visa {
428
+ /**
429
+ * For electronic commerce transactions, this identifies the level of security used
430
+ * in obtaining the customer's payment credential. For mail or telephone order
431
+ * transactions, identifies the type of mail or telephone order.
432
+ *
433
+ * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
434
+ * that the transaction is a mail/phone order purchase, not a recurring
435
+ * transaction or installment payment. For domestic transactions in the US
436
+ * region, this value may also indicate one bill payment transaction in the
437
+ * card-present or card-absent environments.
438
+ * - `recurring` - Recurring transaction: Payment indicator used to indicate a
439
+ * recurring transaction that originates from an acquirer in the US region.
440
+ * - `installment` - Installment payment: Payment indicator used to indicate one
441
+ * purchase of goods or services that is billed to the account in multiple
442
+ * charges over a period of time agreed upon by the cardholder and merchant from
443
+ * transactions that originate from an acquirer in the US region.
444
+ * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
445
+ * indicate that the type of mail/telephone order is unknown.
446
+ * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
447
+ * indicate that the electronic commerce transaction has been authenticated using
448
+ * e.g., 3-D Secure
449
+ * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
450
+ * Non-authenticated security transaction at a 3-D Secure-capable merchant, and
451
+ * merchant attempted to authenticate the cardholder using 3-D Secure: Use to
452
+ * identify an electronic commerce transaction where the merchant attempted to
453
+ * authenticate the cardholder using 3-D Secure, but was unable to complete the
454
+ * authentication because the issuer or cardholder does not participate in the
455
+ * 3-D Secure program.
456
+ * - `non_authenticated_security_transaction` - Non-authenticated security
457
+ * transaction: Use to identify an electronic commerce transaction that uses data
458
+ * encryption for security however , cardholder authentication is not performed
459
+ * using 3-D Secure.
460
+ * - `non_secure_transaction` - Non-secure transaction: Use to identify an
461
+ * electronic commerce transaction that has no data protection.
462
+ */
463
+ electronic_commerce_indicator:
464
+ | 'mail_phone_order'
465
+ | 'recurring'
466
+ | 'installment'
467
+ | 'unknown_mail_phone_order'
468
+ | 'secure_electronic_commerce'
469
+ | 'non_authenticated_security_transaction_at_3ds_capable_merchant'
470
+ | 'non_authenticated_security_transaction'
471
+ | 'non_secure_transaction'
472
+ | null;
473
+
474
+ /**
475
+ * The method used to enter the cardholder's primary account number and card
476
+ * expiration date
477
+ */
478
+ point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
479
+ }
480
+ }
481
+ }
482
+
483
+ /**
484
+ * A Check Decline object. This field will be present in the JSON response if and
485
+ * only if `category` is equal to `check_decline`.
486
+ */
487
+ export interface CheckDecline {
488
+ /**
489
+ * The declined amount in the minor unit of the destination account currency. For
490
+ * dollars, for example, this is cents.
491
+ */
492
+ amount: number;
493
+
494
+ auxiliary_on_us: string | null;
495
+
496
+ /**
497
+ * Why the check was declined.
498
+ *
499
+ * - `ach_route_canceled` - The account number is canceled.
500
+ * - `ach_route_disabled` - The account number is disabled.
501
+ * - `breaches_limit` - The transaction would cause a limit to be exceeded.
502
+ * - `entity_not_active` - The account's entity is not active.
503
+ * - `group_locked` - Your account is inactive.
504
+ * - `insufficient_funds` - Your account contains insufficient funds.
505
+ * - `unable_to_locate_account` - Unable to locate account.
506
+ * - `not_our_item` - Routing number on the check is not ours.
507
+ * - `unable_to_process` - Unable to process.
508
+ * - `refer_to_image` - Refer to image.
509
+ * - `stop_payment_requested` - Stop payment requested for this check.
510
+ * - `returned` - Check was returned to sender.
511
+ * - `duplicate_presentment` - The check was a duplicate deposit.
512
+ * - `not_authorized` - The transaction is not allowed.
513
+ * - `altered_or_fictitious` - The check was altered or fictitious.
514
+ */
515
+ reason:
516
+ | 'ach_route_canceled'
517
+ | 'ach_route_disabled'
518
+ | 'breaches_limit'
519
+ | 'entity_not_active'
520
+ | 'group_locked'
521
+ | 'insufficient_funds'
522
+ | 'unable_to_locate_account'
523
+ | 'not_our_item'
524
+ | 'unable_to_process'
525
+ | 'refer_to_image'
526
+ | 'stop_payment_requested'
527
+ | 'returned'
528
+ | 'duplicate_presentment'
529
+ | 'not_authorized'
530
+ | 'altered_or_fictitious';
531
+ }
532
+
533
+ /**
534
+ * A Inbound Real Time Payments Transfer Decline object. This field will be present
535
+ * in the JSON response if and only if `category` is equal to
536
+ * `inbound_real_time_payments_transfer_decline`.
537
+ */
538
+ export interface InboundRealTimePaymentsTransferDecline {
539
+ /**
540
+ * The declined amount in the minor unit of the destination account currency. For
541
+ * dollars, for example, this is cents.
542
+ */
543
+ amount: number;
544
+
545
+ /**
546
+ * The name the sender of the transfer specified as the recipient of the transfer.
547
+ */
548
+ creditor_name: string;
549
+
550
+ /**
551
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
552
+ * transfer's currency. This will always be "USD" for a Real Time Payments
553
+ * transfer.
554
+ *
555
+ * - `CAD` - Canadian Dollar (CAD)
556
+ * - `CHF` - Swiss Franc (CHF)
557
+ * - `EUR` - Euro (EUR)
558
+ * - `GBP` - British Pound (GBP)
559
+ * - `JPY` - Japanese Yen (JPY)
560
+ * - `USD` - US Dollar (USD)
561
+ */
562
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
563
+
564
+ /**
565
+ * The account number of the account that sent the transfer.
566
+ */
567
+ debtor_account_number: string;
568
+
569
+ /**
570
+ * The name provided by the sender of the transfer.
571
+ */
572
+ debtor_name: string;
573
+
574
+ /**
575
+ * The routing number of the account that sent the transfer.
576
+ */
577
+ debtor_routing_number: string;
578
+
579
+ /**
580
+ * Why the transfer was declined.
581
+ *
582
+ * - `account_number_canceled` - The account number is canceled.
583
+ * - `account_number_disabled` - The account number is disabled.
584
+ * - `account_restricted` - Your account is restricted.
585
+ * - `group_locked` - Your account is inactive.
586
+ * - `entity_not_active` - The account's entity is not active.
587
+ * - `real_time_payments_not_enabled` - Your account is not enabled to receive Real
588
+ * Time Payments transfers.
589
+ */
590
+ reason:
591
+ | 'account_number_canceled'
592
+ | 'account_number_disabled'
593
+ | 'account_restricted'
594
+ | 'group_locked'
595
+ | 'entity_not_active'
596
+ | 'real_time_payments_not_enabled';
597
+
598
+ /**
599
+ * Additional information included with the transfer.
600
+ */
601
+ remittance_information: string | null;
602
+
603
+ /**
604
+ * The Real Time Payments network identification of the declined transfer.
605
+ */
606
+ transaction_identification: string;
607
+ }
608
+
609
+ /**
610
+ * A International ACH Decline object. This field will be present in the JSON
611
+ * response if and only if `category` is equal to `international_ach_decline`.
612
+ */
613
+ export interface InternationalACHDecline {
614
+ /**
615
+ * The declined amount in the minor unit of the destination account currency. For
616
+ * dollars, for example, this is cents.
617
+ */
618
+ amount: number;
619
+
620
+ destination_country_code: string;
621
+
622
+ destination_currency_code: string;
623
+
624
+ foreign_exchange_indicator: string;
625
+
626
+ foreign_exchange_reference: string | null;
627
+
628
+ foreign_exchange_reference_indicator: string;
629
+
630
+ foreign_payment_amount: number;
631
+
632
+ foreign_trace_number: string | null;
633
+
634
+ international_transaction_type_code: string;
635
+
636
+ originating_currency_code: string;
637
+
638
+ originating_depository_financial_institution_branch_country: string;
639
+
640
+ originating_depository_financial_institution_id: string;
641
+
642
+ originating_depository_financial_institution_id_qualifier: string;
643
+
644
+ originating_depository_financial_institution_name: string;
645
+
646
+ originator_city: string;
647
+
648
+ originator_company_entry_description: string;
649
+
650
+ originator_country: string;
651
+
652
+ originator_identification: string;
653
+
654
+ originator_name: string;
655
+
656
+ originator_postal_code: string | null;
657
+
658
+ originator_state_or_province: string | null;
659
+
660
+ originator_street_address: string;
661
+
662
+ payment_related_information: string | null;
663
+
664
+ payment_related_information2: string | null;
665
+
666
+ receiver_city: string;
667
+
668
+ receiver_country: string;
669
+
670
+ receiver_identification_number: string | null;
671
+
672
+ receiver_postal_code: string | null;
673
+
674
+ receiver_state_or_province: string | null;
675
+
676
+ receiver_street_address: string;
677
+
678
+ receiving_company_or_individual_name: string;
679
+
680
+ receiving_depository_financial_institution_country: string;
681
+
682
+ receiving_depository_financial_institution_id: string;
683
+
684
+ receiving_depository_financial_institution_id_qualifier: string;
685
+
686
+ receiving_depository_financial_institution_name: string;
687
+
688
+ trace_number: string;
689
+ }
690
+
691
+ /**
692
+ * A Wire Decline object. This field will be present in the JSON response if and
693
+ * only if `category` is equal to `wire_decline`.
694
+ */
695
+ export interface WireDecline {
696
+ /**
697
+ * The declined amount in the minor unit of the destination account currency. For
698
+ * dollars, for example, this is cents.
699
+ */
700
+ amount: number;
701
+
702
+ beneficiary_address_line1: string | null;
703
+
704
+ beneficiary_address_line2: string | null;
705
+
706
+ beneficiary_address_line3: string | null;
707
+
708
+ beneficiary_name: string | null;
709
+
710
+ beneficiary_reference: string | null;
711
+
712
+ description: string;
713
+
714
+ input_message_accountability_data: string | null;
715
+
716
+ originator_address_line1: string | null;
717
+
718
+ originator_address_line2: string | null;
719
+
720
+ originator_address_line3: string | null;
721
+
722
+ originator_name: string | null;
723
+
724
+ originator_to_beneficiary_information_line1: string | null;
725
+
726
+ originator_to_beneficiary_information_line2: string | null;
727
+
728
+ originator_to_beneficiary_information_line3: string | null;
729
+
730
+ originator_to_beneficiary_information_line4: string | null;
731
+
732
+ /**
733
+ * Why the wire transfer was declined.
734
+ *
735
+ * - `account_number_canceled` - The account number is canceled.
736
+ * - `account_number_disabled` - The account number is disabled.
737
+ * - `entity_not_active` - The account's entity is not active.
738
+ * - `group_locked` - Your account is inactive.
739
+ * - `no_account_number` - The beneficiary account number does not exist.
740
+ * - `transaction_not_allowed` - The transaction is not allowed per Increase's
741
+ * terms.
742
+ */
743
+ reason:
744
+ | 'account_number_canceled'
745
+ | 'account_number_disabled'
746
+ | 'entity_not_active'
747
+ | 'group_locked'
748
+ | 'no_account_number'
749
+ | 'transaction_not_allowed';
750
+ }
751
+ }
752
+ }
753
+
754
+ /**
755
+ * If the ACH Transfer attempt succeeds, this will contain the resulting
756
+ * [Transaction](#transactions) object. The Transaction's `source` will be of
757
+ * `category: inbound_ach_transfer`.
758
+ */
759
+ export interface Transaction {
760
+ /**
761
+ * The Transaction identifier.
762
+ */
763
+ id: string;
764
+
765
+ /**
766
+ * The identifier for the Account the Transaction belongs to.
767
+ */
768
+ account_id: string;
769
+
770
+ /**
771
+ * The Transaction amount in the minor unit of its currency. For dollars, for
772
+ * example, this is cents.
773
+ */
774
+ amount: number;
775
+
776
+ /**
777
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
778
+ * Transaction occured.
779
+ */
780
+ created_at: string;
781
+
782
+ /**
783
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
784
+ * Transaction's currency. This will match the currency on the Transcation's
785
+ * Account.
786
+ *
787
+ * - `CAD` - Canadian Dollar (CAD)
788
+ * - `CHF` - Swiss Franc (CHF)
789
+ * - `EUR` - Euro (EUR)
790
+ * - `GBP` - British Pound (GBP)
791
+ * - `JPY` - Japanese Yen (JPY)
792
+ * - `USD` - US Dollar (USD)
793
+ */
794
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
795
+
796
+ /**
797
+ * An informational message describing this transaction. Use the fields in `source`
798
+ * to get more detailed information. This field appears as the line-item on the
799
+ * statement.
800
+ */
801
+ description: string;
802
+
803
+ /**
804
+ * The identifier for the route this Transaction came through. Routes are things
805
+ * like cards and ACH details.
806
+ */
807
+ route_id: string | null;
808
+
809
+ /**
810
+ * The type of the route this Transaction came through.
811
+ *
812
+ * - `account_number` - An Account Number.
813
+ * - `card` - A Card.
814
+ */
815
+ route_type: 'account_number' | 'card' | null;
816
+
817
+ /**
818
+ * This is an object giving more details on the network-level event that caused the
819
+ * Transaction. Note that for backwards compatibility reasons, additional
820
+ * undocumented keys may appear in this object. These should be treated as
821
+ * deprecated and will be removed in the future.
822
+ */
823
+ source: Transaction.Source;
824
+
825
+ /**
826
+ * A constant representing the object's type. For this resource it will always be
827
+ * `transaction`.
828
+ */
829
+ type: 'transaction';
830
+ }
831
+
832
+ export namespace Transaction {
833
+ /**
834
+ * This is an object giving more details on the network-level event that caused the
835
+ * Transaction. Note that for backwards compatibility reasons, additional
836
+ * undocumented keys may appear in this object. These should be treated as
837
+ * deprecated and will be removed in the future.
838
+ */
839
+ export interface Source {
840
+ /**
841
+ * A Account Transfer Intention object. This field will be present in the JSON
842
+ * response if and only if `category` is equal to `account_transfer_intention`.
843
+ */
844
+ account_transfer_intention: Source.AccountTransferIntention | null;
845
+
846
+ /**
847
+ * A ACH Transfer Intention object. This field will be present in the JSON response
848
+ * if and only if `category` is equal to `ach_transfer_intention`.
849
+ */
850
+ ach_transfer_intention: Source.ACHTransferIntention | null;
851
+
852
+ /**
853
+ * A ACH Transfer Rejection object. This field will be present in the JSON response
854
+ * if and only if `category` is equal to `ach_transfer_rejection`.
855
+ */
856
+ ach_transfer_rejection: Source.ACHTransferRejection | null;
857
+
858
+ /**
859
+ * A ACH Transfer Return object. This field will be present in the JSON response if
860
+ * and only if `category` is equal to `ach_transfer_return`.
861
+ */
862
+ ach_transfer_return: Source.ACHTransferReturn | null;
863
+
864
+ /**
865
+ * A Card Dispute Acceptance object. This field will be present in the JSON
866
+ * response if and only if `category` is equal to `card_dispute_acceptance`.
867
+ */
868
+ card_dispute_acceptance: Source.CardDisputeAcceptance | null;
869
+
870
+ /**
871
+ * A Card Refund object. This field will be present in the JSON response if and
872
+ * only if `category` is equal to `card_refund`.
873
+ */
874
+ card_refund: Source.CardRefund | null;
875
+
876
+ /**
877
+ * A Card Revenue Payment object. This field will be present in the JSON response
878
+ * if and only if `category` is equal to `card_revenue_payment`.
879
+ */
880
+ card_revenue_payment: Source.CardRevenuePayment | null;
881
+
882
+ /**
883
+ * A Card Settlement object. This field will be present in the JSON response if and
884
+ * only if `category` is equal to `card_settlement`.
885
+ */
886
+ card_settlement: Source.CardSettlement | null;
887
+
888
+ /**
889
+ * The type of transaction that took place. We may add additional possible values
890
+ * for this enum over time; your application should be able to handle such
891
+ * additions gracefully.
892
+ *
893
+ * - `account_transfer_intention` - The Transaction was created by a Account
894
+ * Transfer Intention object. Details will be under the
895
+ * `account_transfer_intention` object.
896
+ * - `ach_transfer_intention` - The Transaction was created by a ACH Transfer
897
+ * Intention object. Details will be under the `ach_transfer_intention` object.
898
+ * - `ach_transfer_rejection` - The Transaction was created by a ACH Transfer
899
+ * Rejection object. Details will be under the `ach_transfer_rejection` object.
900
+ * - `ach_transfer_return` - The Transaction was created by a ACH Transfer Return
901
+ * object. Details will be under the `ach_transfer_return` object.
902
+ * - `card_dispute_acceptance` - The Transaction was created by a Card Dispute
903
+ * Acceptance object. Details will be under the `card_dispute_acceptance` object.
904
+ * - `card_refund` - The Transaction was created by a Card Refund object. Details
905
+ * will be under the `card_refund` object.
906
+ * - `card_revenue_payment` - The Transaction was created by a Card Revenue Payment
907
+ * object. Details will be under the `card_revenue_payment` object.
908
+ * - `card_settlement` - The Transaction was created by a Card Settlement object.
909
+ * Details will be under the `card_settlement` object.
910
+ * - `check_deposit_acceptance` - The Transaction was created by a Check Deposit
911
+ * Acceptance object. Details will be under the `check_deposit_acceptance`
912
+ * object.
913
+ * - `check_deposit_return` - The Transaction was created by a Check Deposit Return
914
+ * object. Details will be under the `check_deposit_return` object.
915
+ * - `check_transfer_deposit` - The Transaction was created by a Check Transfer
916
+ * Deposit object. Details will be under the `check_transfer_deposit` object.
917
+ * - `check_transfer_intention` - The Transaction was created by a Check Transfer
918
+ * Intention object. Details will be under the `check_transfer_intention` object.
919
+ * - `check_transfer_rejection` - The Transaction was created by a Check Transfer
920
+ * Rejection object. Details will be under the `check_transfer_rejection` object.
921
+ * - `check_transfer_stop_payment_request` - The Transaction was created by a Check
922
+ * Transfer Stop Payment Request object. Details will be under the
923
+ * `check_transfer_stop_payment_request` object.
924
+ * - `fee_payment` - The Transaction was created by a Fee Payment object. Details
925
+ * will be under the `fee_payment` object.
926
+ * - `inbound_ach_transfer` - The Transaction was created by a Inbound ACH Transfer
927
+ * object. Details will be under the `inbound_ach_transfer` object.
928
+ * - `inbound_ach_transfer_return_intention` - The Transaction was created by a
929
+ * Inbound ACH Transfer Return Intention object. Details will be under the
930
+ * `inbound_ach_transfer_return_intention` object.
931
+ * - `inbound_check` - The Transaction was created by a Inbound Check object.
932
+ * Details will be under the `inbound_check` object.
933
+ * - `inbound_international_ach_transfer` - The Transaction was created by a
934
+ * Inbound International ACH Transfer object. Details will be under the
935
+ * `inbound_international_ach_transfer` object.
936
+ * - `inbound_real_time_payments_transfer_confirmation` - The Transaction was
937
+ * created by a Inbound Real Time Payments Transfer Confirmation object. Details
938
+ * will be under the `inbound_real_time_payments_transfer_confirmation` object.
939
+ * - `inbound_wire_drawdown_payment` - The Transaction was created by a Inbound
940
+ * Wire Drawdown Payment object. Details will be under the
941
+ * `inbound_wire_drawdown_payment` object.
942
+ * - `inbound_wire_drawdown_payment_reversal` - The Transaction was created by a
943
+ * Inbound Wire Drawdown Payment Reversal object. Details will be under the
944
+ * `inbound_wire_drawdown_payment_reversal` object.
945
+ * - `inbound_wire_reversal` - The Transaction was created by a Inbound Wire
946
+ * Reversal object. Details will be under the `inbound_wire_reversal` object.
947
+ * - `inbound_wire_transfer` - The Transaction was created by a Inbound Wire
948
+ * Transfer object. Details will be under the `inbound_wire_transfer` object.
949
+ * - `interest_payment` - The Transaction was created by a Interest Payment object.
950
+ * Details will be under the `interest_payment` object.
951
+ * - `internal_source` - The Transaction was created by a Internal Source object.
952
+ * Details will be under the `internal_source` object.
953
+ * - `real_time_payments_transfer_acknowledgement` - The Transaction was created by
954
+ * a Real Time Payments Transfer Acknowledgement object. Details will be under
955
+ * the `real_time_payments_transfer_acknowledgement` object.
956
+ * - `sample_funds` - The Transaction was created by a Sample Funds object. Details
957
+ * will be under the `sample_funds` object.
958
+ * - `wire_transfer_intention` - The Transaction was created by a Wire Transfer
959
+ * Intention object. Details will be under the `wire_transfer_intention` object.
960
+ * - `wire_transfer_rejection` - The Transaction was created by a Wire Transfer
961
+ * Rejection object. Details will be under the `wire_transfer_rejection` object.
962
+ * - `other` - The Transaction was made for an undocumented or deprecated reason.
963
+ */
964
+ category:
965
+ | 'account_transfer_intention'
966
+ | 'ach_transfer_intention'
967
+ | 'ach_transfer_rejection'
968
+ | 'ach_transfer_return'
969
+ | 'card_dispute_acceptance'
970
+ | 'card_refund'
971
+ | 'card_revenue_payment'
972
+ | 'card_settlement'
973
+ | 'check_deposit_acceptance'
974
+ | 'check_deposit_return'
975
+ | 'check_transfer_deposit'
976
+ | 'check_transfer_intention'
977
+ | 'check_transfer_rejection'
978
+ | 'check_transfer_stop_payment_request'
979
+ | 'fee_payment'
980
+ | 'inbound_ach_transfer'
981
+ | 'inbound_ach_transfer_return_intention'
982
+ | 'inbound_check'
983
+ | 'inbound_international_ach_transfer'
984
+ | 'inbound_real_time_payments_transfer_confirmation'
985
+ | 'inbound_wire_drawdown_payment'
986
+ | 'inbound_wire_drawdown_payment_reversal'
987
+ | 'inbound_wire_reversal'
988
+ | 'inbound_wire_transfer'
989
+ | 'interest_payment'
990
+ | 'internal_source'
991
+ | 'real_time_payments_transfer_acknowledgement'
992
+ | 'sample_funds'
993
+ | 'wire_transfer_intention'
994
+ | 'wire_transfer_rejection'
995
+ | 'other';
996
+
997
+ /**
998
+ * A Check Deposit Acceptance object. This field will be present in the JSON
999
+ * response if and only if `category` is equal to `check_deposit_acceptance`.
1000
+ */
1001
+ check_deposit_acceptance: Source.CheckDepositAcceptance | null;
1002
+
1003
+ /**
1004
+ * A Check Deposit Return object. This field will be present in the JSON response
1005
+ * if and only if `category` is equal to `check_deposit_return`.
1006
+ */
1007
+ check_deposit_return: Source.CheckDepositReturn | null;
1008
+
1009
+ /**
1010
+ * A Check Transfer Deposit object. This field will be present in the JSON response
1011
+ * if and only if `category` is equal to `check_transfer_deposit`.
1012
+ */
1013
+ check_transfer_deposit: Source.CheckTransferDeposit | null;
1014
+
1015
+ /**
1016
+ * A Check Transfer Intention object. This field will be present in the JSON
1017
+ * response if and only if `category` is equal to `check_transfer_intention`.
1018
+ */
1019
+ check_transfer_intention: Source.CheckTransferIntention | null;
1020
+
1021
+ /**
1022
+ * A Check Transfer Rejection object. This field will be present in the JSON
1023
+ * response if and only if `category` is equal to `check_transfer_rejection`.
1024
+ */
1025
+ check_transfer_rejection: Source.CheckTransferRejection | null;
1026
+
1027
+ /**
1028
+ * A Check Transfer Stop Payment Request object. This field will be present in the
1029
+ * JSON response if and only if `category` is equal to
1030
+ * `check_transfer_stop_payment_request`.
1031
+ */
1032
+ check_transfer_stop_payment_request: Source.CheckTransferStopPaymentRequest | null;
1033
+
1034
+ /**
1035
+ * A Fee Payment object. This field will be present in the JSON response if and
1036
+ * only if `category` is equal to `fee_payment`.
1037
+ */
1038
+ fee_payment: Source.FeePayment | null;
1039
+
1040
+ /**
1041
+ * A Inbound ACH Transfer object. This field will be present in the JSON response
1042
+ * if and only if `category` is equal to `inbound_ach_transfer`.
1043
+ */
1044
+ inbound_ach_transfer: Source.InboundACHTransfer | null;
1045
+
1046
+ /**
1047
+ * A Inbound Check object. This field will be present in the JSON response if and
1048
+ * only if `category` is equal to `inbound_check`.
1049
+ */
1050
+ inbound_check: Source.InboundCheck | null;
1051
+
1052
+ /**
1053
+ * A Inbound International ACH Transfer object. This field will be present in the
1054
+ * JSON response if and only if `category` is equal to
1055
+ * `inbound_international_ach_transfer`.
1056
+ */
1057
+ inbound_international_ach_transfer: Source.InboundInternationalACHTransfer | null;
1058
+
1059
+ /**
1060
+ * A Inbound Real Time Payments Transfer Confirmation object. This field will be
1061
+ * present in the JSON response if and only if `category` is equal to
1062
+ * `inbound_real_time_payments_transfer_confirmation`.
1063
+ */
1064
+ inbound_real_time_payments_transfer_confirmation: Source.InboundRealTimePaymentsTransferConfirmation | null;
1065
+
1066
+ /**
1067
+ * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
1068
+ * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
1069
+ */
1070
+ inbound_wire_drawdown_payment: Source.InboundWireDrawdownPayment | null;
1071
+
1072
+ /**
1073
+ * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
1074
+ * the JSON response if and only if `category` is equal to
1075
+ * `inbound_wire_drawdown_payment_reversal`.
1076
+ */
1077
+ inbound_wire_drawdown_payment_reversal: Source.InboundWireDrawdownPaymentReversal | null;
1078
+
1079
+ /**
1080
+ * A Inbound Wire Reversal object. This field will be present in the JSON response
1081
+ * if and only if `category` is equal to `inbound_wire_reversal`.
1082
+ */
1083
+ inbound_wire_reversal: Source.InboundWireReversal | null;
1084
+
1085
+ /**
1086
+ * A Inbound Wire Transfer object. This field will be present in the JSON response
1087
+ * if and only if `category` is equal to `inbound_wire_transfer`.
1088
+ */
1089
+ inbound_wire_transfer: Source.InboundWireTransfer | null;
1090
+
1091
+ /**
1092
+ * A Interest Payment object. This field will be present in the JSON response if
1093
+ * and only if `category` is equal to `interest_payment`.
1094
+ */
1095
+ interest_payment: Source.InterestPayment | null;
1096
+
1097
+ /**
1098
+ * A Internal Source object. This field will be present in the JSON response if and
1099
+ * only if `category` is equal to `internal_source`.
1100
+ */
1101
+ internal_source: Source.InternalSource | null;
1102
+
1103
+ /**
1104
+ * A Real Time Payments Transfer Acknowledgement object. This field will be present
1105
+ * in the JSON response if and only if `category` is equal to
1106
+ * `real_time_payments_transfer_acknowledgement`.
1107
+ */
1108
+ real_time_payments_transfer_acknowledgement: Source.RealTimePaymentsTransferAcknowledgement | null;
1109
+
1110
+ /**
1111
+ * A Sample Funds object. This field will be present in the JSON response if and
1112
+ * only if `category` is equal to `sample_funds`.
1113
+ */
1114
+ sample_funds: Source.SampleFunds | null;
1115
+
1116
+ /**
1117
+ * A Wire Transfer Intention object. This field will be present in the JSON
1118
+ * response if and only if `category` is equal to `wire_transfer_intention`.
1119
+ */
1120
+ wire_transfer_intention: Source.WireTransferIntention | null;
1121
+
1122
+ /**
1123
+ * A Wire Transfer Rejection object. This field will be present in the JSON
1124
+ * response if and only if `category` is equal to `wire_transfer_rejection`.
1125
+ */
1126
+ wire_transfer_rejection: Source.WireTransferRejection | null;
1127
+ }
1128
+
1129
+ export namespace Source {
1130
+ /**
1131
+ * A Account Transfer Intention object. This field will be present in the JSON
1132
+ * response if and only if `category` is equal to `account_transfer_intention`.
1133
+ */
1134
+ export interface AccountTransferIntention {
1135
+ /**
1136
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
1137
+ * for example, this is cents.
1138
+ */
1139
+ amount: number;
1140
+
1141
+ /**
1142
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
1143
+ * account currency.
1144
+ *
1145
+ * - `CAD` - Canadian Dollar (CAD)
1146
+ * - `CHF` - Swiss Franc (CHF)
1147
+ * - `EUR` - Euro (EUR)
1148
+ * - `GBP` - British Pound (GBP)
1149
+ * - `JPY` - Japanese Yen (JPY)
1150
+ * - `USD` - US Dollar (USD)
1151
+ */
1152
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1153
+
1154
+ /**
1155
+ * The description you chose to give the transfer.
1156
+ */
1157
+ description: string;
1158
+
1159
+ /**
1160
+ * The identifier of the Account to where the Account Transfer was sent.
1161
+ */
1162
+ destination_account_id: string;
1163
+
1164
+ /**
1165
+ * The identifier of the Account from where the Account Transfer was sent.
1166
+ */
1167
+ source_account_id: string;
1168
+
1169
+ /**
1170
+ * The identifier of the Account Transfer that led to this Pending Transaction.
1171
+ */
1172
+ transfer_id: string;
1173
+ }
1174
+
1175
+ /**
1176
+ * A ACH Transfer Intention object. This field will be present in the JSON response
1177
+ * if and only if `category` is equal to `ach_transfer_intention`.
1178
+ */
1179
+ export interface ACHTransferIntention {
1180
+ account_number: string;
1181
+
1182
+ /**
1183
+ * The amount in the minor unit of the transaction's currency. For dollars, for
1184
+ * example, this is cents.
1185
+ */
1186
+ amount: number;
1187
+
1188
+ routing_number: string;
1189
+
1190
+ statement_descriptor: string;
1191
+
1192
+ /**
1193
+ * The identifier of the ACH Transfer that led to this Transaction.
1194
+ */
1195
+ transfer_id: string;
1196
+ }
1197
+
1198
+ /**
1199
+ * A ACH Transfer Rejection object. This field will be present in the JSON response
1200
+ * if and only if `category` is equal to `ach_transfer_rejection`.
1201
+ */
1202
+ export interface ACHTransferRejection {
1203
+ /**
1204
+ * The identifier of the ACH Transfer that led to this Transaction.
1205
+ */
1206
+ transfer_id: string;
1207
+ }
1208
+
1209
+ /**
1210
+ * A ACH Transfer Return object. This field will be present in the JSON response if
1211
+ * and only if `category` is equal to `ach_transfer_return`.
1212
+ */
1213
+ export interface ACHTransferReturn {
1214
+ /**
1215
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1216
+ * the transfer was created.
1217
+ */
1218
+ created_at: string;
1219
+
1220
+ /**
1221
+ * The three character ACH return code, in the range R01 to R85.
1222
+ */
1223
+ raw_return_reason_code: string;
1224
+
1225
+ /**
1226
+ * Why the ACH Transfer was returned.
1227
+ *
1228
+ * - `insufficient_fund` - Code R01. Insufficient funds in the source account.
1229
+ * - `no_account` - Code R03. The account does not exist or the receiving bank was
1230
+ * unable to locate it.
1231
+ * - `account_closed` - Code R02. The account is closed.
1232
+ * - `invalid_account_number_structure` - Code R04. The account number is invalid
1233
+ * at the receiving bank.
1234
+ * - `account_frozen_entry_returned_per_ofac_instruction` - Code R16. The account
1235
+ * was frozen per the Office of Foreign Assets Control.
1236
+ * - `credit_entry_refused_by_receiver` - Code R23. The receiving bank account
1237
+ * refused a credit transfer.
1238
+ * - `unauthorized_debit_to_consumer_account_using_corporate_sec_code` - Code R05.
1239
+ * The receiving bank rejected because of an incorrect Standard Entry Class code.
1240
+ * - `corporate_customer_advised_not_authorized` - Code R29. The corporate customer
1241
+ * reversed the transfer.
1242
+ * - `payment_stopped` - Code R08. The receiving bank stopped payment on this
1243
+ * transfer.
1244
+ * - `non_transaction_account` - Code R20. The receiving bank account does not
1245
+ * perform transfers.
1246
+ * - `uncollected_funds` - Code R09. The receiving bank account does not have
1247
+ * enough available balance for the transfer.
1248
+ * - `routing_number_check_digit_error` - Code R28. The routing number is
1249
+ * incorrect.
1250
+ * - `customer_advised_unauthorized_improper_ineligible_or_incomplete` - Code R10.
1251
+ * The customer reversed the transfer.
1252
+ * - `amount_field_error` - Code R19. The amount field is incorrect or too large.
1253
+ * - `authorization_revoked_by_customer` - Code R07. The customer who initiated the
1254
+ * transfer revoked authorization.
1255
+ * - `invalid_ach_routing_number` - Code R13. The routing number is invalid.
1256
+ * - `file_record_edit_criteria` - Code R17. The receiving bank is unable to
1257
+ * process a field in the transfer.
1258
+ * - `enr_invalid_individual_name` - Code R45. The individual name field was
1259
+ * invalid.
1260
+ * - `returned_per_odfi_request` - Code R06. The originating financial institution
1261
+ * reversed the transfer.
1262
+ * - `limited_participation_dfi` - Code R34. The receiving bank's regulatory
1263
+ * supervisor has limited their participation.
1264
+ * - `incorrectly_coded_outbound_international_payment` - Code R85. The outbound
1265
+ * international ACH transfer was incorrect.
1266
+ * - `account_sold_to_another_dfi` - Code R12. A rare return reason. The account
1267
+ * was sold to another bank.
1268
+ * - `addenda_error` - Code R25. The addenda record is incorrect or missing.
1269
+ * - `beneficiary_or_account_holder_deceased` - Code R15. A rare return reason. The
1270
+ * account holder is deceased.
1271
+ * - `customer_advised_not_within_authorization_terms` - Code R11. A rare return
1272
+ * reason. The customer authorized some payment to the sender, but this payment
1273
+ * was not in error.
1274
+ * - `corrected_return` - Code R74. A rare return reason. Sent in response to a
1275
+ * return that was returned with code `field_error`. The latest return should
1276
+ * include the corrected field(s).
1277
+ * - `duplicate_entry` - Code R24. A rare return reason. The receiving bank
1278
+ * received an exact duplicate entry with the same trace number and amount.
1279
+ * - `duplicate_return` - Code R67. A rare return reason. The return this message
1280
+ * refers to was a duplicate.
1281
+ * - `enr_duplicate_enrollment` - Code R47. A rare return reason. Only used for US
1282
+ * Government agency non-monetary automatic enrollment messages.
1283
+ * - `enr_invalid_dfi_account_number` - Code R43. A rare return reason. Only used
1284
+ * for US Government agency non-monetary automatic enrollment messages.
1285
+ * - `enr_invalid_individual_id_number` - Code R44. A rare return reason. Only used
1286
+ * for US Government agency non-monetary automatic enrollment messages.
1287
+ * - `enr_invalid_representative_payee_indicator` - Code R46. A rare return reason.
1288
+ * Only used for US Government agency non-monetary automatic enrollment messages.
1289
+ * - `enr_invalid_transaction_code` - Code R41. A rare return reason. Only used for
1290
+ * US Government agency non-monetary automatic enrollment messages.
1291
+ * - `enr_return_of_enr_entry` - Code R40. A rare return reason. Only used for US
1292
+ * Government agency non-monetary automatic enrollment messages.
1293
+ * - `enr_routing_number_check_digit_error` - Code R42. A rare return reason. Only
1294
+ * used for US Government agency non-monetary automatic enrollment messages.
1295
+ * - `entry_not_processed_by_gateway` - Code R84. A rare return reason. The
1296
+ * International ACH Transfer cannot be processed by the gateway.
1297
+ * - `field_error` - Code R69. A rare return reason. One or more of the fields in
1298
+ * the ACH were malformed.
1299
+ * - `foreign_receiving_dfi_unable_to_settle` - Code R83. A rare return reason. The
1300
+ * Foreign receiving bank was unable to settle this ACH transfer.
1301
+ * - `iat_entry_coding_error` - Code R80. A rare return reason. The International
1302
+ * ACH Transfer is malformed.
1303
+ * - `improper_effective_entry_date` - Code R18. A rare return reason. The ACH has
1304
+ * an improper effective entry date field.
1305
+ * - `improper_source_document_source_document_presented` - Code R39. A rare return
1306
+ * reason. The source document related to this ACH, usually an ACH check
1307
+ * conversion, was presented to the bank.
1308
+ * - `invalid_company_id` - Code R21. A rare return reason. The Company ID field of
1309
+ * the ACH was invalid.
1310
+ * - `invalid_foreign_receiving_dfi_identification` - Code R82. A rare return
1311
+ * reason. The foreign receiving bank identifier for an International ACH
1312
+ * Transfer was invalid.
1313
+ * - `invalid_individual_id_number` - Code R22. A rare return reason. The
1314
+ * Individual ID number field of the ACH was invalid.
1315
+ * - `item_and_rck_entry_presented_for_payment` - Code R53. A rare return reason.
1316
+ * Both the Represented Check ("RCK") entry and the original check were presented
1317
+ * to the bank.
1318
+ * - `item_related_to_rck_entry_is_ineligible` - Code R51. A rare return reason.
1319
+ * The Represented Check ("RCK") entry is ineligible.
1320
+ * - `mandatory_field_error` - Code R26. A rare return reason. The ACH is missing a
1321
+ * required field.
1322
+ * - `misrouted_dishonored_return` - Code R71. A rare return reason. The receiving
1323
+ * bank does not recognize the routing number in a dishonored return entry.
1324
+ * - `misrouted_return` - Code R61. A rare return reason. The receiving bank does
1325
+ * not recognize the routing number in a return entry.
1326
+ * - `no_errors_found` - Code R76. A rare return reason. Sent in response to a
1327
+ * return, the bank does not find the errors alleged by the returning bank.
1328
+ * - `non_acceptance_of_r62_dishonored_return` - Code R77. A rare return reason.
1329
+ * The receiving bank does not accept the return of the erroneous debit. The
1330
+ * funds are not available at the receiving bank.
1331
+ * - `non_participant_in_iat_program` - Code R81. A rare return reason. The
1332
+ * receiving bank does not accept International ACH Transfers.
1333
+ * - `permissible_return_entry` - Code R31. A rare return reason. A return that has
1334
+ * been agreed to be accepted by the receiving bank, despite falling outside of
1335
+ * the usual return timeframe.
1336
+ * - `permissible_return_entry_not_accepted` - Code R70. A rare return reason. The
1337
+ * receiving bank had not approved this return.
1338
+ * - `rdfi_non_settlement` - Code R32. A rare return reason. The receiving bank
1339
+ * could not settle this transaction.
1340
+ * - `rdfi_participant_in_check_truncation_program` - Code R30. A rare return
1341
+ * reason. The receiving bank does not accept Check Truncation ACH transfers.
1342
+ * - `representative_payee_deceased_or_unable_to_continue_in_that_capacity` - Code
1343
+ * R14. A rare return reason. The payee is deceased.
1344
+ * - `return_not_a_duplicate` - Code R75. A rare return reason. The originating
1345
+ * bank disputes that an earlier `duplicate_entry` return was actually a
1346
+ * duplicate.
1347
+ * - `return_of_erroneous_or_reversing_debit` - Code R62. A rare return reason. The
1348
+ * originating bank made a mistake earlier and this return corrects it.
1349
+ * - `return_of_improper_credit_entry` - Code R36. A rare return reason. Return of
1350
+ * a malformed credit entry.
1351
+ * - `return_of_improper_debit_entry` - Code R35. A rare return reason. Return of a
1352
+ * malformed debit entry.
1353
+ * - `return_of_xck_entry` - Code R33. A rare return reason. Return of a Destroyed
1354
+ * Check ("XKC") entry.
1355
+ * - `source_document_presented_for_payment` - Code R37. A rare return reason. The
1356
+ * source document related to this ACH, usually an ACH check conversion, was
1357
+ * presented to the bank.
1358
+ * - `state_law_affecting_rck_acceptance` - Code R50. A rare return reason. State
1359
+ * law prevents the bank from accepting the Represented Check ("RCK") entry.
1360
+ * - `stop_payment_on_item_related_to_rck_entry` - Code R52. A rare return reason.
1361
+ * A stop payment was issued on a Represented Check ("RCK") entry.
1362
+ * - `stop_payment_on_source_document` - Code R38. A rare return reason. The source
1363
+ * attached to the ACH, usually an ACH check conversion, includes a stop payment.
1364
+ * - `timely_original_return` - Code R73. A rare return reason. The bank receiving
1365
+ * an `untimely_return` believes it was on time.
1366
+ * - `trace_number_error` - Code R27. A rare return reason. An ACH Return's trace
1367
+ * number does not match an originated ACH.
1368
+ * - `untimely_dishonored_return` - Code R72. A rare return reason. The dishonored
1369
+ * return was sent too late.
1370
+ * - `untimely_return` - Code R68. A rare return reason. The return was sent too
1371
+ * late.
1372
+ */
1373
+ return_reason_code:
1374
+ | 'insufficient_fund'
1375
+ | 'no_account'
1376
+ | 'account_closed'
1377
+ | 'invalid_account_number_structure'
1378
+ | 'account_frozen_entry_returned_per_ofac_instruction'
1379
+ | 'credit_entry_refused_by_receiver'
1380
+ | 'unauthorized_debit_to_consumer_account_using_corporate_sec_code'
1381
+ | 'corporate_customer_advised_not_authorized'
1382
+ | 'payment_stopped'
1383
+ | 'non_transaction_account'
1384
+ | 'uncollected_funds'
1385
+ | 'routing_number_check_digit_error'
1386
+ | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
1387
+ | 'amount_field_error'
1388
+ | 'authorization_revoked_by_customer'
1389
+ | 'invalid_ach_routing_number'
1390
+ | 'file_record_edit_criteria'
1391
+ | 'enr_invalid_individual_name'
1392
+ | 'returned_per_odfi_request'
1393
+ | 'limited_participation_dfi'
1394
+ | 'incorrectly_coded_outbound_international_payment'
1395
+ | 'account_sold_to_another_dfi'
1396
+ | 'addenda_error'
1397
+ | 'beneficiary_or_account_holder_deceased'
1398
+ | 'customer_advised_not_within_authorization_terms'
1399
+ | 'corrected_return'
1400
+ | 'duplicate_entry'
1401
+ | 'duplicate_return'
1402
+ | 'enr_duplicate_enrollment'
1403
+ | 'enr_invalid_dfi_account_number'
1404
+ | 'enr_invalid_individual_id_number'
1405
+ | 'enr_invalid_representative_payee_indicator'
1406
+ | 'enr_invalid_transaction_code'
1407
+ | 'enr_return_of_enr_entry'
1408
+ | 'enr_routing_number_check_digit_error'
1409
+ | 'entry_not_processed_by_gateway'
1410
+ | 'field_error'
1411
+ | 'foreign_receiving_dfi_unable_to_settle'
1412
+ | 'iat_entry_coding_error'
1413
+ | 'improper_effective_entry_date'
1414
+ | 'improper_source_document_source_document_presented'
1415
+ | 'invalid_company_id'
1416
+ | 'invalid_foreign_receiving_dfi_identification'
1417
+ | 'invalid_individual_id_number'
1418
+ | 'item_and_rck_entry_presented_for_payment'
1419
+ | 'item_related_to_rck_entry_is_ineligible'
1420
+ | 'mandatory_field_error'
1421
+ | 'misrouted_dishonored_return'
1422
+ | 'misrouted_return'
1423
+ | 'no_errors_found'
1424
+ | 'non_acceptance_of_r62_dishonored_return'
1425
+ | 'non_participant_in_iat_program'
1426
+ | 'permissible_return_entry'
1427
+ | 'permissible_return_entry_not_accepted'
1428
+ | 'rdfi_non_settlement'
1429
+ | 'rdfi_participant_in_check_truncation_program'
1430
+ | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
1431
+ | 'return_not_a_duplicate'
1432
+ | 'return_of_erroneous_or_reversing_debit'
1433
+ | 'return_of_improper_credit_entry'
1434
+ | 'return_of_improper_debit_entry'
1435
+ | 'return_of_xck_entry'
1436
+ | 'source_document_presented_for_payment'
1437
+ | 'state_law_affecting_rck_acceptance'
1438
+ | 'stop_payment_on_item_related_to_rck_entry'
1439
+ | 'stop_payment_on_source_document'
1440
+ | 'timely_original_return'
1441
+ | 'trace_number_error'
1442
+ | 'untimely_dishonored_return'
1443
+ | 'untimely_return';
1444
+
1445
+ /**
1446
+ * The identifier of the Tranasaction associated with this return.
1447
+ */
1448
+ transaction_id: string;
1449
+
1450
+ /**
1451
+ * The identifier of the ACH Transfer associated with this return.
1452
+ */
1453
+ transfer_id: string;
1454
+ }
1455
+
1456
+ /**
1457
+ * A Card Dispute Acceptance object. This field will be present in the JSON
1458
+ * response if and only if `category` is equal to `card_dispute_acceptance`.
1459
+ */
1460
+ export interface CardDisputeAcceptance {
1461
+ /**
1462
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1463
+ * the Card Dispute was accepted.
1464
+ */
1465
+ accepted_at: string;
1466
+
1467
+ /**
1468
+ * The identifier of the Card Dispute that was accepted.
1469
+ */
1470
+ card_dispute_id: string;
1471
+
1472
+ /**
1473
+ * The identifier of the Transaction that was created to return the disputed funds
1474
+ * to your account.
1475
+ */
1476
+ transaction_id: string;
1477
+ }
1478
+
1479
+ /**
1480
+ * A Card Refund object. This field will be present in the JSON response if and
1481
+ * only if `category` is equal to `card_refund`.
1482
+ */
1483
+ export interface CardRefund {
1484
+ /**
1485
+ * The Card Refund identifier.
1486
+ */
1487
+ id: string;
1488
+
1489
+ /**
1490
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
1491
+ * for example, this is cents.
1492
+ */
1493
+ amount: number;
1494
+
1495
+ /**
1496
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1497
+ * transaction's currency.
1498
+ *
1499
+ * - `CAD` - Canadian Dollar (CAD)
1500
+ * - `CHF` - Swiss Franc (CHF)
1501
+ * - `EUR` - Euro (EUR)
1502
+ * - `GBP` - British Pound (GBP)
1503
+ * - `JPY` - Japanese Yen (JPY)
1504
+ * - `USD` - US Dollar (USD)
1505
+ */
1506
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1507
+
1508
+ /**
1509
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
1510
+ * is transacting with.
1511
+ */
1512
+ merchant_acceptor_id: string | null;
1513
+
1514
+ /**
1515
+ * The 4-digit MCC describing the merchant's business.
1516
+ */
1517
+ merchant_category_code: string;
1518
+
1519
+ /**
1520
+ * The city the merchant resides in.
1521
+ */
1522
+ merchant_city: string | null;
1523
+
1524
+ /**
1525
+ * The country the merchant resides in.
1526
+ */
1527
+ merchant_country: string;
1528
+
1529
+ /**
1530
+ * The name of the merchant.
1531
+ */
1532
+ merchant_name: string | null;
1533
+
1534
+ /**
1535
+ * The state the merchant resides in.
1536
+ */
1537
+ merchant_state: string | null;
1538
+
1539
+ /**
1540
+ * The identifier of the Transaction associated with this Transaction.
1541
+ */
1542
+ transaction_id: string;
1543
+
1544
+ /**
1545
+ * A constant representing the object's type. For this resource it will always be
1546
+ * `card_refund`.
1547
+ */
1548
+ type: 'card_refund';
1549
+ }
1550
+
1551
+ /**
1552
+ * A Card Revenue Payment object. This field will be present in the JSON response
1553
+ * if and only if `category` is equal to `card_revenue_payment`.
1554
+ */
1555
+ export interface CardRevenuePayment {
1556
+ /**
1557
+ * The amount in the minor unit of the transaction's currency. For dollars, for
1558
+ * example, this is cents.
1559
+ */
1560
+ amount: number;
1561
+
1562
+ /**
1563
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
1564
+ * currency.
1565
+ *
1566
+ * - `CAD` - Canadian Dollar (CAD)
1567
+ * - `CHF` - Swiss Franc (CHF)
1568
+ * - `EUR` - Euro (EUR)
1569
+ * - `GBP` - British Pound (GBP)
1570
+ * - `JPY` - Japanese Yen (JPY)
1571
+ * - `USD` - US Dollar (USD)
1572
+ */
1573
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1574
+
1575
+ /**
1576
+ * The end of the period for which this transaction paid interest.
1577
+ */
1578
+ period_end: string;
1579
+
1580
+ /**
1581
+ * The start of the period for which this transaction paid interest.
1582
+ */
1583
+ period_start: string;
1584
+
1585
+ /**
1586
+ * The account the card belonged to.
1587
+ */
1588
+ transacted_on_account_id: string | null;
1589
+ }
1590
+
1591
+ /**
1592
+ * A Card Settlement object. This field will be present in the JSON response if and
1593
+ * only if `category` is equal to `card_settlement`.
1594
+ */
1595
+ export interface CardSettlement {
1596
+ /**
1597
+ * The Card Settlement identifier.
1598
+ */
1599
+ id: string;
1600
+
1601
+ /**
1602
+ * The amount in the minor unit of the transaction's settlement currency. For
1603
+ * dollars, for example, this is cents.
1604
+ */
1605
+ amount: number;
1606
+
1607
+ /**
1608
+ * The Card Authorization that was created prior to this Card Settlement, if on
1609
+ * exists.
1610
+ */
1611
+ card_authorization: string | null;
1612
+
1613
+ /**
1614
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1615
+ * transaction's settlement currency.
1616
+ *
1617
+ * - `CAD` - Canadian Dollar (CAD)
1618
+ * - `CHF` - Swiss Franc (CHF)
1619
+ * - `EUR` - Euro (EUR)
1620
+ * - `GBP` - British Pound (GBP)
1621
+ * - `JPY` - Japanese Yen (JPY)
1622
+ * - `USD` - US Dollar (USD)
1623
+ */
1624
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1625
+
1626
+ /**
1627
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
1628
+ * is transacting with.
1629
+ */
1630
+ merchant_acceptor_id: string | null;
1631
+
1632
+ /**
1633
+ * The 4-digit MCC describing the merchant's business.
1634
+ */
1635
+ merchant_category_code: string;
1636
+
1637
+ /**
1638
+ * The city the merchant resides in.
1639
+ */
1640
+ merchant_city: string | null;
1641
+
1642
+ /**
1643
+ * The country the merchant resides in.
1644
+ */
1645
+ merchant_country: string;
1646
+
1647
+ /**
1648
+ * The name of the merchant.
1649
+ */
1650
+ merchant_name: string | null;
1651
+
1652
+ /**
1653
+ * The state the merchant resides in.
1654
+ */
1655
+ merchant_state: string | null;
1656
+
1657
+ /**
1658
+ * The identifier of the Pending Transaction associated with this Transaction.
1659
+ */
1660
+ pending_transaction_id: string | null;
1661
+
1662
+ /**
1663
+ * The amount in the minor unit of the transaction's presentment currency.
1664
+ */
1665
+ presentment_amount: number;
1666
+
1667
+ /**
1668
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1669
+ * transaction's presentment currency.
1670
+ */
1671
+ presentment_currency: string;
1672
+
1673
+ /**
1674
+ * The identifier of the Transaction associated with this Transaction.
1675
+ */
1676
+ transaction_id: string;
1677
+
1678
+ /**
1679
+ * A constant representing the object's type. For this resource it will always be
1680
+ * `card_settlement`.
1681
+ */
1682
+ type: 'card_settlement';
1683
+ }
1684
+
1685
+ /**
1686
+ * A Check Deposit Acceptance object. This field will be present in the JSON
1687
+ * response if and only if `category` is equal to `check_deposit_acceptance`.
1688
+ */
1689
+ export interface CheckDepositAcceptance {
1690
+ /**
1691
+ * The account number printed on the check.
1692
+ */
1693
+ account_number: string;
1694
+
1695
+ /**
1696
+ * The amount to be deposited in the minor unit of the transaction's currency. For
1697
+ * dollars, for example, this is cents.
1698
+ */
1699
+ amount: number;
1700
+
1701
+ /**
1702
+ * An additional line of metadata printed on the check. This typically includes the
1703
+ * check number for business checks.
1704
+ */
1705
+ auxiliary_on_us: string | null;
1706
+
1707
+ /**
1708
+ * The ID of the Check Deposit that was accepted.
1709
+ */
1710
+ check_deposit_id: string;
1711
+
1712
+ /**
1713
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1714
+ * transaction's currency.
1715
+ *
1716
+ * - `CAD` - Canadian Dollar (CAD)
1717
+ * - `CHF` - Swiss Franc (CHF)
1718
+ * - `EUR` - Euro (EUR)
1719
+ * - `GBP` - British Pound (GBP)
1720
+ * - `JPY` - Japanese Yen (JPY)
1721
+ * - `USD` - US Dollar (USD)
1722
+ */
1723
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1724
+
1725
+ /**
1726
+ * The routing number printed on the check.
1727
+ */
1728
+ routing_number: string;
1729
+
1730
+ /**
1731
+ * The check serial number, if present, for consumer checks. For business checks,
1732
+ * the serial number is usually in the `auxiliary_on_us` field.
1733
+ */
1734
+ serial_number: string | null;
1735
+ }
1736
+
1737
+ /**
1738
+ * A Check Deposit Return object. This field will be present in the JSON response
1739
+ * if and only if `category` is equal to `check_deposit_return`.
1740
+ */
1741
+ export interface CheckDepositReturn {
1742
+ /**
1743
+ * The amount in the minor unit of the transaction's currency. For dollars, for
1744
+ * example, this is cents.
1745
+ */
1746
+ amount: number;
1747
+
1748
+ /**
1749
+ * The identifier of the Check Deposit that was returned.
1750
+ */
1751
+ check_deposit_id: string;
1752
+
1753
+ /**
1754
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1755
+ * transaction's currency.
1756
+ *
1757
+ * - `CAD` - Canadian Dollar (CAD)
1758
+ * - `CHF` - Swiss Franc (CHF)
1759
+ * - `EUR` - Euro (EUR)
1760
+ * - `GBP` - British Pound (GBP)
1761
+ * - `JPY` - Japanese Yen (JPY)
1762
+ * - `USD` - US Dollar (USD)
1763
+ */
1764
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1765
+
1766
+ /**
1767
+ * - `ach_conversion_not_supported` - The check doesn't allow ACH conversion.
1768
+ * - `closed_account` - The account is closed.
1769
+ * - `duplicate_submission` - The check has already been deposited.
1770
+ * - `insufficient_funds` - Insufficient funds
1771
+ * - `no_account` - No account was found matching the check details.
1772
+ * - `not_authorized` - The check was not authorized.
1773
+ * - `stale_dated` - The check is too old.
1774
+ * - `stop_payment` - The payment has been stopped by the account holder.
1775
+ * - `unknown_reason` - The reason for the return is unknown.
1776
+ * - `unmatched_details` - The image doesn't match the details submitted.
1777
+ * - `unreadable_image` - The image could not be read.
1778
+ * - `endorsement_irregular` - The check endorsement was irregular.
1779
+ */
1780
+ return_reason:
1781
+ | 'ach_conversion_not_supported'
1782
+ | 'closed_account'
1783
+ | 'duplicate_submission'
1784
+ | 'insufficient_funds'
1785
+ | 'no_account'
1786
+ | 'not_authorized'
1787
+ | 'stale_dated'
1788
+ | 'stop_payment'
1789
+ | 'unknown_reason'
1790
+ | 'unmatched_details'
1791
+ | 'unreadable_image'
1792
+ | 'endorsement_irregular';
1793
+
1794
+ /**
1795
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1796
+ * the check deposit was returned.
1797
+ */
1798
+ returned_at: string;
1799
+
1800
+ /**
1801
+ * The identifier of the transaction that reversed the original check deposit
1802
+ * transaction.
1803
+ */
1804
+ transaction_id: string;
1805
+ }
1806
+
1807
+ /**
1808
+ * A Check Transfer Deposit object. This field will be present in the JSON response
1809
+ * if and only if `category` is equal to `check_transfer_deposit`.
1810
+ */
1811
+ export interface CheckTransferDeposit {
1812
+ /**
1813
+ * The identifier of the API File object containing an image of the back of the
1814
+ * deposited check.
1815
+ */
1816
+ back_image_file_id: string | null;
1817
+
1818
+ /**
1819
+ * When the check was deposited.
1820
+ */
1821
+ deposited_at: string;
1822
+
1823
+ /**
1824
+ * The identifier of the API File object containing an image of the front of the
1825
+ * deposited check.
1826
+ */
1827
+ front_image_file_id: string | null;
1828
+
1829
+ /**
1830
+ * The identifier of the Transaction object created when the check was deposited.
1831
+ */
1832
+ transaction_id: string | null;
1833
+
1834
+ /**
1835
+ * A constant representing the object's type. For this resource it will always be
1836
+ * `check_transfer_deposit`.
1837
+ */
1838
+ type: 'check_transfer_deposit';
1839
+ }
1840
+
1841
+ /**
1842
+ * A Check Transfer Intention object. This field will be present in the JSON
1843
+ * response if and only if `category` is equal to `check_transfer_intention`.
1844
+ */
1845
+ export interface CheckTransferIntention {
1846
+ /**
1847
+ * The city of the check's destination.
1848
+ */
1849
+ address_city: string | null;
1850
+
1851
+ /**
1852
+ * The street address of the check's destination.
1853
+ */
1854
+ address_line1: string | null;
1855
+
1856
+ /**
1857
+ * The second line of the address of the check's destination.
1858
+ */
1859
+ address_line2: string | null;
1860
+
1861
+ /**
1862
+ * The state of the check's destination.
1863
+ */
1864
+ address_state: string | null;
1865
+
1866
+ /**
1867
+ * The postal code of the check's destination.
1868
+ */
1869
+ address_zip: string | null;
1870
+
1871
+ /**
1872
+ * The transfer amount in USD cents.
1873
+ */
1874
+ amount: number;
1875
+
1876
+ /**
1877
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
1878
+ * currency.
1879
+ *
1880
+ * - `CAD` - Canadian Dollar (CAD)
1881
+ * - `CHF` - Swiss Franc (CHF)
1882
+ * - `EUR` - Euro (EUR)
1883
+ * - `GBP` - British Pound (GBP)
1884
+ * - `JPY` - Japanese Yen (JPY)
1885
+ * - `USD` - US Dollar (USD)
1886
+ */
1887
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1888
+
1889
+ /**
1890
+ * The name that will be printed on the check.
1891
+ */
1892
+ recipient_name: string | null;
1893
+
1894
+ /**
1895
+ * The identifier of the Check Transfer with which this is associated.
1896
+ */
1897
+ transfer_id: string;
1898
+ }
1899
+
1900
+ /**
1901
+ * A Check Transfer Rejection object. This field will be present in the JSON
1902
+ * response if and only if `category` is equal to `check_transfer_rejection`.
1903
+ */
1904
+ export interface CheckTransferRejection {
1905
+ /**
1906
+ * The identifier of the Check Transfer that led to this Transaction.
1907
+ */
1908
+ transfer_id: string;
1909
+ }
1910
+
1911
+ /**
1912
+ * A Check Transfer Stop Payment Request object. This field will be present in the
1913
+ * JSON response if and only if `category` is equal to
1914
+ * `check_transfer_stop_payment_request`.
1915
+ */
1916
+ export interface CheckTransferStopPaymentRequest {
1917
+ /**
1918
+ * The reason why this transfer was stopped.
1919
+ *
1920
+ * - `mail_delivery_failed` - The check could not be delivered.
1921
+ * - `unknown` - The check was stopped for another reason.
1922
+ */
1923
+ reason: 'mail_delivery_failed' | 'unknown';
1924
+
1925
+ /**
1926
+ * The time the stop-payment was requested.
1927
+ */
1928
+ requested_at: string;
1929
+
1930
+ /**
1931
+ * The ID of the check transfer that was stopped.
1932
+ */
1933
+ transfer_id: string;
1934
+
1935
+ /**
1936
+ * A constant representing the object's type. For this resource it will always be
1937
+ * `check_transfer_stop_payment_request`.
1938
+ */
1939
+ type: 'check_transfer_stop_payment_request';
1940
+ }
1941
+
1942
+ /**
1943
+ * A Fee Payment object. This field will be present in the JSON response if and
1944
+ * only if `category` is equal to `fee_payment`.
1945
+ */
1946
+ export interface FeePayment {
1947
+ /**
1948
+ * The amount in the minor unit of the transaction's currency. For dollars, for
1949
+ * example, this is cents.
1950
+ */
1951
+ amount: number;
1952
+
1953
+ /**
1954
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
1955
+ * currency.
1956
+ *
1957
+ * - `CAD` - Canadian Dollar (CAD)
1958
+ * - `CHF` - Swiss Franc (CHF)
1959
+ * - `EUR` - Euro (EUR)
1960
+ * - `GBP` - British Pound (GBP)
1961
+ * - `JPY` - Japanese Yen (JPY)
1962
+ * - `USD` - US Dollar (USD)
1963
+ */
1964
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1965
+ }
1966
+
1967
+ /**
1968
+ * A Inbound ACH Transfer object. This field will be present in the JSON response
1969
+ * if and only if `category` is equal to `inbound_ach_transfer`.
1970
+ */
1971
+ export interface InboundACHTransfer {
1972
+ /**
1973
+ * The amount in the minor unit of the destination account currency. For dollars,
1974
+ * for example, this is cents.
1975
+ */
1976
+ amount: number;
1977
+
1978
+ originator_company_descriptive_date: string | null;
1979
+
1980
+ originator_company_discretionary_data: string | null;
1981
+
1982
+ originator_company_entry_description: string;
1983
+
1984
+ originator_company_id: string;
1985
+
1986
+ originator_company_name: string;
1987
+
1988
+ receiver_id_number: string | null;
1989
+
1990
+ receiver_name: string | null;
1991
+
1992
+ trace_number: string;
1993
+ }
1994
+
1995
+ /**
1996
+ * A Inbound Check object. This field will be present in the JSON response if and
1997
+ * only if `category` is equal to `inbound_check`.
1998
+ */
1999
+ export interface InboundCheck {
2000
+ /**
2001
+ * The amount in the minor unit of the destination account currency. For dollars,
2002
+ * for example, this is cents.
2003
+ */
2004
+ amount: number;
2005
+
2006
+ check_front_image_file_id: string | null;
2007
+
2008
+ check_number: string | null;
2009
+
2010
+ check_rear_image_file_id: string | null;
2011
+
2012
+ /**
2013
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
2014
+ * transaction's currency.
2015
+ *
2016
+ * - `CAD` - Canadian Dollar (CAD)
2017
+ * - `CHF` - Swiss Franc (CHF)
2018
+ * - `EUR` - Euro (EUR)
2019
+ * - `GBP` - British Pound (GBP)
2020
+ * - `JPY` - Japanese Yen (JPY)
2021
+ * - `USD` - US Dollar (USD)
2022
+ */
2023
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
2024
+ }
2025
+
2026
+ /**
2027
+ * A Inbound International ACH Transfer object. This field will be present in the
2028
+ * JSON response if and only if `category` is equal to
2029
+ * `inbound_international_ach_transfer`.
2030
+ */
2031
+ export interface InboundInternationalACHTransfer {
2032
+ /**
2033
+ * The amount in the minor unit of the destination account currency. For dollars,
2034
+ * for example, this is cents.
2035
+ */
2036
+ amount: number;
2037
+
2038
+ destination_country_code: string;
2039
+
2040
+ destination_currency_code: string;
2041
+
2042
+ foreign_exchange_indicator: string;
2043
+
2044
+ foreign_exchange_reference: string | null;
2045
+
2046
+ foreign_exchange_reference_indicator: string;
2047
+
2048
+ foreign_payment_amount: number;
2049
+
2050
+ foreign_trace_number: string | null;
2051
+
2052
+ international_transaction_type_code: string;
2053
+
2054
+ originating_currency_code: string;
2055
+
2056
+ originating_depository_financial_institution_branch_country: string;
2057
+
2058
+ originating_depository_financial_institution_id: string;
2059
+
2060
+ originating_depository_financial_institution_id_qualifier: string;
2061
+
2062
+ originating_depository_financial_institution_name: string;
2063
+
2064
+ originator_city: string;
2065
+
2066
+ originator_company_entry_description: string;
2067
+
2068
+ originator_country: string;
2069
+
2070
+ originator_identification: string;
2071
+
2072
+ originator_name: string;
2073
+
2074
+ originator_postal_code: string | null;
2075
+
2076
+ originator_state_or_province: string | null;
2077
+
2078
+ originator_street_address: string;
2079
+
2080
+ payment_related_information: string | null;
2081
+
2082
+ payment_related_information2: string | null;
2083
+
2084
+ receiver_city: string;
2085
+
2086
+ receiver_country: string;
2087
+
2088
+ receiver_identification_number: string | null;
2089
+
2090
+ receiver_postal_code: string | null;
2091
+
2092
+ receiver_state_or_province: string | null;
2093
+
2094
+ receiver_street_address: string;
2095
+
2096
+ receiving_company_or_individual_name: string;
2097
+
2098
+ receiving_depository_financial_institution_country: string;
2099
+
2100
+ receiving_depository_financial_institution_id: string;
2101
+
2102
+ receiving_depository_financial_institution_id_qualifier: string;
2103
+
2104
+ receiving_depository_financial_institution_name: string;
2105
+
2106
+ trace_number: string;
2107
+ }
2108
+
2109
+ /**
2110
+ * A Inbound Real Time Payments Transfer Confirmation object. This field will be
2111
+ * present in the JSON response if and only if `category` is equal to
2112
+ * `inbound_real_time_payments_transfer_confirmation`.
2113
+ */
2114
+ export interface InboundRealTimePaymentsTransferConfirmation {
2115
+ /**
2116
+ * The amount in the minor unit of the transfer's currency. For dollars, for
2117
+ * example, this is cents.
2118
+ */
2119
+ amount: number;
2120
+
2121
+ /**
2122
+ * The name the sender of the transfer specified as the recipient of the transfer.
2123
+ */
2124
+ creditor_name: string;
2125
+
2126
+ /**
2127
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
2128
+ * currency. This will always be "USD" for a Real Time Payments transfer.
2129
+ *
2130
+ * - `CAD` - Canadian Dollar (CAD)
2131
+ * - `CHF` - Swiss Franc (CHF)
2132
+ * - `EUR` - Euro (EUR)
2133
+ * - `GBP` - British Pound (GBP)
2134
+ * - `JPY` - Japanese Yen (JPY)
2135
+ * - `USD` - US Dollar (USD)
2136
+ */
2137
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
2138
+
2139
+ /**
2140
+ * The account number of the account that sent the transfer.
2141
+ */
2142
+ debtor_account_number: string;
2143
+
2144
+ /**
2145
+ * The name provided by the sender of the transfer.
2146
+ */
2147
+ debtor_name: string;
2148
+
2149
+ /**
2150
+ * The routing number of the account that sent the transfer.
2151
+ */
2152
+ debtor_routing_number: string;
2153
+
2154
+ /**
2155
+ * Additional information included with the transfer.
2156
+ */
2157
+ remittance_information: string | null;
2158
+
2159
+ /**
2160
+ * The Real Time Payments network identification of the transfer
2161
+ */
2162
+ transaction_identification: string;
2163
+ }
2164
+
2165
+ /**
2166
+ * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
2167
+ * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
2168
+ */
2169
+ export interface InboundWireDrawdownPayment {
2170
+ /**
2171
+ * The amount in the minor unit of the transaction's currency. For dollars, for
2172
+ * example, this is cents.
2173
+ */
2174
+ amount: number;
2175
+
2176
+ beneficiary_address_line1: string | null;
2177
+
2178
+ beneficiary_address_line2: string | null;
2179
+
2180
+ beneficiary_address_line3: string | null;
2181
+
2182
+ beneficiary_name: string | null;
2183
+
2184
+ beneficiary_reference: string | null;
2185
+
2186
+ description: string;
2187
+
2188
+ input_message_accountability_data: string | null;
2189
+
2190
+ originator_address_line1: string | null;
2191
+
2192
+ originator_address_line2: string | null;
2193
+
2194
+ originator_address_line3: string | null;
2195
+
2196
+ originator_name: string | null;
2197
+
2198
+ originator_to_beneficiary_information: string | null;
2199
+ }
2200
+
2201
+ /**
2202
+ * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
2203
+ * the JSON response if and only if `category` is equal to
2204
+ * `inbound_wire_drawdown_payment_reversal`.
2205
+ */
2206
+ export interface InboundWireDrawdownPaymentReversal {
2207
+ /**
2208
+ * The amount that was reversed.
2209
+ */
2210
+ amount: number;
2211
+
2212
+ /**
2213
+ * The description on the reversal message from Fedwire.
2214
+ */
2215
+ description: string;
2216
+
2217
+ /**
2218
+ * The Fedwire cycle date for the wire reversal.
2219
+ */
2220
+ input_cycle_date: string;
2221
+
2222
+ /**
2223
+ * The Fedwire transaction identifier.
2224
+ */
2225
+ input_message_accountability_data: string;
2226
+
2227
+ /**
2228
+ * The Fedwire sequence number.
2229
+ */
2230
+ input_sequence_number: string;
2231
+
2232
+ /**
2233
+ * The Fedwire input source identifier.
2234
+ */
2235
+ input_source: string;
2236
+
2237
+ /**
2238
+ * The Fedwire cycle date for the wire transfer that was reversed.
2239
+ */
2240
+ previous_message_input_cycle_date: string;
2241
+
2242
+ /**
2243
+ * The Fedwire transaction identifier for the wire transfer that was reversed.
2244
+ */
2245
+ previous_message_input_message_accountability_data: string;
2246
+
2247
+ /**
2248
+ * The Fedwire sequence number for the wire transfer that was reversed.
2249
+ */
2250
+ previous_message_input_sequence_number: string;
2251
+
2252
+ /**
2253
+ * The Fedwire input source identifier for the wire transfer that was reversed.
2254
+ */
2255
+ previous_message_input_source: string;
2256
+ }
2257
+
2258
+ /**
2259
+ * A Inbound Wire Reversal object. This field will be present in the JSON response
2260
+ * if and only if `category` is equal to `inbound_wire_reversal`.
2261
+ */
2262
+ export interface InboundWireReversal {
2263
+ /**
2264
+ * The amount that was reversed.
2265
+ */
2266
+ amount: number;
2267
+
2268
+ /**
2269
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
2270
+ * the reversal was created.
2271
+ */
2272
+ created_at: string;
2273
+
2274
+ /**
2275
+ * The description on the reversal message from Fedwire.
2276
+ */
2277
+ description: string;
2278
+
2279
+ /**
2280
+ * Additional financial institution information included in the wire reversal.
2281
+ */
2282
+ financial_institution_to_financial_institution_information: string | null;
2283
+
2284
+ /**
2285
+ * The Fedwire cycle date for the wire reversal.
2286
+ */
2287
+ input_cycle_date: string;
2288
+
2289
+ /**
2290
+ * The Fedwire transaction identifier.
2291
+ */
2292
+ input_message_accountability_data: string;
2293
+
2294
+ /**
2295
+ * The Fedwire sequence number.
2296
+ */
2297
+ input_sequence_number: string;
2298
+
2299
+ /**
2300
+ * The Fedwire input source identifier.
2301
+ */
2302
+ input_source: string;
2303
+
2304
+ /**
2305
+ * The Fedwire cycle date for the wire transfer that was reversed.
2306
+ */
2307
+ previous_message_input_cycle_date: string;
2308
+
2309
+ /**
2310
+ * The Fedwire transaction identifier for the wire transfer that was reversed.
2311
+ */
2312
+ previous_message_input_message_accountability_data: string;
2313
+
2314
+ /**
2315
+ * The Fedwire sequence number for the wire transfer that was reversed.
2316
+ */
2317
+ previous_message_input_sequence_number: string;
2318
+
2319
+ /**
2320
+ * The Fedwire input source identifier for the wire transfer that was reversed.
2321
+ */
2322
+ previous_message_input_source: string;
2323
+
2324
+ /**
2325
+ * Information included in the wire reversal for the receiving financial
2326
+ * institution.
2327
+ */
2328
+ receiver_financial_institution_information: string | null;
2329
+
2330
+ /**
2331
+ * The ID for the Transaction associated with the transfer reversal.
2332
+ */
2333
+ transaction_id: string | null;
2334
+
2335
+ /**
2336
+ * The ID for the Wire Transfer that is being reversed.
2337
+ */
2338
+ wire_transfer_id: string;
2339
+ }
2340
+
2341
+ /**
2342
+ * A Inbound Wire Transfer object. This field will be present in the JSON response
2343
+ * if and only if `category` is equal to `inbound_wire_transfer`.
2344
+ */
2345
+ export interface InboundWireTransfer {
2346
+ /**
2347
+ * The amount in the minor unit of the transaction's currency. For dollars, for
2348
+ * example, this is cents.
2349
+ */
2350
+ amount: number;
2351
+
2352
+ beneficiary_address_line1: string | null;
2353
+
2354
+ beneficiary_address_line2: string | null;
2355
+
2356
+ beneficiary_address_line3: string | null;
2357
+
2358
+ beneficiary_name: string | null;
2359
+
2360
+ beneficiary_reference: string | null;
2361
+
2362
+ description: string;
2363
+
2364
+ input_message_accountability_data: string | null;
2365
+
2366
+ originator_address_line1: string | null;
2367
+
2368
+ originator_address_line2: string | null;
2369
+
2370
+ originator_address_line3: string | null;
2371
+
2372
+ originator_name: string | null;
2373
+
2374
+ originator_to_beneficiary_information: string | null;
2375
+
2376
+ originator_to_beneficiary_information_line1: string | null;
2377
+
2378
+ originator_to_beneficiary_information_line2: string | null;
2379
+
2380
+ originator_to_beneficiary_information_line3: string | null;
2381
+
2382
+ originator_to_beneficiary_information_line4: string | null;
2383
+ }
2384
+
2385
+ /**
2386
+ * A Interest Payment object. This field will be present in the JSON response if
2387
+ * and only if `category` is equal to `interest_payment`.
2388
+ */
2389
+ export interface InterestPayment {
2390
+ /**
2391
+ * The account on which the interest was accrued.
2392
+ */
2393
+ accrued_on_account_id: string | null;
2394
+
2395
+ /**
2396
+ * The amount in the minor unit of the transaction's currency. For dollars, for
2397
+ * example, this is cents.
2398
+ */
2399
+ amount: number;
2400
+
2401
+ /**
2402
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
2403
+ * currency.
2404
+ *
2405
+ * - `CAD` - Canadian Dollar (CAD)
2406
+ * - `CHF` - Swiss Franc (CHF)
2407
+ * - `EUR` - Euro (EUR)
2408
+ * - `GBP` - British Pound (GBP)
2409
+ * - `JPY` - Japanese Yen (JPY)
2410
+ * - `USD` - US Dollar (USD)
2411
+ */
2412
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
2413
+
2414
+ /**
2415
+ * The end of the period for which this transaction paid interest.
2416
+ */
2417
+ period_end: string;
2418
+
2419
+ /**
2420
+ * The start of the period for which this transaction paid interest.
2421
+ */
2422
+ period_start: string;
2423
+ }
2424
+
2425
+ /**
2426
+ * A Internal Source object. This field will be present in the JSON response if and
2427
+ * only if `category` is equal to `internal_source`.
2428
+ */
2429
+ export interface InternalSource {
2430
+ /**
2431
+ * The amount in the minor unit of the transaction's currency. For dollars, for
2432
+ * example, this is cents.
2433
+ */
2434
+ amount: number;
2435
+
2436
+ /**
2437
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
2438
+ * currency.
2439
+ *
2440
+ * - `CAD` - Canadian Dollar (CAD)
2441
+ * - `CHF` - Swiss Franc (CHF)
2442
+ * - `EUR` - Euro (EUR)
2443
+ * - `GBP` - British Pound (GBP)
2444
+ * - `JPY` - Japanese Yen (JPY)
2445
+ * - `USD` - US Dollar (USD)
2446
+ */
2447
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
2448
+
2449
+ /**
2450
+ * - `account_closure` - Account closure
2451
+ * - `bank_migration` - Bank migration
2452
+ * - `cashback` - Cashback
2453
+ * - `collection_receivable` - Collection receivable
2454
+ * - `empyreal_adjustment` - Empyreal adjustment
2455
+ * - `error` - Error
2456
+ * - `error_correction` - Error correction
2457
+ * - `fees` - Fees
2458
+ * - `interest` - Interest
2459
+ * - `negative_balance_forgiveness` - Negative balance forgiveness
2460
+ * - `sample_funds` - Sample funds
2461
+ * - `sample_funds_return` - Sample funds return
2462
+ */
2463
+ reason:
2464
+ | 'account_closure'
2465
+ | 'bank_migration'
2466
+ | 'cashback'
2467
+ | 'collection_receivable'
2468
+ | 'empyreal_adjustment'
2469
+ | 'error'
2470
+ | 'error_correction'
2471
+ | 'fees'
2472
+ | 'interest'
2473
+ | 'negative_balance_forgiveness'
2474
+ | 'sample_funds'
2475
+ | 'sample_funds_return';
2476
+ }
2477
+
2478
+ /**
2479
+ * A Real Time Payments Transfer Acknowledgement object. This field will be present
2480
+ * in the JSON response if and only if `category` is equal to
2481
+ * `real_time_payments_transfer_acknowledgement`.
2482
+ */
2483
+ export interface RealTimePaymentsTransferAcknowledgement {
2484
+ /**
2485
+ * The transfer amount in USD cents.
2486
+ */
2487
+ amount: number;
2488
+
2489
+ /**
2490
+ * The destination account number.
2491
+ */
2492
+ destination_account_number: string;
2493
+
2494
+ /**
2495
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN).
2496
+ */
2497
+ destination_routing_number: string;
2498
+
2499
+ /**
2500
+ * Unstructured information that will show on the recipient's bank statement.
2501
+ */
2502
+ remittance_information: string;
2503
+
2504
+ /**
2505
+ * The identifier of the Real Time Payments Transfer that led to this Transaction.
2506
+ */
2507
+ transfer_id: string;
2508
+ }
2509
+
2510
+ /**
2511
+ * A Sample Funds object. This field will be present in the JSON response if and
2512
+ * only if `category` is equal to `sample_funds`.
2513
+ */
2514
+ export interface SampleFunds {
2515
+ /**
2516
+ * Where the sample funds came from.
2517
+ */
2518
+ originator: string;
2519
+ }
2520
+
2521
+ /**
2522
+ * A Wire Transfer Intention object. This field will be present in the JSON
2523
+ * response if and only if `category` is equal to `wire_transfer_intention`.
2524
+ */
2525
+ export interface WireTransferIntention {
2526
+ /**
2527
+ * The destination account number.
2528
+ */
2529
+ account_number: string;
2530
+
2531
+ /**
2532
+ * The transfer amount in USD cents.
2533
+ */
2534
+ amount: number;
2535
+
2536
+ /**
2537
+ * The message that will show on the recipient's bank statement.
2538
+ */
2539
+ message_to_recipient: string;
2540
+
2541
+ /**
2542
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN).
2543
+ */
2544
+ routing_number: string;
2545
+
2546
+ transfer_id: string;
2547
+ }
2548
+
2549
+ /**
2550
+ * A Wire Transfer Rejection object. This field will be present in the JSON
2551
+ * response if and only if `category` is equal to `wire_transfer_rejection`.
2552
+ */
2553
+ export interface WireTransferRejection {
2554
+ transfer_id: string;
2555
+ }
2556
+ }
2557
+ }
2558
+ }
2559
+
2560
+ export interface ACHTransferCreateInboundParams {
2561
+ /**
2562
+ * The identifier of the Account Number the inbound ACH Transfer is for.
2563
+ */
2564
+ account_number_id: string;
2565
+
2566
+ /**
2567
+ * The transfer amount in cents. A positive amount originates a credit transfer
2568
+ * pushing funds to the receiving account. A negative amount originates a debit
2569
+ * transfer pulling funds from the receiving account.
2570
+ */
2571
+ amount: number;
2572
+
2573
+ /**
2574
+ * The description of the date of the transfer.
2575
+ */
2576
+ company_descriptive_date?: string;
2577
+
2578
+ /**
2579
+ * Data associated with the transfer set by the sender.
2580
+ */
2581
+ company_discretionary_data?: string;
2582
+
2583
+ /**
2584
+ * The description of the transfer set by the sender.
2585
+ */
2586
+ company_entry_description?: string;
2587
+
2588
+ /**
2589
+ * The sender's company id.
2590
+ */
2591
+ company_id?: string;
2592
+
2593
+ /**
2594
+ * The name of the sender.
2595
+ */
2596
+ company_name?: string;
2597
+ }
2598
+
2599
+ export interface ACHTransferReturnParams {
2600
+ /**
2601
+ * The reason why the Federal Reserve or destination bank returned this transfer.
2602
+ * Defaults to `no_account`.
2603
+ *
2604
+ * - `insufficient_fund` - Code R01. Insufficient funds in the source account.
2605
+ * - `no_account` - Code R03. The account does not exist or the receiving bank was
2606
+ * unable to locate it.
2607
+ * - `account_closed` - Code R02. The account is closed.
2608
+ * - `invalid_account_number_structure` - Code R04. The account number is invalid
2609
+ * at the receiving bank.
2610
+ * - `account_frozen_entry_returned_per_ofac_instruction` - Code R16. The account
2611
+ * was frozen per the Office of Foreign Assets Control.
2612
+ * - `credit_entry_refused_by_receiver` - Code R23. The receiving bank account
2613
+ * refused a credit transfer.
2614
+ * - `unauthorized_debit_to_consumer_account_using_corporate_sec_code` - Code R05.
2615
+ * The receiving bank rejected because of an incorrect Standard Entry Class code.
2616
+ * - `corporate_customer_advised_not_authorized` - Code R29. The corporate customer
2617
+ * reversed the transfer.
2618
+ * - `payment_stopped` - Code R08. The receiving bank stopped payment on this
2619
+ * transfer.
2620
+ * - `non_transaction_account` - Code R20. The receiving bank account does not
2621
+ * perform transfers.
2622
+ * - `uncollected_funds` - Code R09. The receiving bank account does not have
2623
+ * enough available balance for the transfer.
2624
+ * - `routing_number_check_digit_error` - Code R28. The routing number is
2625
+ * incorrect.
2626
+ * - `customer_advised_unauthorized_improper_ineligible_or_incomplete` - Code R10.
2627
+ * The customer reversed the transfer.
2628
+ * - `amount_field_error` - Code R19. The amount field is incorrect or too large.
2629
+ * - `authorization_revoked_by_customer` - Code R07. The customer who initiated the
2630
+ * transfer revoked authorization.
2631
+ * - `invalid_ach_routing_number` - Code R13. The routing number is invalid.
2632
+ * - `file_record_edit_criteria` - Code R17. The receiving bank is unable to
2633
+ * process a field in the transfer.
2634
+ * - `enr_invalid_individual_name` - Code R45. The individual name field was
2635
+ * invalid.
2636
+ * - `returned_per_odfi_request` - Code R06. The originating financial institution
2637
+ * reversed the transfer.
2638
+ * - `limited_participation_dfi` - Code R34. The receiving bank's regulatory
2639
+ * supervisor has limited their participation.
2640
+ * - `incorrectly_coded_outbound_international_payment` - Code R85. The outbound
2641
+ * international ACH transfer was incorrect.
2642
+ * - `account_sold_to_another_dfi` - Code R12. A rare return reason. The account
2643
+ * was sold to another bank.
2644
+ * - `addenda_error` - Code R25. The addenda record is incorrect or missing.
2645
+ * - `beneficiary_or_account_holder_deceased` - Code R15. A rare return reason. The
2646
+ * account holder is deceased.
2647
+ * - `customer_advised_not_within_authorization_terms` - Code R11. A rare return
2648
+ * reason. The customer authorized some payment to the sender, but this payment
2649
+ * was not in error.
2650
+ * - `corrected_return` - Code R74. A rare return reason. Sent in response to a
2651
+ * return that was returned with code `field_error`. The latest return should
2652
+ * include the corrected field(s).
2653
+ * - `duplicate_entry` - Code R24. A rare return reason. The receiving bank
2654
+ * received an exact duplicate entry with the same trace number and amount.
2655
+ * - `duplicate_return` - Code R67. A rare return reason. The return this message
2656
+ * refers to was a duplicate.
2657
+ * - `enr_duplicate_enrollment` - Code R47. A rare return reason. Only used for US
2658
+ * Government agency non-monetary automatic enrollment messages.
2659
+ * - `enr_invalid_dfi_account_number` - Code R43. A rare return reason. Only used
2660
+ * for US Government agency non-monetary automatic enrollment messages.
2661
+ * - `enr_invalid_individual_id_number` - Code R44. A rare return reason. Only used
2662
+ * for US Government agency non-monetary automatic enrollment messages.
2663
+ * - `enr_invalid_representative_payee_indicator` - Code R46. A rare return reason.
2664
+ * Only used for US Government agency non-monetary automatic enrollment messages.
2665
+ * - `enr_invalid_transaction_code` - Code R41. A rare return reason. Only used for
2666
+ * US Government agency non-monetary automatic enrollment messages.
2667
+ * - `enr_return_of_enr_entry` - Code R40. A rare return reason. Only used for US
2668
+ * Government agency non-monetary automatic enrollment messages.
2669
+ * - `enr_routing_number_check_digit_error` - Code R42. A rare return reason. Only
2670
+ * used for US Government agency non-monetary automatic enrollment messages.
2671
+ * - `entry_not_processed_by_gateway` - Code R84. A rare return reason. The
2672
+ * International ACH Transfer cannot be processed by the gateway.
2673
+ * - `field_error` - Code R69. A rare return reason. One or more of the fields in
2674
+ * the ACH were malformed.
2675
+ * - `foreign_receiving_dfi_unable_to_settle` - Code R83. A rare return reason. The
2676
+ * Foreign receiving bank was unable to settle this ACH transfer.
2677
+ * - `iat_entry_coding_error` - Code R80. A rare return reason. The International
2678
+ * ACH Transfer is malformed.
2679
+ * - `improper_effective_entry_date` - Code R18. A rare return reason. The ACH has
2680
+ * an improper effective entry date field.
2681
+ * - `improper_source_document_source_document_presented` - Code R39. A rare return
2682
+ * reason. The source document related to this ACH, usually an ACH check
2683
+ * conversion, was presented to the bank.
2684
+ * - `invalid_company_id` - Code R21. A rare return reason. The Company ID field of
2685
+ * the ACH was invalid.
2686
+ * - `invalid_foreign_receiving_dfi_identification` - Code R82. A rare return
2687
+ * reason. The foreign receiving bank identifier for an International ACH
2688
+ * Transfer was invalid.
2689
+ * - `invalid_individual_id_number` - Code R22. A rare return reason. The
2690
+ * Individual ID number field of the ACH was invalid.
2691
+ * - `item_and_rck_entry_presented_for_payment` - Code R53. A rare return reason.
2692
+ * Both the Represented Check ("RCK") entry and the original check were presented
2693
+ * to the bank.
2694
+ * - `item_related_to_rck_entry_is_ineligible` - Code R51. A rare return reason.
2695
+ * The Represented Check ("RCK") entry is ineligible.
2696
+ * - `mandatory_field_error` - Code R26. A rare return reason. The ACH is missing a
2697
+ * required field.
2698
+ * - `misrouted_dishonored_return` - Code R71. A rare return reason. The receiving
2699
+ * bank does not recognize the routing number in a dishonored return entry.
2700
+ * - `misrouted_return` - Code R61. A rare return reason. The receiving bank does
2701
+ * not recognize the routing number in a return entry.
2702
+ * - `no_errors_found` - Code R76. A rare return reason. Sent in response to a
2703
+ * return, the bank does not find the errors alleged by the returning bank.
2704
+ * - `non_acceptance_of_r62_dishonored_return` - Code R77. A rare return reason.
2705
+ * The receiving bank does not accept the return of the erroneous debit. The
2706
+ * funds are not available at the receiving bank.
2707
+ * - `non_participant_in_iat_program` - Code R81. A rare return reason. The
2708
+ * receiving bank does not accept International ACH Transfers.
2709
+ * - `permissible_return_entry` - Code R31. A rare return reason. A return that has
2710
+ * been agreed to be accepted by the receiving bank, despite falling outside of
2711
+ * the usual return timeframe.
2712
+ * - `permissible_return_entry_not_accepted` - Code R70. A rare return reason. The
2713
+ * receiving bank had not approved this return.
2714
+ * - `rdfi_non_settlement` - Code R32. A rare return reason. The receiving bank
2715
+ * could not settle this transaction.
2716
+ * - `rdfi_participant_in_check_truncation_program` - Code R30. A rare return
2717
+ * reason. The receiving bank does not accept Check Truncation ACH transfers.
2718
+ * - `representative_payee_deceased_or_unable_to_continue_in_that_capacity` - Code
2719
+ * R14. A rare return reason. The payee is deceased.
2720
+ * - `return_not_a_duplicate` - Code R75. A rare return reason. The originating
2721
+ * bank disputes that an earlier `duplicate_entry` return was actually a
2722
+ * duplicate.
2723
+ * - `return_of_erroneous_or_reversing_debit` - Code R62. A rare return reason. The
2724
+ * originating bank made a mistake earlier and this return corrects it.
2725
+ * - `return_of_improper_credit_entry` - Code R36. A rare return reason. Return of
2726
+ * a malformed credit entry.
2727
+ * - `return_of_improper_debit_entry` - Code R35. A rare return reason. Return of a
2728
+ * malformed debit entry.
2729
+ * - `return_of_xck_entry` - Code R33. A rare return reason. Return of a Destroyed
2730
+ * Check ("XKC") entry.
2731
+ * - `source_document_presented_for_payment` - Code R37. A rare return reason. The
2732
+ * source document related to this ACH, usually an ACH check conversion, was
2733
+ * presented to the bank.
2734
+ * - `state_law_affecting_rck_acceptance` - Code R50. A rare return reason. State
2735
+ * law prevents the bank from accepting the Represented Check ("RCK") entry.
2736
+ * - `stop_payment_on_item_related_to_rck_entry` - Code R52. A rare return reason.
2737
+ * A stop payment was issued on a Represented Check ("RCK") entry.
2738
+ * - `stop_payment_on_source_document` - Code R38. A rare return reason. The source
2739
+ * attached to the ACH, usually an ACH check conversion, includes a stop payment.
2740
+ * - `timely_original_return` - Code R73. A rare return reason. The bank receiving
2741
+ * an `untimely_return` believes it was on time.
2742
+ * - `trace_number_error` - Code R27. A rare return reason. An ACH Return's trace
2743
+ * number does not match an originated ACH.
2744
+ * - `untimely_dishonored_return` - Code R72. A rare return reason. The dishonored
2745
+ * return was sent too late.
2746
+ * - `untimely_return` - Code R68. A rare return reason. The return was sent too
2747
+ * late.
2748
+ */
2749
+ reason?:
2750
+ | 'insufficient_fund'
2751
+ | 'no_account'
2752
+ | 'account_closed'
2753
+ | 'invalid_account_number_structure'
2754
+ | 'account_frozen_entry_returned_per_ofac_instruction'
2755
+ | 'credit_entry_refused_by_receiver'
2756
+ | 'unauthorized_debit_to_consumer_account_using_corporate_sec_code'
2757
+ | 'corporate_customer_advised_not_authorized'
2758
+ | 'payment_stopped'
2759
+ | 'non_transaction_account'
2760
+ | 'uncollected_funds'
2761
+ | 'routing_number_check_digit_error'
2762
+ | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
2763
+ | 'amount_field_error'
2764
+ | 'authorization_revoked_by_customer'
2765
+ | 'invalid_ach_routing_number'
2766
+ | 'file_record_edit_criteria'
2767
+ | 'enr_invalid_individual_name'
2768
+ | 'returned_per_odfi_request'
2769
+ | 'limited_participation_dfi'
2770
+ | 'incorrectly_coded_outbound_international_payment'
2771
+ | 'account_sold_to_another_dfi'
2772
+ | 'addenda_error'
2773
+ | 'beneficiary_or_account_holder_deceased'
2774
+ | 'customer_advised_not_within_authorization_terms'
2775
+ | 'corrected_return'
2776
+ | 'duplicate_entry'
2777
+ | 'duplicate_return'
2778
+ | 'enr_duplicate_enrollment'
2779
+ | 'enr_invalid_dfi_account_number'
2780
+ | 'enr_invalid_individual_id_number'
2781
+ | 'enr_invalid_representative_payee_indicator'
2782
+ | 'enr_invalid_transaction_code'
2783
+ | 'enr_return_of_enr_entry'
2784
+ | 'enr_routing_number_check_digit_error'
2785
+ | 'entry_not_processed_by_gateway'
2786
+ | 'field_error'
2787
+ | 'foreign_receiving_dfi_unable_to_settle'
2788
+ | 'iat_entry_coding_error'
2789
+ | 'improper_effective_entry_date'
2790
+ | 'improper_source_document_source_document_presented'
2791
+ | 'invalid_company_id'
2792
+ | 'invalid_foreign_receiving_dfi_identification'
2793
+ | 'invalid_individual_id_number'
2794
+ | 'item_and_rck_entry_presented_for_payment'
2795
+ | 'item_related_to_rck_entry_is_ineligible'
2796
+ | 'mandatory_field_error'
2797
+ | 'misrouted_dishonored_return'
2798
+ | 'misrouted_return'
2799
+ | 'no_errors_found'
2800
+ | 'non_acceptance_of_r62_dishonored_return'
2801
+ | 'non_participant_in_iat_program'
2802
+ | 'permissible_return_entry'
2803
+ | 'permissible_return_entry_not_accepted'
2804
+ | 'rdfi_non_settlement'
2805
+ | 'rdfi_participant_in_check_truncation_program'
2806
+ | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
2807
+ | 'return_not_a_duplicate'
2808
+ | 'return_of_erroneous_or_reversing_debit'
2809
+ | 'return_of_improper_credit_entry'
2810
+ | 'return_of_improper_debit_entry'
2811
+ | 'return_of_xck_entry'
2812
+ | 'source_document_presented_for_payment'
2813
+ | 'state_law_affecting_rck_acceptance'
2814
+ | 'stop_payment_on_item_related_to_rck_entry'
2815
+ | 'stop_payment_on_source_document'
2816
+ | 'timely_original_return'
2817
+ | 'trace_number_error'
2818
+ | 'untimely_dishonored_return'
2819
+ | 'untimely_return';
2820
+ }
2821
+
2822
+ export namespace ACHTransfers {
2823
+ export import ACHTransferSimulation = API.ACHTransferSimulation;
2824
+ export import ACHTransferCreateInboundParams = API.ACHTransferCreateInboundParams;
2825
+ export import ACHTransferReturnParams = API.ACHTransferReturnParams;
2826
+ }