increase 0.4.0 → 0.5.0

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