increase 0.11.1 → 0.11.3

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 (532) hide show
  1. package/CHANGELOG.md +31 -0
  2. package/README.md +7 -3
  3. package/_shims/MultipartBody.d.ts +9 -0
  4. package/_shims/MultipartBody.d.ts.map +1 -0
  5. package/_shims/MultipartBody.js +16 -0
  6. package/_shims/MultipartBody.js.map +1 -0
  7. package/_shims/MultipartBody.mjs +12 -0
  8. package/_shims/MultipartBody.mjs.map +1 -0
  9. package/_shims/README.md +46 -0
  10. package/{src/_shims/ReadableStream-node.ts → _shims/auto/runtime-bun.d.ts} +2 -3
  11. package/_shims/auto/runtime-bun.d.ts.map +1 -0
  12. package/_shims/auto/runtime-bun.js +21 -0
  13. package/_shims/auto/runtime-bun.js.map +1 -0
  14. package/_shims/auto/runtime-bun.mjs +2 -0
  15. package/_shims/auto/runtime-bun.mjs.map +1 -0
  16. package/_shims/auto/runtime-node.d.ts +5 -0
  17. package/_shims/auto/runtime-node.d.ts.map +1 -0
  18. package/_shims/auto/runtime-node.js +21 -0
  19. package/_shims/auto/runtime-node.js.map +1 -0
  20. package/_shims/auto/runtime-node.mjs +2 -0
  21. package/_shims/auto/runtime-node.mjs.map +1 -0
  22. package/_shims/auto/runtime.d.ts +5 -0
  23. package/_shims/auto/runtime.d.ts.map +1 -0
  24. package/_shims/auto/runtime.js +21 -0
  25. package/_shims/auto/runtime.js.map +1 -0
  26. package/_shims/auto/runtime.mjs +2 -0
  27. package/_shims/auto/runtime.mjs.map +1 -0
  28. package/_shims/auto/types-node.d.ts +5 -0
  29. package/_shims/auto/types-node.d.ts.map +1 -0
  30. package/_shims/auto/types-node.js +21 -0
  31. package/_shims/auto/types-node.js.map +1 -0
  32. package/_shims/auto/types-node.mjs +2 -0
  33. package/_shims/auto/types-node.mjs.map +1 -0
  34. package/_shims/auto/types.d.ts +99 -0
  35. package/_shims/{ReadableStream.js → auto/types.js} +0 -2
  36. package/{src/_shims/ReadableStream.js → _shims/auto/types.mjs} +0 -2
  37. package/_shims/bun-runtime.d.ts +6 -0
  38. package/_shims/bun-runtime.d.ts.map +1 -0
  39. package/_shims/bun-runtime.js +14 -0
  40. package/_shims/bun-runtime.js.map +1 -0
  41. package/_shims/bun-runtime.mjs +10 -0
  42. package/_shims/bun-runtime.mjs.map +1 -0
  43. package/_shims/index.d.ts +79 -0
  44. package/_shims/index.js +13 -0
  45. package/_shims/index.mjs +7 -0
  46. package/_shims/manual-types.d.ts +12 -0
  47. package/_shims/manual-types.js +3 -0
  48. package/_shims/manual-types.mjs +3 -0
  49. package/_shims/node-runtime.d.ts +3 -0
  50. package/_shims/node-runtime.d.ts.map +1 -0
  51. package/_shims/node-runtime.js +87 -0
  52. package/_shims/node-runtime.js.map +1 -0
  53. package/_shims/node-runtime.mjs +54 -0
  54. package/_shims/node-runtime.mjs.map +1 -0
  55. package/_shims/node-types.d.ts +42 -0
  56. package/_shims/node-types.js +3 -0
  57. package/_shims/node-types.mjs +3 -0
  58. package/_shims/registry.d.ts +35 -0
  59. package/_shims/registry.d.ts.map +1 -0
  60. package/_shims/registry.js +39 -0
  61. package/_shims/registry.js.map +1 -0
  62. package/_shims/registry.mjs +35 -0
  63. package/_shims/registry.mjs.map +1 -0
  64. package/_shims/web-runtime.d.ts +5 -0
  65. package/_shims/web-runtime.d.ts.map +1 -0
  66. package/_shims/web-runtime.js +70 -0
  67. package/_shims/web-runtime.js.map +1 -0
  68. package/_shims/web-runtime.mjs +63 -0
  69. package/_shims/web-runtime.mjs.map +1 -0
  70. package/_shims/web-types.d.ts +82 -0
  71. package/_shims/web-types.js +3 -0
  72. package/_shims/web-types.mjs +3 -0
  73. package/core.d.ts +170 -218
  74. package/core.d.ts.map +1 -1
  75. package/core.js +682 -731
  76. package/core.js.map +1 -1
  77. package/core.mjs +676 -682
  78. package/core.mjs.map +1 -1
  79. package/error.d.ts +107 -178
  80. package/error.d.ts.map +1 -1
  81. package/error.js +251 -281
  82. package/error.js.map +1 -1
  83. package/error.mjs +247 -253
  84. package/error.mjs.map +1 -1
  85. package/index.d.mts +333 -356
  86. package/index.d.ts +333 -356
  87. package/index.d.ts.map +1 -1
  88. package/index.js +194 -264
  89. package/index.js.map +1 -1
  90. package/index.mjs +171 -198
  91. package/index.mjs.map +1 -1
  92. package/package.json +31 -58
  93. package/pagination.d.ts +25 -25
  94. package/pagination.js +29 -25
  95. package/pagination.mjs +27 -23
  96. package/resource.d.ts +10 -10
  97. package/resource.js +12 -12
  98. package/resource.mjs +10 -10
  99. package/resources/account-numbers.d.ts +202 -168
  100. package/resources/account-numbers.d.ts.map +1 -1
  101. package/resources/account-numbers.js +33 -31
  102. package/resources/account-numbers.js.map +1 -1
  103. package/resources/account-numbers.mjs +28 -26
  104. package/resources/account-numbers.mjs.map +1 -1
  105. package/resources/account-statements.d.ts +79 -81
  106. package/resources/account-statements.js +21 -21
  107. package/resources/account-statements.mjs +16 -14
  108. package/resources/account-transfers.d.ts +192 -194
  109. package/resources/account-transfers.js +39 -39
  110. package/resources/account-transfers.mjs +34 -32
  111. package/resources/accounts.d.ts +148 -151
  112. package/resources/accounts.js +39 -37
  113. package/resources/accounts.mjs +34 -32
  114. package/resources/ach-prenotifications.d.ts +370 -438
  115. package/resources/ach-prenotifications.d.ts.map +1 -1
  116. package/resources/ach-prenotifications.js +27 -27
  117. package/resources/ach-prenotifications.js.map +1 -1
  118. package/resources/ach-prenotifications.mjs +22 -20
  119. package/resources/ach-prenotifications.mjs.map +1 -1
  120. package/resources/ach-transfers.d.ts +604 -679
  121. package/resources/ach-transfers.d.ts.map +1 -1
  122. package/resources/ach-transfers.js +39 -37
  123. package/resources/ach-transfers.js.map +1 -1
  124. package/resources/ach-transfers.mjs +34 -32
  125. package/resources/ach-transfers.mjs.map +1 -1
  126. package/resources/balance-lookups.d.ts +35 -38
  127. package/resources/balance-lookups.js +12 -11
  128. package/resources/balance-lookups.mjs +9 -8
  129. package/resources/bookkeeping-accounts.d.ts +66 -70
  130. package/resources/bookkeeping-accounts.js +21 -21
  131. package/resources/bookkeeping-accounts.mjs +16 -14
  132. package/resources/bookkeeping-entries.d.ts +36 -37
  133. package/resources/bookkeeping-entries.js +15 -15
  134. package/resources/bookkeeping-entries.mjs +10 -8
  135. package/resources/bookkeeping-entry-sets.d.ts +61 -64
  136. package/resources/bookkeeping-entry-sets.js +12 -13
  137. package/resources/bookkeeping-entry-sets.mjs +9 -8
  138. package/resources/card-disputes.d.ts +127 -129
  139. package/resources/card-disputes.js +27 -25
  140. package/resources/card-disputes.mjs +22 -20
  141. package/resources/card-profiles.d.ts +235 -245
  142. package/resources/card-profiles.js +33 -31
  143. package/resources/card-profiles.mjs +28 -26
  144. package/resources/card-purchase-supplements.d.ts +219 -238
  145. package/resources/card-purchase-supplements.js +21 -21
  146. package/resources/card-purchase-supplements.mjs +16 -14
  147. package/resources/cards.d.ts +288 -279
  148. package/resources/cards.d.ts.map +1 -1
  149. package/resources/cards.js +39 -37
  150. package/resources/cards.js.map +1 -1
  151. package/resources/cards.mjs +34 -32
  152. package/resources/cards.mjs.map +1 -1
  153. package/resources/check-deposits.d.ts +238 -260
  154. package/resources/check-deposits.js +27 -25
  155. package/resources/check-deposits.mjs +22 -20
  156. package/resources/check-transfers.d.ts +487 -503
  157. package/resources/check-transfers.js +45 -43
  158. package/resources/check-transfers.mjs +40 -38
  159. package/resources/declined-transactions.d.ts +811 -926
  160. package/resources/declined-transactions.d.ts.map +1 -1
  161. package/resources/declined-transactions.js +21 -21
  162. package/resources/declined-transactions.js.map +1 -1
  163. package/resources/declined-transactions.mjs +16 -14
  164. package/resources/declined-transactions.mjs.map +1 -1
  165. package/resources/digital-wallet-tokens.d.ts +75 -77
  166. package/resources/digital-wallet-tokens.js +21 -21
  167. package/resources/digital-wallet-tokens.mjs +16 -14
  168. package/resources/documents.d.ts +78 -77
  169. package/resources/documents.js +21 -19
  170. package/resources/documents.mjs +16 -14
  171. package/resources/entities/beneficial-owners.d.ts +233 -244
  172. package/resources/entities/beneficial-owners.js +24 -25
  173. package/resources/entities/beneficial-owners.mjs +21 -20
  174. package/resources/entities/entities.d.ts +1532 -1585
  175. package/resources/entities/entities.d.ts.map +1 -1
  176. package/resources/entities/entities.js +67 -83
  177. package/resources/entities/entities.mjs +43 -42
  178. package/resources/entities/index.d.ts +4 -22
  179. package/resources/entities/index.js +12 -42
  180. package/resources/entities/index.mjs +4 -4
  181. package/resources/entities/supplemental-documents.d.ts +38 -44
  182. package/resources/entities/supplemental-documents.js +24 -24
  183. package/resources/entities/supplemental-documents.mjs +20 -18
  184. package/resources/event-subscriptions.d.ts +246 -355
  185. package/resources/event-subscriptions.d.ts.map +1 -1
  186. package/resources/event-subscriptions.js +33 -33
  187. package/resources/event-subscriptions.js.map +1 -1
  188. package/resources/event-subscriptions.mjs +28 -26
  189. package/resources/event-subscriptions.mjs.map +1 -1
  190. package/resources/events.d.ts +152 -254
  191. package/resources/events.d.ts.map +1 -1
  192. package/resources/events.js +21 -19
  193. package/resources/events.js.map +1 -1
  194. package/resources/events.mjs +16 -14
  195. package/resources/events.mjs.map +1 -1
  196. package/resources/exports.d.ts +210 -158
  197. package/resources/exports.d.ts.map +1 -1
  198. package/resources/exports.js +27 -25
  199. package/resources/exports.js.map +1 -1
  200. package/resources/exports.mjs +22 -20
  201. package/resources/exports.mjs.map +1 -1
  202. package/resources/external-accounts.d.ts +122 -128
  203. package/resources/external-accounts.js +33 -33
  204. package/resources/external-accounts.mjs +28 -26
  205. package/resources/files.d.ts +149 -196
  206. package/resources/files.js +30 -28
  207. package/resources/files.mjs +24 -22
  208. package/resources/groups.d.ts +35 -35
  209. package/resources/groups.js +12 -11
  210. package/resources/groups.mjs +9 -8
  211. package/resources/inbound-ach-transfers.d.ts +270 -305
  212. package/resources/inbound-ach-transfers.d.ts.map +1 -1
  213. package/resources/inbound-ach-transfers.js +42 -42
  214. package/resources/inbound-ach-transfers.js.map +1 -1
  215. package/resources/inbound-ach-transfers.mjs +37 -35
  216. package/resources/inbound-ach-transfers.mjs.map +1 -1
  217. package/resources/inbound-wire-drawdown-requests.d.ts +113 -119
  218. package/resources/inbound-wire-drawdown-requests.js +24 -25
  219. package/resources/inbound-wire-drawdown-requests.mjs +19 -19
  220. package/resources/index.d.ts +39 -205
  221. package/resources/index.js +114 -540
  222. package/resources/index.mjs +39 -42
  223. package/resources/oauth-connections.d.ts +43 -44
  224. package/resources/oauth-connections.js +21 -21
  225. package/resources/oauth-connections.mjs +16 -14
  226. package/resources/pending-transactions.d.ts +560 -601
  227. package/resources/pending-transactions.js +21 -21
  228. package/resources/pending-transactions.mjs +16 -14
  229. package/resources/programs.d.ts +41 -39
  230. package/resources/programs.js +21 -19
  231. package/resources/programs.mjs +16 -14
  232. package/resources/real-time-decisions.d.ts +384 -411
  233. package/resources/real-time-decisions.js +18 -19
  234. package/resources/real-time-decisions.mjs +15 -14
  235. package/resources/real-time-payments-transfers.d.ts +304 -342
  236. package/resources/real-time-payments-transfers.js +30 -30
  237. package/resources/real-time-payments-transfers.mjs +25 -23
  238. package/resources/routing-numbers.d.ts +52 -54
  239. package/resources/routing-numbers.js +18 -16
  240. package/resources/routing-numbers.mjs +14 -12
  241. package/resources/simulations/account-statements.d.ts +12 -15
  242. package/resources/simulations/account-statements.js +13 -14
  243. package/resources/simulations/account-statements.mjs +10 -9
  244. package/resources/simulations/account-transfers.d.ts +8 -11
  245. package/resources/simulations/account-transfers.js +13 -13
  246. package/resources/simulations/account-transfers.mjs +10 -10
  247. package/resources/simulations/ach-transfers.d.ts +3636 -3845
  248. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  249. package/resources/simulations/ach-transfers.js +40 -35
  250. package/resources/simulations/ach-transfers.js.map +1 -1
  251. package/resources/simulations/ach-transfers.mjs +37 -32
  252. package/resources/simulations/ach-transfers.mjs.map +1 -1
  253. package/resources/simulations/card-disputes.d.ts +22 -26
  254. package/resources/simulations/card-disputes.js +15 -14
  255. package/resources/simulations/card-disputes.mjs +12 -11
  256. package/resources/simulations/card-profiles.d.ts +9 -9
  257. package/resources/simulations/card-profiles.js +14 -14
  258. package/resources/simulations/card-profiles.mjs +11 -11
  259. package/resources/simulations/card-refunds.d.ts +13 -16
  260. package/resources/simulations/card-refunds.js +13 -12
  261. package/resources/simulations/card-refunds.mjs +10 -9
  262. package/resources/simulations/cards.d.ts +1311 -1448
  263. package/resources/simulations/cards.d.ts.map +1 -1
  264. package/resources/simulations/cards.js +28 -27
  265. package/resources/simulations/cards.js.map +1 -1
  266. package/resources/simulations/cards.mjs +25 -24
  267. package/resources/simulations/cards.mjs.map +1 -1
  268. package/resources/simulations/check-deposits.d.ts +17 -17
  269. package/resources/simulations/check-deposits.js +26 -26
  270. package/resources/simulations/check-deposits.mjs +23 -23
  271. package/resources/simulations/check-transfers.d.ts +12 -18
  272. package/resources/simulations/check-transfers.js +19 -19
  273. package/resources/simulations/check-transfers.mjs +16 -16
  274. package/resources/simulations/digital-wallet-token-requests.d.ts +35 -43
  275. package/resources/simulations/digital-wallet-token-requests.js +13 -15
  276. package/resources/simulations/digital-wallet-token-requests.mjs +10 -9
  277. package/resources/simulations/documents.d.ts +11 -11
  278. package/resources/simulations/documents.js +12 -11
  279. package/resources/simulations/documents.mjs +9 -8
  280. package/resources/simulations/inbound-funds-holds.d.ts +63 -66
  281. package/resources/simulations/inbound-funds-holds.js +13 -14
  282. package/resources/simulations/inbound-funds-holds.mjs +10 -9
  283. package/resources/simulations/inbound-wire-drawdown-requests.d.ts +94 -97
  284. package/resources/simulations/inbound-wire-drawdown-requests.js +13 -15
  285. package/resources/simulations/inbound-wire-drawdown-requests.mjs +10 -11
  286. package/resources/simulations/index.d.ts +19 -40
  287. package/resources/simulations/index.js +40 -148
  288. package/resources/simulations/index.mjs +19 -19
  289. package/resources/simulations/interest-payments.d.ts +2503 -2752
  290. package/resources/simulations/interest-payments.d.ts.map +1 -1
  291. package/resources/simulations/interest-payments.js +13 -14
  292. package/resources/simulations/interest-payments.js.map +1 -1
  293. package/resources/simulations/interest-payments.mjs +10 -9
  294. package/resources/simulations/interest-payments.mjs.map +1 -1
  295. package/resources/simulations/programs.d.ts +13 -13
  296. package/resources/simulations/programs.js +14 -13
  297. package/resources/simulations/programs.mjs +11 -10
  298. package/resources/simulations/real-time-payments-transfers.d.ts +3368 -3744
  299. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  300. package/resources/simulations/real-time-payments-transfers.js +24 -25
  301. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  302. package/resources/simulations/real-time-payments-transfers.mjs +21 -20
  303. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  304. package/resources/simulations/simulations.d.ts +75 -75
  305. package/resources/simulations/simulations.js +78 -101
  306. package/resources/simulations/simulations.mjs +56 -56
  307. package/resources/simulations/wire-transfers.d.ts +2566 -2810
  308. package/resources/simulations/wire-transfers.d.ts.map +1 -1
  309. package/resources/simulations/wire-transfers.js +12 -11
  310. package/resources/simulations/wire-transfers.js.map +1 -1
  311. package/resources/simulations/wire-transfers.mjs +9 -8
  312. package/resources/simulations/wire-transfers.mjs.map +1 -1
  313. package/resources/transactions.d.ts +2559 -2838
  314. package/resources/transactions.d.ts.map +1 -1
  315. package/resources/transactions.js +21 -19
  316. package/resources/transactions.js.map +1 -1
  317. package/resources/transactions.mjs +16 -14
  318. package/resources/transactions.mjs.map +1 -1
  319. package/resources/wire-drawdown-requests.d.ts +140 -147
  320. package/resources/wire-drawdown-requests.js +27 -27
  321. package/resources/wire-drawdown-requests.mjs +22 -20
  322. package/resources/wire-transfers.d.ts +320 -324
  323. package/resources/wire-transfers.d.ts.map +1 -1
  324. package/resources/wire-transfers.js +56 -54
  325. package/resources/wire-transfers.js.map +1 -1
  326. package/resources/wire-transfers.mjs +51 -49
  327. package/resources/wire-transfers.mjs.map +1 -1
  328. package/shims/node.d.ts +29 -0
  329. package/shims/node.d.ts.map +1 -0
  330. package/shims/node.js +31 -0
  331. package/shims/node.js.map +1 -0
  332. package/shims/node.mjs +5 -0
  333. package/shims/node.mjs.map +1 -0
  334. package/shims/web.d.ts +26 -0
  335. package/shims/web.d.ts.map +1 -0
  336. package/shims/web.js +31 -0
  337. package/shims/web.js.map +1 -0
  338. package/shims/web.mjs +5 -0
  339. package/shims/web.mjs.map +1 -0
  340. package/src/_shims/MultipartBody.ts +9 -0
  341. package/src/_shims/README.md +46 -0
  342. package/src/_shims/auto/runtime-bun.ts +4 -0
  343. package/src/_shims/auto/runtime-node.ts +4 -0
  344. package/src/_shims/auto/runtime.ts +4 -0
  345. package/src/_shims/auto/types-node.ts +4 -0
  346. package/src/_shims/auto/types.d.ts +99 -0
  347. package/src/_shims/auto/types.js +3 -0
  348. package/src/_shims/auto/types.mjs +3 -0
  349. package/src/_shims/bun-runtime.ts +14 -0
  350. package/src/_shims/index.d.ts +79 -0
  351. package/src/_shims/index.js +13 -0
  352. package/src/_shims/index.mjs +7 -0
  353. package/src/_shims/manual-types.d.ts +12 -0
  354. package/src/_shims/manual-types.js +3 -0
  355. package/src/_shims/manual-types.mjs +3 -0
  356. package/src/_shims/node-runtime.ts +79 -0
  357. package/src/_shims/node-types.d.ts +42 -0
  358. package/src/_shims/node-types.js +3 -0
  359. package/src/_shims/node-types.mjs +3 -0
  360. package/src/_shims/registry.ts +64 -0
  361. package/src/_shims/web-runtime.ts +91 -0
  362. package/src/_shims/web-types.d.ts +82 -0
  363. package/src/_shims/web-types.js +3 -0
  364. package/src/_shims/web-types.mjs +3 -0
  365. package/src/core.ts +71 -43
  366. package/src/error.ts +4 -2
  367. package/src/index.ts +9 -7
  368. package/src/pagination.ts +1 -1
  369. package/src/resource.ts +1 -1
  370. package/src/resources/account-numbers.ts +49 -5
  371. package/src/resources/account-statements.ts +5 -5
  372. package/src/resources/account-transfers.ts +5 -5
  373. package/src/resources/accounts.ts +5 -5
  374. package/src/resources/ach-prenotifications.ts +45 -16
  375. package/src/resources/ach-transfers.ts +47 -17
  376. package/src/resources/balance-lookups.ts +3 -3
  377. package/src/resources/bookkeeping-accounts.ts +5 -5
  378. package/src/resources/bookkeeping-entries.ts +5 -5
  379. package/src/resources/bookkeeping-entry-sets.ts +3 -3
  380. package/src/resources/card-disputes.ts +5 -5
  381. package/src/resources/card-profiles.ts +5 -5
  382. package/src/resources/card-purchase-supplements.ts +5 -5
  383. package/src/resources/cards.ts +15 -5
  384. package/src/resources/check-deposits.ts +5 -5
  385. package/src/resources/check-transfers.ts +5 -5
  386. package/src/resources/declined-transactions.ts +11 -5
  387. package/src/resources/digital-wallet-tokens.ts +5 -5
  388. package/src/resources/documents.ts +5 -5
  389. package/src/resources/entities/beneficial-owners.ts +5 -5
  390. package/src/resources/entities/entities.ts +18 -18
  391. package/src/resources/entities/index.ts +3 -3
  392. package/src/resources/entities/supplemental-documents.ts +5 -5
  393. package/src/resources/event-subscriptions.ts +13 -5
  394. package/src/resources/events.ts +11 -5
  395. package/src/resources/exports.ts +64 -7
  396. package/src/resources/external-accounts.ts +5 -5
  397. package/src/resources/files.ts +6 -6
  398. package/src/resources/groups.ts +3 -3
  399. package/src/resources/inbound-ach-transfers.ts +11 -5
  400. package/src/resources/inbound-wire-drawdown-requests.ts +5 -5
  401. package/src/resources/index.ts +38 -38
  402. package/src/resources/oauth-connections.ts +5 -5
  403. package/src/resources/pending-transactions.ts +5 -5
  404. package/src/resources/programs.ts +5 -5
  405. package/src/resources/real-time-decisions.ts +3 -3
  406. package/src/resources/real-time-payments-transfers.ts +5 -5
  407. package/src/resources/routing-numbers.ts +4 -4
  408. package/src/resources/simulations/account-statements.ts +4 -4
  409. package/src/resources/simulations/account-transfers.ts +3 -3
  410. package/src/resources/simulations/ach-transfers.ts +333 -29
  411. package/src/resources/simulations/card-disputes.ts +4 -4
  412. package/src/resources/simulations/card-profiles.ts +3 -3
  413. package/src/resources/simulations/card-refunds.ts +4 -4
  414. package/src/resources/simulations/cards.ts +10 -4
  415. package/src/resources/simulations/check-deposits.ts +3 -3
  416. package/src/resources/simulations/check-transfers.ts +3 -3
  417. package/src/resources/simulations/digital-wallet-token-requests.ts +3 -3
  418. package/src/resources/simulations/documents.ts +4 -4
  419. package/src/resources/simulations/inbound-funds-holds.ts +3 -3
  420. package/src/resources/simulations/inbound-wire-drawdown-requests.ts +4 -4
  421. package/src/resources/simulations/index.ts +18 -18
  422. package/src/resources/simulations/interest-payments.ts +42 -14
  423. package/src/resources/simulations/programs.ts +4 -4
  424. package/src/resources/simulations/real-time-payments-transfers.ts +49 -15
  425. package/src/resources/simulations/simulations.ts +19 -19
  426. package/src/resources/simulations/wire-transfers.ts +48 -14
  427. package/src/resources/transactions.ts +44 -16
  428. package/src/resources/wire-drawdown-requests.ts +5 -5
  429. package/src/resources/wire-transfers.ts +11 -5
  430. package/src/shims/node.ts +50 -0
  431. package/src/shims/web.ts +50 -0
  432. package/src/uploads.ts +12 -16
  433. package/src/version.ts +1 -1
  434. package/uploads.d.ts +23 -39
  435. package/uploads.d.ts.map +1 -1
  436. package/uploads.js +115 -157
  437. package/uploads.js.map +1 -1
  438. package/uploads.mjs +111 -133
  439. package/uploads.mjs.map +1 -1
  440. package/version.d.ts +2 -2
  441. package/version.js +4 -4
  442. package/version.mjs +2 -2
  443. package/_shims/ReadableStream-node.d.ts +0 -6
  444. package/_shims/ReadableStream-node.d.ts.map +0 -1
  445. package/_shims/ReadableStream-node.js +0 -14
  446. package/_shims/ReadableStream-node.js.map +0 -1
  447. package/_shims/ReadableStream-node.mjs +0 -3
  448. package/_shims/ReadableStream-node.mjs.map +0 -1
  449. package/_shims/ReadableStream.d.ts +0 -38
  450. package/_shims/ReadableStream.mjs +0 -7
  451. package/_shims/agent-node.d.ts +0 -7
  452. package/_shims/agent-node.d.ts.map +0 -1
  453. package/_shims/agent-node.js +0 -28
  454. package/_shims/agent-node.js.map +0 -1
  455. package/_shims/agent-node.mjs +0 -16
  456. package/_shims/agent-node.mjs.map +0 -1
  457. package/_shims/agent.d.ts +0 -9
  458. package/_shims/agent.d.ts.map +0 -1
  459. package/_shims/agent.js +0 -14
  460. package/_shims/agent.js.map +0 -1
  461. package/_shims/agent.mjs +0 -10
  462. package/_shims/agent.mjs.map +0 -1
  463. package/_shims/fetch-node.d.ts +0 -64
  464. package/_shims/fetch-node.js +0 -12
  465. package/_shims/fetch-node.mjs +0 -14
  466. package/_shims/fetch.d.ts +0 -60
  467. package/_shims/fetch.js +0 -13
  468. package/_shims/fetch.mjs +0 -15
  469. package/_shims/fileFromPath-node.d.ts +0 -17
  470. package/_shims/fileFromPath-node.d.ts.map +0 -1
  471. package/_shims/fileFromPath-node.js +0 -17
  472. package/_shims/fileFromPath-node.js.map +0 -1
  473. package/_shims/fileFromPath-node.mjs +0 -13
  474. package/_shims/fileFromPath-node.mjs.map +0 -1
  475. package/_shims/fileFromPath.d.ts +0 -22
  476. package/_shims/fileFromPath.d.ts.map +0 -1
  477. package/_shims/fileFromPath.js +0 -16
  478. package/_shims/fileFromPath.js.map +0 -1
  479. package/_shims/fileFromPath.mjs +0 -12
  480. package/_shims/fileFromPath.mjs.map +0 -1
  481. package/_shims/form-data-node.d.ts +0 -45
  482. package/_shims/form-data-node.js +0 -11
  483. package/_shims/form-data-node.mjs +0 -9
  484. package/_shims/form-data.d.ts +0 -43
  485. package/_shims/form-data.js +0 -17
  486. package/_shims/form-data.mjs +0 -20
  487. package/_shims/getMultipartRequestOptions-node.d.ts +0 -10
  488. package/_shims/getMultipartRequestOptions-node.d.ts.map +0 -1
  489. package/_shims/getMultipartRequestOptions-node.js +0 -22
  490. package/_shims/getMultipartRequestOptions-node.js.map +0 -1
  491. package/_shims/getMultipartRequestOptions-node.mjs +0 -18
  492. package/_shims/getMultipartRequestOptions-node.mjs.map +0 -1
  493. package/_shims/getMultipartRequestOptions.d.ts +0 -10
  494. package/_shims/getMultipartRequestOptions.d.ts.map +0 -1
  495. package/_shims/getMultipartRequestOptions.js +0 -12
  496. package/_shims/getMultipartRequestOptions.js.map +0 -1
  497. package/_shims/getMultipartRequestOptions.mjs +0 -8
  498. package/_shims/getMultipartRequestOptions.mjs.map +0 -1
  499. package/_shims/node-readable-node.d.ts +0 -8
  500. package/_shims/node-readable-node.d.ts.map +0 -1
  501. package/_shims/node-readable-node.js +0 -9
  502. package/_shims/node-readable-node.js.map +0 -1
  503. package/_shims/node-readable-node.mjs +0 -5
  504. package/_shims/node-readable-node.mjs.map +0 -1
  505. package/_shims/node-readable.d.ts +0 -23
  506. package/_shims/node-readable.d.ts.map +0 -1
  507. package/_shims/node-readable.js +0 -11
  508. package/_shims/node-readable.js.map +0 -1
  509. package/_shims/node-readable.mjs +0 -7
  510. package/_shims/node-readable.mjs.map +0 -1
  511. package/src/_shims/ReadableStream.d.ts +0 -38
  512. package/src/_shims/ReadableStream.mjs +0 -7
  513. package/src/_shims/agent-node.ts +0 -22
  514. package/src/_shims/agent.ts +0 -12
  515. package/src/_shims/fetch-node.d.ts +0 -64
  516. package/src/_shims/fetch-node.js +0 -12
  517. package/src/_shims/fetch-node.mjs +0 -14
  518. package/src/_shims/fetch.d.ts +0 -60
  519. package/src/_shims/fetch.js +0 -13
  520. package/src/_shims/fetch.mjs +0 -15
  521. package/src/_shims/fileFromPath-node.ts +0 -29
  522. package/src/_shims/fileFromPath.ts +0 -29
  523. package/src/_shims/form-data-node.d.ts +0 -45
  524. package/src/_shims/form-data-node.js +0 -11
  525. package/src/_shims/form-data-node.mjs +0 -9
  526. package/src/_shims/form-data.d.ts +0 -43
  527. package/src/_shims/form-data.js +0 -17
  528. package/src/_shims/form-data.mjs +0 -20
  529. package/src/_shims/getMultipartRequestOptions-node.ts +0 -25
  530. package/src/_shims/getMultipartRequestOptions.ts +0 -14
  531. package/src/_shims/node-readable-node.ts +0 -10
  532. package/src/_shims/node-readable.ts +0 -30
@@ -1,658 +1,617 @@
1
1
  import * as Core from 'increase/core';
2
2
  import { APIResource } from 'increase/resource';
3
- import * as API from './index.js';
3
+ import * as API from "./index.js";
4
4
  import { Page, PageParams } from 'increase/pagination';
5
5
  export declare class PendingTransactions extends APIResource {
6
- /**
7
- * Retrieve a Pending Transaction
8
- */
9
- retrieve(pendingTransactionId: string, options?: Core.RequestOptions): Core.APIPromise<PendingTransaction>;
10
- /**
11
- * List Pending Transactions
12
- */
13
- list(
14
- query?: PendingTransactionListParams,
15
- options?: Core.RequestOptions,
16
- ): Core.PagePromise<PendingTransactionsPage, PendingTransaction>;
17
- list(options?: Core.RequestOptions): Core.PagePromise<PendingTransactionsPage, PendingTransaction>;
6
+ /**
7
+ * Retrieve a Pending Transaction
8
+ */
9
+ retrieve(pendingTransactionId: string, options?: Core.RequestOptions): Core.APIPromise<PendingTransaction>;
10
+ /**
11
+ * List Pending Transactions
12
+ */
13
+ list(query?: PendingTransactionListParams, options?: Core.RequestOptions): Core.PagePromise<PendingTransactionsPage, PendingTransaction>;
14
+ list(options?: Core.RequestOptions): Core.PagePromise<PendingTransactionsPage, PendingTransaction>;
15
+ }
16
+ export declare class PendingTransactionsPage extends Page<PendingTransaction> {
18
17
  }
19
- export declare class PendingTransactionsPage extends Page<PendingTransaction> {}
20
18
  type _PendingTransactionsPage = PendingTransactionsPage;
21
19
  /**
22
20
  * Pending Transactions are potential future additions and removals of money from
23
21
  * your bank account.
24
22
  */
25
23
  export interface PendingTransaction {
26
- /**
27
- * The Pending Transaction identifier.
28
- */
29
- id: string;
30
- /**
31
- * The identifier for the account this Pending Transaction belongs to.
32
- */
33
- account_id: string;
34
- /**
35
- * The Pending Transaction amount in the minor unit of its currency. For dollars,
36
- * for example, this is cents.
37
- */
38
- amount: number;
39
- /**
40
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
41
- * Transaction was completed.
42
- */
43
- completed_at: string | null;
44
- /**
45
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
46
- * Transaction occurred.
47
- */
48
- created_at: string;
49
- /**
50
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending
51
- * Transaction's currency. This will match the currency on the Pending
52
- * Transaction's Account.
53
- *
54
- * - `CAD` - Canadian Dollar (CAD)
55
- * - `CHF` - Swiss Franc (CHF)
56
- * - `EUR` - Euro (EUR)
57
- * - `GBP` - British Pound (GBP)
58
- * - `JPY` - Japanese Yen (JPY)
59
- * - `USD` - US Dollar (USD)
60
- */
61
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
62
- /**
63
- * For a Pending Transaction related to a transfer, this is the description you
64
- * provide. For a Pending Transaction related to a payment, this is the description
65
- * the vendor provides.
66
- */
67
- description: string;
68
- /**
69
- * The identifier for the route this Pending Transaction came through. Routes are
70
- * things like cards and ACH details.
71
- */
72
- route_id: string | null;
73
- /**
74
- * The type of the route this Pending Transaction came through.
75
- *
76
- * - `account_number` - An Account Number.
77
- * - `card` - A Card.
78
- */
79
- route_type: 'account_number' | 'card' | null;
80
- /**
81
- * This is an object giving more details on the network-level event that caused the
82
- * Pending Transaction. For example, for a card transaction this lists the
83
- * merchant's industry and location.
84
- */
85
- source: PendingTransaction.Source;
86
- /**
87
- * Whether the Pending Transaction has been confirmed and has an associated
88
- * Transaction.
89
- *
90
- * - `pending` - The Pending Transaction is still awaiting confirmation.
91
- * - `complete` - The Pending Transaction is confirmed. An associated Transaction
92
- * exists for this object. The Pending Transaction will no longer count against
93
- * your balance and can generally be hidden from UIs, etc.
94
- */
95
- status: 'pending' | 'complete';
96
- /**
97
- * A constant representing the object's type. For this resource it will always be
98
- * `pending_transaction`.
99
- */
100
- type: 'pending_transaction';
101
- }
102
- export declare namespace PendingTransaction {
103
- /**
104
- * This is an object giving more details on the network-level event that caused the
105
- * Pending Transaction. For example, for a card transaction this lists the
106
- * merchant's industry and location.
107
- */
108
- interface Source {
109
24
  /**
110
- * An Account Transfer Instruction object. This field will be present in the JSON
111
- * response if and only if `category` is equal to `account_transfer_instruction`.
25
+ * The Pending Transaction identifier.
112
26
  */
113
- account_transfer_instruction: Source.AccountTransferInstruction | null;
27
+ id: string;
114
28
  /**
115
- * An ACH Transfer Instruction object. This field will be present in the JSON
116
- * response if and only if `category` is equal to `ach_transfer_instruction`.
29
+ * The identifier for the account this Pending Transaction belongs to.
117
30
  */
118
- ach_transfer_instruction: Source.ACHTransferInstruction | null;
31
+ account_id: string;
119
32
  /**
120
- * A Card Authorization object. This field will be present in the JSON response if
121
- * and only if `category` is equal to `card_authorization`.
33
+ * The Pending Transaction amount in the minor unit of its currency. For dollars,
34
+ * for example, this is cents.
122
35
  */
123
- card_authorization: Source.CardAuthorization | null;
36
+ amount: number;
124
37
  /**
125
- * The type of the resource. We may add additional possible values for this enum
126
- * over time; your application should be able to handle such additions gracefully.
127
- *
128
- * - `account_transfer_instruction` - Account Transfer Instruction: details will be
129
- * under the `account_transfer_instruction` object.
130
- * - `ach_transfer_instruction` - ACH Transfer Instruction: details will be under
131
- * the `ach_transfer_instruction` object.
132
- * - `card_authorization` - Card Authorization: details will be under the
133
- * `card_authorization` object.
134
- * - `check_deposit_instruction` - Check Deposit Instruction: details will be under
135
- * the `check_deposit_instruction` object.
136
- * - `check_transfer_instruction` - Check Transfer Instruction: details will be
137
- * under the `check_transfer_instruction` object.
138
- * - `inbound_funds_hold` - Inbound Funds Hold: details will be under the
139
- * `inbound_funds_hold` object.
140
- * - `real_time_payments_transfer_instruction` - Real-Time Payments Transfer
141
- * Instruction: details will be under the
142
- * `real_time_payments_transfer_instruction` object.
143
- * - `wire_transfer_instruction` - Wire Transfer Instruction: details will be under
144
- * the `wire_transfer_instruction` object.
145
- * - `other` - The Pending Transaction was made for an undocumented or deprecated
146
- * reason.
38
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
39
+ * Transaction was completed.
147
40
  */
148
- category:
149
- | 'account_transfer_instruction'
150
- | 'ach_transfer_instruction'
151
- | 'card_authorization'
152
- | 'check_deposit_instruction'
153
- | 'check_transfer_instruction'
154
- | 'inbound_funds_hold'
155
- | 'real_time_payments_transfer_instruction'
156
- | 'wire_transfer_instruction'
157
- | 'other';
41
+ completed_at: string | null;
158
42
  /**
159
- * A Check Deposit Instruction object. This field will be present in the JSON
160
- * response if and only if `category` is equal to `check_deposit_instruction`.
43
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
44
+ * Transaction occurred.
161
45
  */
162
- check_deposit_instruction: Source.CheckDepositInstruction | null;
46
+ created_at: string;
163
47
  /**
164
- * A Check Transfer Instruction object. This field will be present in the JSON
165
- * response if and only if `category` is equal to `check_transfer_instruction`.
48
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending
49
+ * Transaction's currency. This will match the currency on the Pending
50
+ * Transaction's Account.
51
+ *
52
+ * - `CAD` - Canadian Dollar (CAD)
53
+ * - `CHF` - Swiss Franc (CHF)
54
+ * - `EUR` - Euro (EUR)
55
+ * - `GBP` - British Pound (GBP)
56
+ * - `JPY` - Japanese Yen (JPY)
57
+ * - `USD` - US Dollar (USD)
166
58
  */
167
- check_transfer_instruction: Source.CheckTransferInstruction | null;
59
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
168
60
  /**
169
- * An Inbound Funds Hold object. This field will be present in the JSON response if
170
- * and only if `category` is equal to `inbound_funds_hold`.
61
+ * For a Pending Transaction related to a transfer, this is the description you
62
+ * provide. For a Pending Transaction related to a payment, this is the description
63
+ * the vendor provides.
171
64
  */
172
- inbound_funds_hold: Source.InboundFundsHold | null;
65
+ description: string;
173
66
  /**
174
- * A Real-Time Payments Transfer Instruction object. This field will be present in
175
- * the JSON response if and only if `category` is equal to
176
- * `real_time_payments_transfer_instruction`.
67
+ * The identifier for the route this Pending Transaction came through. Routes are
68
+ * things like cards and ACH details.
177
69
  */
178
- real_time_payments_transfer_instruction: Source.RealTimePaymentsTransferInstruction | null;
70
+ route_id: string | null;
179
71
  /**
180
- * A Wire Transfer Instruction object. This field will be present in the JSON
181
- * response if and only if `category` is equal to `wire_transfer_instruction`.
72
+ * The type of the route this Pending Transaction came through.
73
+ *
74
+ * - `account_number` - An Account Number.
75
+ * - `card` - A Card.
182
76
  */
183
- wire_transfer_instruction: Source.WireTransferInstruction | null;
184
- }
185
- namespace Source {
77
+ route_type: 'account_number' | 'card' | null;
186
78
  /**
187
- * An Account Transfer Instruction object. This field will be present in the JSON
188
- * response if and only if `category` is equal to `account_transfer_instruction`.
79
+ * This is an object giving more details on the network-level event that caused the
80
+ * Pending Transaction. For example, for a card transaction this lists the
81
+ * merchant's industry and location.
189
82
  */
190
- interface AccountTransferInstruction {
191
- /**
192
- * The pending amount in the minor unit of the transaction's currency. For dollars,
193
- * for example, this is cents.
194
- */
195
- amount: number;
196
- /**
197
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
198
- * account currency.
199
- *
200
- * - `CAD` - Canadian Dollar (CAD)
201
- * - `CHF` - Swiss Franc (CHF)
202
- * - `EUR` - Euro (EUR)
203
- * - `GBP` - British Pound (GBP)
204
- * - `JPY` - Japanese Yen (JPY)
205
- * - `USD` - US Dollar (USD)
206
- */
207
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
208
- /**
209
- * The identifier of the Account Transfer that led to this Pending Transaction.
210
- */
211
- transfer_id: string;
212
- }
83
+ source: PendingTransaction.Source;
84
+ /**
85
+ * Whether the Pending Transaction has been confirmed and has an associated
86
+ * Transaction.
87
+ *
88
+ * - `pending` - The Pending Transaction is still awaiting confirmation.
89
+ * - `complete` - The Pending Transaction is confirmed. An associated Transaction
90
+ * exists for this object. The Pending Transaction will no longer count against
91
+ * your balance and can generally be hidden from UIs, etc.
92
+ */
93
+ status: 'pending' | 'complete';
213
94
  /**
214
- * An ACH Transfer Instruction object. This field will be present in the JSON
215
- * response if and only if `category` is equal to `ach_transfer_instruction`.
95
+ * A constant representing the object's type. For this resource it will always be
96
+ * `pending_transaction`.
216
97
  */
217
- interface ACHTransferInstruction {
218
- /**
219
- * The pending amount in the minor unit of the transaction's currency. For dollars,
220
- * for example, this is cents.
221
- */
222
- amount: number;
223
- /**
224
- * The identifier of the ACH Transfer that led to this Pending Transaction.
225
- */
226
- transfer_id: string;
227
- }
98
+ type: 'pending_transaction';
99
+ }
100
+ export declare namespace PendingTransaction {
228
101
  /**
229
- * A Card Authorization object. This field will be present in the JSON response if
230
- * and only if `category` is equal to `card_authorization`.
102
+ * This is an object giving more details on the network-level event that caused the
103
+ * Pending Transaction. For example, for a card transaction this lists the
104
+ * merchant's industry and location.
231
105
  */
232
- interface CardAuthorization {
233
- /**
234
- * The Card Authorization identifier.
235
- */
236
- id: string;
237
- /**
238
- * The pending amount in the minor unit of the transaction's currency. For dollars,
239
- * for example, this is cents.
240
- */
241
- amount: number;
242
- /**
243
- * The ID of the Card Payment this transaction belongs to.
244
- */
245
- card_payment_id: string | null;
246
- /**
247
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
248
- * transaction's currency.
249
- *
250
- * - `CAD` - Canadian Dollar (CAD)
251
- * - `CHF` - Swiss Franc (CHF)
252
- * - `EUR` - Euro (EUR)
253
- * - `GBP` - British Pound (GBP)
254
- * - `JPY` - Japanese Yen (JPY)
255
- * - `USD` - US Dollar (USD)
256
- */
257
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
258
- /**
259
- * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
260
- * purchase), the identifier of the token that was used.
261
- */
262
- digital_wallet_token_id: string | null;
263
- /**
264
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
265
- * will expire and the pending transaction will be released.
266
- */
267
- expires_at: string;
268
- /**
269
- * The merchant identifier (commonly abbreviated as MID) of the merchant the card
270
- * is transacting with.
271
- */
272
- merchant_acceptor_id: string;
273
- /**
274
- * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
275
- * card is transacting with.
276
- */
277
- merchant_category_code: string | null;
278
- /**
279
- * The city the merchant resides in.
280
- */
281
- merchant_city: string | null;
282
- /**
283
- * The country the merchant resides in.
284
- */
285
- merchant_country: string | null;
286
- /**
287
- * The merchant descriptor of the merchant the card is transacting with.
288
- */
289
- merchant_descriptor: string;
290
- /**
291
- * Fields specific to the `network`.
292
- */
293
- network_details: CardAuthorization.NetworkDetails;
294
- /**
295
- * The identifier of the Pending Transaction associated with this Transaction.
296
- */
297
- pending_transaction_id: string | null;
298
- /**
299
- * If the authorization was made in-person with a physical card, the Physical Card
300
- * that was used.
301
- */
302
- physical_card_id: string | null;
303
- /**
304
- * The identifier of the Real-Time Decision sent to approve or decline this
305
- * transaction.
306
- */
307
- real_time_decision_id: string | null;
308
- /**
309
- * A constant representing the object's type. For this resource it will always be
310
- * `card_authorization`.
311
- */
312
- type: 'card_authorization';
313
- }
314
- namespace CardAuthorization {
315
- /**
316
- * Fields specific to the `network`.
317
- */
318
- interface NetworkDetails {
106
+ interface Source {
107
+ /**
108
+ * An Account Transfer Instruction object. This field will be present in the JSON
109
+ * response if and only if `category` is equal to `account_transfer_instruction`.
110
+ */
111
+ account_transfer_instruction: Source.AccountTransferInstruction | null;
112
+ /**
113
+ * An ACH Transfer Instruction object. This field will be present in the JSON
114
+ * response if and only if `category` is equal to `ach_transfer_instruction`.
115
+ */
116
+ ach_transfer_instruction: Source.ACHTransferInstruction | null;
117
+ /**
118
+ * A Card Authorization object. This field will be present in the JSON response if
119
+ * and only if `category` is equal to `card_authorization`.
120
+ */
121
+ card_authorization: Source.CardAuthorization | null;
319
122
  /**
320
- * The payment network used to process this card authorization.
123
+ * The type of the resource. We may add additional possible values for this enum
124
+ * over time; your application should be able to handle such additions gracefully.
321
125
  *
322
- * - `visa` - Visa
126
+ * - `account_transfer_instruction` - Account Transfer Instruction: details will be
127
+ * under the `account_transfer_instruction` object.
128
+ * - `ach_transfer_instruction` - ACH Transfer Instruction: details will be under
129
+ * the `ach_transfer_instruction` object.
130
+ * - `card_authorization` - Card Authorization: details will be under the
131
+ * `card_authorization` object.
132
+ * - `check_deposit_instruction` - Check Deposit Instruction: details will be under
133
+ * the `check_deposit_instruction` object.
134
+ * - `check_transfer_instruction` - Check Transfer Instruction: details will be
135
+ * under the `check_transfer_instruction` object.
136
+ * - `inbound_funds_hold` - Inbound Funds Hold: details will be under the
137
+ * `inbound_funds_hold` object.
138
+ * - `real_time_payments_transfer_instruction` - Real-Time Payments Transfer
139
+ * Instruction: details will be under the
140
+ * `real_time_payments_transfer_instruction` object.
141
+ * - `wire_transfer_instruction` - Wire Transfer Instruction: details will be under
142
+ * the `wire_transfer_instruction` object.
143
+ * - `other` - The Pending Transaction was made for an undocumented or deprecated
144
+ * reason.
323
145
  */
324
- category: 'visa';
146
+ category: 'account_transfer_instruction' | 'ach_transfer_instruction' | 'card_authorization' | 'check_deposit_instruction' | 'check_transfer_instruction' | 'inbound_funds_hold' | 'real_time_payments_transfer_instruction' | 'wire_transfer_instruction' | 'other';
325
147
  /**
326
- * Fields specific to the `visa` network.
148
+ * A Check Deposit Instruction object. This field will be present in the JSON
149
+ * response if and only if `category` is equal to `check_deposit_instruction`.
327
150
  */
328
- visa: NetworkDetails.Visa | null;
329
- }
330
- namespace NetworkDetails {
151
+ check_deposit_instruction: Source.CheckDepositInstruction | null;
331
152
  /**
332
- * Fields specific to the `visa` network.
153
+ * A Check Transfer Instruction object. This field will be present in the JSON
154
+ * response if and only if `category` is equal to `check_transfer_instruction`.
333
155
  */
334
- interface Visa {
335
- /**
336
- * For electronic commerce transactions, this identifies the level of security used
337
- * in obtaining the customer's payment credential. For mail or telephone order
338
- * transactions, identifies the type of mail or telephone order.
339
- *
340
- * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
341
- * that the transaction is a mail/phone order purchase, not a recurring
342
- * transaction or installment payment. For domestic transactions in the US
343
- * region, this value may also indicate one bill payment transaction in the
344
- * card-present or card-absent environments.
345
- * - `recurring` - Recurring transaction: Payment indicator used to indicate a
346
- * recurring transaction that originates from an acquirer in the US region.
347
- * - `installment` - Installment payment: Payment indicator used to indicate one
348
- * purchase of goods or services that is billed to the account in multiple
349
- * charges over a period of time agreed upon by the cardholder and merchant from
350
- * transactions that originate from an acquirer in the US region.
351
- * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
352
- * indicate that the type of mail/telephone order is unknown.
353
- * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
354
- * indicate that the electronic commerce transaction has been authenticated using
355
- * e.g., 3-D Secure
356
- * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
357
- * Non-authenticated security transaction at a 3-D Secure-capable merchant, and
358
- * merchant attempted to authenticate the cardholder using 3-D Secure: Use to
359
- * identify an electronic commerce transaction where the merchant attempted to
360
- * authenticate the cardholder using 3-D Secure, but was unable to complete the
361
- * authentication because the issuer or cardholder does not participate in the
362
- * 3-D Secure program.
363
- * - `non_authenticated_security_transaction` - Non-authenticated security
364
- * transaction: Use to identify an electronic commerce transaction that uses data
365
- * encryption for security however , cardholder authentication is not performed
366
- * using 3-D Secure.
367
- * - `non_secure_transaction` - Non-secure transaction: Use to identify an
368
- * electronic commerce transaction that has no data protection.
369
- */
370
- electronic_commerce_indicator:
371
- | 'mail_phone_order'
372
- | 'recurring'
373
- | 'installment'
374
- | 'unknown_mail_phone_order'
375
- | 'secure_electronic_commerce'
376
- | 'non_authenticated_security_transaction_at_3ds_capable_merchant'
377
- | 'non_authenticated_security_transaction'
378
- | 'non_secure_transaction'
379
- | null;
380
- /**
381
- * The method used to enter the cardholder's primary account number and card
382
- * expiration date.
383
- *
384
- * - `unknown` - Unknown
385
- * - `manual` - Manual key entry
386
- * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
387
- * value
388
- * - `optical_code` - Optical code
389
- * - `integrated_circuit_card` - Contact chip card
390
- * - `contactless` - Contactless read of chip card
391
- * - `credential_on_file` - Transaction initiated using a credential that has
392
- * previously been stored on file
393
- * - `magnetic_stripe` - Magnetic stripe read
394
- * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
395
- * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
396
- * verification value
397
- */
398
- point_of_service_entry_mode:
399
- | 'unknown'
400
- | 'manual'
401
- | 'magnetic_stripe_no_cvv'
402
- | 'optical_code'
403
- | 'integrated_circuit_card'
404
- | 'contactless'
405
- | 'credential_on_file'
406
- | 'magnetic_stripe'
407
- | 'contactless_magnetic_stripe'
408
- | 'integrated_circuit_card_no_cvv'
409
- | null;
156
+ check_transfer_instruction: Source.CheckTransferInstruction | null;
157
+ /**
158
+ * An Inbound Funds Hold object. This field will be present in the JSON response if
159
+ * and only if `category` is equal to `inbound_funds_hold`.
160
+ */
161
+ inbound_funds_hold: Source.InboundFundsHold | null;
162
+ /**
163
+ * A Real-Time Payments Transfer Instruction object. This field will be present in
164
+ * the JSON response if and only if `category` is equal to
165
+ * `real_time_payments_transfer_instruction`.
166
+ */
167
+ real_time_payments_transfer_instruction: Source.RealTimePaymentsTransferInstruction | null;
168
+ /**
169
+ * A Wire Transfer Instruction object. This field will be present in the JSON
170
+ * response if and only if `category` is equal to `wire_transfer_instruction`.
171
+ */
172
+ wire_transfer_instruction: Source.WireTransferInstruction | null;
173
+ }
174
+ namespace Source {
175
+ /**
176
+ * An Account Transfer Instruction object. This field will be present in the JSON
177
+ * response if and only if `category` is equal to `account_transfer_instruction`.
178
+ */
179
+ interface AccountTransferInstruction {
180
+ /**
181
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
182
+ * for example, this is cents.
183
+ */
184
+ amount: number;
185
+ /**
186
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
187
+ * account currency.
188
+ *
189
+ * - `CAD` - Canadian Dollar (CAD)
190
+ * - `CHF` - Swiss Franc (CHF)
191
+ * - `EUR` - Euro (EUR)
192
+ * - `GBP` - British Pound (GBP)
193
+ * - `JPY` - Japanese Yen (JPY)
194
+ * - `USD` - US Dollar (USD)
195
+ */
196
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
197
+ /**
198
+ * The identifier of the Account Transfer that led to this Pending Transaction.
199
+ */
200
+ transfer_id: string;
201
+ }
202
+ /**
203
+ * An ACH Transfer Instruction object. This field will be present in the JSON
204
+ * response if and only if `category` is equal to `ach_transfer_instruction`.
205
+ */
206
+ interface ACHTransferInstruction {
207
+ /**
208
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
209
+ * for example, this is cents.
210
+ */
211
+ amount: number;
212
+ /**
213
+ * The identifier of the ACH Transfer that led to this Pending Transaction.
214
+ */
215
+ transfer_id: string;
216
+ }
217
+ /**
218
+ * A Card Authorization object. This field will be present in the JSON response if
219
+ * and only if `category` is equal to `card_authorization`.
220
+ */
221
+ interface CardAuthorization {
222
+ /**
223
+ * The Card Authorization identifier.
224
+ */
225
+ id: string;
226
+ /**
227
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
228
+ * for example, this is cents.
229
+ */
230
+ amount: number;
231
+ /**
232
+ * The ID of the Card Payment this transaction belongs to.
233
+ */
234
+ card_payment_id: string | null;
235
+ /**
236
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
237
+ * transaction's currency.
238
+ *
239
+ * - `CAD` - Canadian Dollar (CAD)
240
+ * - `CHF` - Swiss Franc (CHF)
241
+ * - `EUR` - Euro (EUR)
242
+ * - `GBP` - British Pound (GBP)
243
+ * - `JPY` - Japanese Yen (JPY)
244
+ * - `USD` - US Dollar (USD)
245
+ */
246
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
247
+ /**
248
+ * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
249
+ * purchase), the identifier of the token that was used.
250
+ */
251
+ digital_wallet_token_id: string | null;
252
+ /**
253
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
254
+ * will expire and the pending transaction will be released.
255
+ */
256
+ expires_at: string;
257
+ /**
258
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
259
+ * is transacting with.
260
+ */
261
+ merchant_acceptor_id: string;
262
+ /**
263
+ * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
264
+ * card is transacting with.
265
+ */
266
+ merchant_category_code: string | null;
267
+ /**
268
+ * The city the merchant resides in.
269
+ */
270
+ merchant_city: string | null;
271
+ /**
272
+ * The country the merchant resides in.
273
+ */
274
+ merchant_country: string | null;
275
+ /**
276
+ * The merchant descriptor of the merchant the card is transacting with.
277
+ */
278
+ merchant_descriptor: string;
279
+ /**
280
+ * Fields specific to the `network`.
281
+ */
282
+ network_details: CardAuthorization.NetworkDetails;
283
+ /**
284
+ * The identifier of the Pending Transaction associated with this Transaction.
285
+ */
286
+ pending_transaction_id: string | null;
287
+ /**
288
+ * If the authorization was made in-person with a physical card, the Physical Card
289
+ * that was used.
290
+ */
291
+ physical_card_id: string | null;
292
+ /**
293
+ * The identifier of the Real-Time Decision sent to approve or decline this
294
+ * transaction.
295
+ */
296
+ real_time_decision_id: string | null;
297
+ /**
298
+ * A constant representing the object's type. For this resource it will always be
299
+ * `card_authorization`.
300
+ */
301
+ type: 'card_authorization';
302
+ }
303
+ namespace CardAuthorization {
304
+ /**
305
+ * Fields specific to the `network`.
306
+ */
307
+ interface NetworkDetails {
308
+ /**
309
+ * The payment network used to process this card authorization.
310
+ *
311
+ * - `visa` - Visa
312
+ */
313
+ category: 'visa';
314
+ /**
315
+ * Fields specific to the `visa` network.
316
+ */
317
+ visa: NetworkDetails.Visa | null;
318
+ }
319
+ namespace NetworkDetails {
320
+ /**
321
+ * Fields specific to the `visa` network.
322
+ */
323
+ interface Visa {
324
+ /**
325
+ * For electronic commerce transactions, this identifies the level of security used
326
+ * in obtaining the customer's payment credential. For mail or telephone order
327
+ * transactions, identifies the type of mail or telephone order.
328
+ *
329
+ * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
330
+ * that the transaction is a mail/phone order purchase, not a recurring
331
+ * transaction or installment payment. For domestic transactions in the US
332
+ * region, this value may also indicate one bill payment transaction in the
333
+ * card-present or card-absent environments.
334
+ * - `recurring` - Recurring transaction: Payment indicator used to indicate a
335
+ * recurring transaction that originates from an acquirer in the US region.
336
+ * - `installment` - Installment payment: Payment indicator used to indicate one
337
+ * purchase of goods or services that is billed to the account in multiple
338
+ * charges over a period of time agreed upon by the cardholder and merchant from
339
+ * transactions that originate from an acquirer in the US region.
340
+ * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
341
+ * indicate that the type of mail/telephone order is unknown.
342
+ * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
343
+ * indicate that the electronic commerce transaction has been authenticated using
344
+ * e.g., 3-D Secure
345
+ * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
346
+ * Non-authenticated security transaction at a 3-D Secure-capable merchant, and
347
+ * merchant attempted to authenticate the cardholder using 3-D Secure: Use to
348
+ * identify an electronic commerce transaction where the merchant attempted to
349
+ * authenticate the cardholder using 3-D Secure, but was unable to complete the
350
+ * authentication because the issuer or cardholder does not participate in the
351
+ * 3-D Secure program.
352
+ * - `non_authenticated_security_transaction` - Non-authenticated security
353
+ * transaction: Use to identify an electronic commerce transaction that uses data
354
+ * encryption for security however , cardholder authentication is not performed
355
+ * using 3-D Secure.
356
+ * - `non_secure_transaction` - Non-secure transaction: Use to identify an
357
+ * electronic commerce transaction that has no data protection.
358
+ */
359
+ electronic_commerce_indicator: 'mail_phone_order' | 'recurring' | 'installment' | 'unknown_mail_phone_order' | 'secure_electronic_commerce' | 'non_authenticated_security_transaction_at_3ds_capable_merchant' | 'non_authenticated_security_transaction' | 'non_secure_transaction' | null;
360
+ /**
361
+ * The method used to enter the cardholder's primary account number and card
362
+ * expiration date.
363
+ *
364
+ * - `unknown` - Unknown
365
+ * - `manual` - Manual key entry
366
+ * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
367
+ * value
368
+ * - `optical_code` - Optical code
369
+ * - `integrated_circuit_card` - Contact chip card
370
+ * - `contactless` - Contactless read of chip card
371
+ * - `credential_on_file` - Transaction initiated using a credential that has
372
+ * previously been stored on file
373
+ * - `magnetic_stripe` - Magnetic stripe read
374
+ * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
375
+ * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
376
+ * verification value
377
+ */
378
+ point_of_service_entry_mode: 'unknown' | 'manual' | 'magnetic_stripe_no_cvv' | 'optical_code' | 'integrated_circuit_card' | 'contactless' | 'credential_on_file' | 'magnetic_stripe' | 'contactless_magnetic_stripe' | 'integrated_circuit_card_no_cvv' | null;
379
+ }
380
+ }
381
+ }
382
+ /**
383
+ * A Check Deposit Instruction object. This field will be present in the JSON
384
+ * response if and only if `category` is equal to `check_deposit_instruction`.
385
+ */
386
+ interface CheckDepositInstruction {
387
+ /**
388
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
389
+ * for example, this is cents.
390
+ */
391
+ amount: number;
392
+ /**
393
+ * The identifier of the File containing the image of the back of the check that
394
+ * was deposited.
395
+ */
396
+ back_image_file_id: string | null;
397
+ /**
398
+ * The identifier of the Check Deposit.
399
+ */
400
+ check_deposit_id: string | null;
401
+ /**
402
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
403
+ * transaction's currency.
404
+ *
405
+ * - `CAD` - Canadian Dollar (CAD)
406
+ * - `CHF` - Swiss Franc (CHF)
407
+ * - `EUR` - Euro (EUR)
408
+ * - `GBP` - British Pound (GBP)
409
+ * - `JPY` - Japanese Yen (JPY)
410
+ * - `USD` - US Dollar (USD)
411
+ */
412
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
413
+ /**
414
+ * The identifier of the File containing the image of the front of the check that
415
+ * was deposited.
416
+ */
417
+ front_image_file_id: string;
418
+ }
419
+ /**
420
+ * A Check Transfer Instruction object. This field will be present in the JSON
421
+ * response if and only if `category` is equal to `check_transfer_instruction`.
422
+ */
423
+ interface CheckTransferInstruction {
424
+ /**
425
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
426
+ * for example, this is cents.
427
+ */
428
+ amount: number;
429
+ /**
430
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
431
+ * currency.
432
+ *
433
+ * - `CAD` - Canadian Dollar (CAD)
434
+ * - `CHF` - Swiss Franc (CHF)
435
+ * - `EUR` - Euro (EUR)
436
+ * - `GBP` - British Pound (GBP)
437
+ * - `JPY` - Japanese Yen (JPY)
438
+ * - `USD` - US Dollar (USD)
439
+ */
440
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
441
+ /**
442
+ * The identifier of the Check Transfer that led to this Pending Transaction.
443
+ */
444
+ transfer_id: string;
445
+ }
446
+ /**
447
+ * An Inbound Funds Hold object. This field will be present in the JSON response if
448
+ * and only if `category` is equal to `inbound_funds_hold`.
449
+ */
450
+ interface InboundFundsHold {
451
+ /**
452
+ * The Inbound Funds Hold identifier.
453
+ */
454
+ id: string;
455
+ /**
456
+ * The held amount in the minor unit of the account's currency. For dollars, for
457
+ * example, this is cents.
458
+ */
459
+ amount: number;
460
+ /**
461
+ * When the hold will be released automatically. Certain conditions may cause it to
462
+ * be released before this time.
463
+ */
464
+ automatically_releases_at: string;
465
+ /**
466
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
467
+ * was created.
468
+ */
469
+ created_at: string;
470
+ /**
471
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
472
+ * currency.
473
+ *
474
+ * - `CAD` - Canadian Dollar (CAD)
475
+ * - `CHF` - Swiss Franc (CHF)
476
+ * - `EUR` - Euro (EUR)
477
+ * - `GBP` - British Pound (GBP)
478
+ * - `JPY` - Japanese Yen (JPY)
479
+ * - `USD` - US Dollar (USD)
480
+ */
481
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
482
+ /**
483
+ * The ID of the Transaction for which funds were held.
484
+ */
485
+ held_transaction_id: string | null;
486
+ /**
487
+ * The ID of the Pending Transaction representing the held funds.
488
+ */
489
+ pending_transaction_id: string | null;
490
+ /**
491
+ * When the hold was released (if it has been released).
492
+ */
493
+ released_at: string | null;
494
+ /**
495
+ * The status of the hold.
496
+ *
497
+ * - `held` - Funds are still being held.
498
+ * - `complete` - Funds have been released.
499
+ */
500
+ status: 'held' | 'complete';
501
+ /**
502
+ * A constant representing the object's type. For this resource it will always be
503
+ * `inbound_funds_hold`.
504
+ */
505
+ type: 'inbound_funds_hold';
506
+ }
507
+ /**
508
+ * A Real-Time Payments Transfer Instruction object. This field will be present in
509
+ * the JSON response if and only if `category` is equal to
510
+ * `real_time_payments_transfer_instruction`.
511
+ */
512
+ interface RealTimePaymentsTransferInstruction {
513
+ /**
514
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
515
+ * for example, this is cents.
516
+ */
517
+ amount: number;
518
+ /**
519
+ * The identifier of the Real-Time Payments Transfer that led to this Pending
520
+ * Transaction.
521
+ */
522
+ transfer_id: string;
523
+ }
524
+ /**
525
+ * A Wire Transfer Instruction object. This field will be present in the JSON
526
+ * response if and only if `category` is equal to `wire_transfer_instruction`.
527
+ */
528
+ interface WireTransferInstruction {
529
+ /**
530
+ * The account number for the destination account.
531
+ */
532
+ account_number: string;
533
+ /**
534
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
535
+ * for example, this is cents.
536
+ */
537
+ amount: number;
538
+ /**
539
+ * The message that will show on the recipient's bank statement.
540
+ */
541
+ message_to_recipient: string;
542
+ /**
543
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
544
+ * destination account.
545
+ */
546
+ routing_number: string;
547
+ /**
548
+ * The identifier of the Wire Transfer that led to this Pending Transaction.
549
+ */
550
+ transfer_id: string;
410
551
  }
411
- }
412
552
  }
553
+ }
554
+ export interface PendingTransactionListParams extends PageParams {
413
555
  /**
414
- * A Check Deposit Instruction object. This field will be present in the JSON
415
- * response if and only if `category` is equal to `check_deposit_instruction`.
556
+ * Filter pending transactions to those belonging to the specified Account.
416
557
  */
417
- interface CheckDepositInstruction {
418
- /**
419
- * The pending amount in the minor unit of the transaction's currency. For dollars,
420
- * for example, this is cents.
421
- */
422
- amount: number;
423
- /**
424
- * The identifier of the File containing the image of the back of the check that
425
- * was deposited.
426
- */
427
- back_image_file_id: string | null;
428
- /**
429
- * The identifier of the Check Deposit.
430
- */
431
- check_deposit_id: string | null;
432
- /**
433
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
434
- * transaction's currency.
435
- *
436
- * - `CAD` - Canadian Dollar (CAD)
437
- * - `CHF` - Swiss Franc (CHF)
438
- * - `EUR` - Euro (EUR)
439
- * - `GBP` - British Pound (GBP)
440
- * - `JPY` - Japanese Yen (JPY)
441
- * - `USD` - US Dollar (USD)
442
- */
443
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
444
- /**
445
- * The identifier of the File containing the image of the front of the check that
446
- * was deposited.
447
- */
448
- front_image_file_id: string;
449
- }
558
+ account_id?: string;
559
+ category?: PendingTransactionListParams.Category;
560
+ created_at?: PendingTransactionListParams.CreatedAt;
450
561
  /**
451
- * A Check Transfer Instruction object. This field will be present in the JSON
452
- * response if and only if `category` is equal to `check_transfer_instruction`.
562
+ * Filter pending transactions to those belonging to the specified Route.
453
563
  */
454
- interface CheckTransferInstruction {
455
- /**
456
- * The pending amount in the minor unit of the transaction's currency. For dollars,
457
- * for example, this is cents.
458
- */
459
- amount: number;
460
- /**
461
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
462
- * currency.
463
- *
464
- * - `CAD` - Canadian Dollar (CAD)
465
- * - `CHF` - Swiss Franc (CHF)
466
- * - `EUR` - Euro (EUR)
467
- * - `GBP` - British Pound (GBP)
468
- * - `JPY` - Japanese Yen (JPY)
469
- * - `USD` - US Dollar (USD)
470
- */
471
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
472
- /**
473
- * The identifier of the Check Transfer that led to this Pending Transaction.
474
- */
475
- transfer_id: string;
476
- }
564
+ route_id?: string;
477
565
  /**
478
- * An Inbound Funds Hold object. This field will be present in the JSON response if
479
- * and only if `category` is equal to `inbound_funds_hold`.
566
+ * Filter pending transactions to those caused by the specified source.
480
567
  */
481
- interface InboundFundsHold {
482
- /**
483
- * The Inbound Funds Hold identifier.
484
- */
485
- id: string;
486
- /**
487
- * The held amount in the minor unit of the account's currency. For dollars, for
488
- * example, this is cents.
489
- */
490
- amount: number;
491
- /**
492
- * When the hold will be released automatically. Certain conditions may cause it to
493
- * be released before this time.
494
- */
495
- automatically_releases_at: string;
496
- /**
497
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
498
- * was created.
499
- */
500
- created_at: string;
501
- /**
502
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
503
- * currency.
504
- *
505
- * - `CAD` - Canadian Dollar (CAD)
506
- * - `CHF` - Swiss Franc (CHF)
507
- * - `EUR` - Euro (EUR)
508
- * - `GBP` - British Pound (GBP)
509
- * - `JPY` - Japanese Yen (JPY)
510
- * - `USD` - US Dollar (USD)
511
- */
512
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
513
- /**
514
- * The ID of the Transaction for which funds were held.
515
- */
516
- held_transaction_id: string | null;
517
- /**
518
- * The ID of the Pending Transaction representing the held funds.
519
- */
520
- pending_transaction_id: string | null;
521
- /**
522
- * When the hold was released (if it has been released).
523
- */
524
- released_at: string | null;
525
- /**
526
- * The status of the hold.
527
- *
528
- * - `held` - Funds are still being held.
529
- * - `complete` - Funds have been released.
530
- */
531
- status: 'held' | 'complete';
532
- /**
533
- * A constant representing the object's type. For this resource it will always be
534
- * `inbound_funds_hold`.
535
- */
536
- type: 'inbound_funds_hold';
568
+ source_id?: string;
569
+ status?: PendingTransactionListParams.Status;
570
+ }
571
+ export declare namespace PendingTransactionListParams {
572
+ interface Category {
573
+ /**
574
+ * Return results whose value is in the provided list. For GET requests, this
575
+ * should be encoded as a comma-delimited string, such as `?in=one,two,three`.
576
+ */
577
+ in?: Array<'account_transfer_instruction' | 'ach_transfer_instruction' | 'card_authorization' | 'check_deposit_instruction' | 'check_transfer_instruction' | 'inbound_funds_hold' | 'real_time_payments_transfer_instruction' | 'wire_transfer_instruction' | 'other'>;
537
578
  }
538
- /**
539
- * A Real-Time Payments Transfer Instruction object. This field will be present in
540
- * the JSON response if and only if `category` is equal to
541
- * `real_time_payments_transfer_instruction`.
542
- */
543
- interface RealTimePaymentsTransferInstruction {
544
- /**
545
- * The pending amount in the minor unit of the transaction's currency. For dollars,
546
- * for example, this is cents.
547
- */
548
- amount: number;
549
- /**
550
- * The identifier of the Real-Time Payments Transfer that led to this Pending
551
- * Transaction.
552
- */
553
- transfer_id: string;
579
+ interface CreatedAt {
580
+ /**
581
+ * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
582
+ * timestamp.
583
+ */
584
+ after?: string;
585
+ /**
586
+ * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
587
+ * timestamp.
588
+ */
589
+ before?: string;
590
+ /**
591
+ * Return results on or after this
592
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
593
+ */
594
+ on_or_after?: string;
595
+ /**
596
+ * Return results on or before this
597
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
598
+ */
599
+ on_or_before?: string;
554
600
  }
555
- /**
556
- * A Wire Transfer Instruction object. This field will be present in the JSON
557
- * response if and only if `category` is equal to `wire_transfer_instruction`.
558
- */
559
- interface WireTransferInstruction {
560
- /**
561
- * The account number for the destination account.
562
- */
563
- account_number: string;
564
- /**
565
- * The pending amount in the minor unit of the transaction's currency. For dollars,
566
- * for example, this is cents.
567
- */
568
- amount: number;
569
- /**
570
- * The message that will show on the recipient's bank statement.
571
- */
572
- message_to_recipient: string;
573
- /**
574
- * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
575
- * destination account.
576
- */
577
- routing_number: string;
578
- /**
579
- * The identifier of the Wire Transfer that led to this Pending Transaction.
580
- */
581
- transfer_id: string;
601
+ interface Status {
602
+ /**
603
+ * Filter Pending Transactions for those with the specified status. By default only
604
+ * Pending Transactions in with status `pending` will be returned. For GET
605
+ * requests, this should be encoded as a comma-delimited string, such as
606
+ * `?in=one,two,three`.
607
+ */
608
+ in?: Array<'pending' | 'complete'>;
582
609
  }
583
- }
584
- }
585
- export interface PendingTransactionListParams extends PageParams {
586
- /**
587
- * Filter pending transactions to those belonging to the specified Account.
588
- */
589
- account_id?: string;
590
- category?: PendingTransactionListParams.Category;
591
- created_at?: PendingTransactionListParams.CreatedAt;
592
- /**
593
- * Filter pending transactions to those belonging to the specified Route.
594
- */
595
- route_id?: string;
596
- /**
597
- * Filter pending transactions to those caused by the specified source.
598
- */
599
- source_id?: string;
600
- status?: PendingTransactionListParams.Status;
601
- }
602
- export declare namespace PendingTransactionListParams {
603
- interface Category {
604
- /**
605
- * Return results whose value is in the provided list. For GET requests, this
606
- * should be encoded as a comma-delimited string, such as `?in=one,two,three`.
607
- */
608
- in?: Array<
609
- | 'account_transfer_instruction'
610
- | 'ach_transfer_instruction'
611
- | 'card_authorization'
612
- | 'check_deposit_instruction'
613
- | 'check_transfer_instruction'
614
- | 'inbound_funds_hold'
615
- | 'real_time_payments_transfer_instruction'
616
- | 'wire_transfer_instruction'
617
- | 'other'
618
- >;
619
- }
620
- interface CreatedAt {
621
- /**
622
- * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
623
- * timestamp.
624
- */
625
- after?: string;
626
- /**
627
- * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
628
- * timestamp.
629
- */
630
- before?: string;
631
- /**
632
- * Return results on or after this
633
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
634
- */
635
- on_or_after?: string;
636
- /**
637
- * Return results on or before this
638
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
639
- */
640
- on_or_before?: string;
641
- }
642
- interface Status {
643
- /**
644
- * Filter Pending Transactions for those with the specified status. By default only
645
- * Pending Transactions in with status `pending` will be returned. For GET
646
- * requests, this should be encoded as a comma-delimited string, such as
647
- * `?in=one,two,three`.
648
- */
649
- in?: Array<'pending' | 'complete'>;
650
- }
651
610
  }
652
611
  export declare namespace PendingTransactions {
653
- export import PendingTransaction = API.PendingTransaction;
654
- type PendingTransactionsPage = _PendingTransactionsPage;
655
- export import PendingTransactionListParams = API.PendingTransactionListParams;
612
+ export import PendingTransaction = API.PendingTransaction;
613
+ type PendingTransactionsPage = _PendingTransactionsPage;
614
+ export import PendingTransactionListParams = API.PendingTransactionListParams;
656
615
  }
657
616
  export {};
658
- //# sourceMappingURL=pending-transactions.d.ts.map
617
+ //# sourceMappingURL=pending-transactions.d.ts.map