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,25 +1,20 @@
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 DeclinedTransactions extends APIResource {
6
- /**
7
- * Retrieve a Declined Transaction
8
- */
9
- retrieve(
10
- declinedTransactionId: string,
11
- options?: Core.RequestOptions,
12
- ): Core.APIPromise<DeclinedTransaction>;
13
- /**
14
- * List Declined Transactions
15
- */
16
- list(
17
- query?: DeclinedTransactionListParams,
18
- options?: Core.RequestOptions,
19
- ): Core.PagePromise<DeclinedTransactionsPage, DeclinedTransaction>;
20
- list(options?: Core.RequestOptions): Core.PagePromise<DeclinedTransactionsPage, DeclinedTransaction>;
6
+ /**
7
+ * Retrieve a Declined Transaction
8
+ */
9
+ retrieve(declinedTransactionId: string, options?: Core.RequestOptions): Core.APIPromise<DeclinedTransaction>;
10
+ /**
11
+ * List Declined Transactions
12
+ */
13
+ list(query?: DeclinedTransactionListParams, options?: Core.RequestOptions): Core.PagePromise<DeclinedTransactionsPage, DeclinedTransaction>;
14
+ list(options?: Core.RequestOptions): Core.PagePromise<DeclinedTransactionsPage, DeclinedTransaction>;
15
+ }
16
+ export declare class DeclinedTransactionsPage extends Page<DeclinedTransaction> {
21
17
  }
22
- export declare class DeclinedTransactionsPage extends Page<DeclinedTransaction> {}
23
18
  type _DeclinedTransactionsPage = DeclinedTransactionsPage;
24
19
  /**
25
20
  * Declined Transactions are refused additions and removals of money from your bank
@@ -27,950 +22,840 @@ type _DeclinedTransactionsPage = DeclinedTransactionsPage;
27
22
  * insufficient balance or your Limits are triggered.
28
23
  */
29
24
  export interface DeclinedTransaction {
30
- /**
31
- * The Declined Transaction identifier.
32
- */
33
- id: string;
34
- /**
35
- * The identifier for the Account the Declined Transaction belongs to.
36
- */
37
- account_id: string;
38
- /**
39
- * The Declined Transaction amount in the minor unit of its currency. For dollars,
40
- * for example, this is cents.
41
- */
42
- amount: number;
43
- /**
44
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
45
- * Transaction occurred.
46
- */
47
- created_at: string;
48
- /**
49
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
50
- * Transaction's currency. This will match the currency on the Declined
51
- * Transaction's Account.
52
- *
53
- * - `CAD` - Canadian Dollar (CAD)
54
- * - `CHF` - Swiss Franc (CHF)
55
- * - `EUR` - Euro (EUR)
56
- * - `GBP` - British Pound (GBP)
57
- * - `JPY` - Japanese Yen (JPY)
58
- * - `USD` - US Dollar (USD)
59
- */
60
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
61
- /**
62
- * This is the description the vendor provides.
63
- */
64
- description: string;
65
- /**
66
- * The identifier for the route this Declined Transaction came through. Routes are
67
- * things like cards and ACH details.
68
- */
69
- route_id: string | null;
70
- /**
71
- * The type of the route this Declined Transaction came through.
72
- *
73
- * - `account_number` - An Account Number.
74
- * - `card` - A Card.
75
- */
76
- route_type: 'account_number' | 'card' | null;
77
- /**
78
- * This is an object giving more details on the network-level event that caused the
79
- * Declined Transaction. For example, for a card transaction this lists the
80
- * merchant's industry and location. Note that for backwards compatibility reasons,
81
- * additional undocumented keys may appear in this object. These should be treated
82
- * as deprecated and will be removed in the future.
83
- */
84
- source: DeclinedTransaction.Source;
85
- /**
86
- * A constant representing the object's type. For this resource it will always be
87
- * `declined_transaction`.
88
- */
89
- type: 'declined_transaction';
90
- }
91
- export declare namespace DeclinedTransaction {
92
- /**
93
- * This is an object giving more details on the network-level event that caused the
94
- * Declined Transaction. For example, for a card transaction this lists the
95
- * merchant's industry and location. Note that for backwards compatibility reasons,
96
- * additional undocumented keys may appear in this object. These should be treated
97
- * as deprecated and will be removed in the future.
98
- */
99
- interface Source {
100
25
  /**
101
- * An ACH Decline object. This field will be present in the JSON response if and
102
- * only if `category` is equal to `ach_decline`.
26
+ * The Declined Transaction identifier.
27
+ */
28
+ id: string;
29
+ /**
30
+ * The identifier for the Account the Declined Transaction belongs to.
31
+ */
32
+ account_id: string;
33
+ /**
34
+ * The Declined Transaction amount in the minor unit of its currency. For dollars,
35
+ * for example, this is cents.
103
36
  */
104
- ach_decline: Source.ACHDecline | null;
37
+ amount: number;
105
38
  /**
106
- * A Card Decline object. This field will be present in the JSON response if and
107
- * only if `category` is equal to `card_decline`.
39
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
40
+ * Transaction occurred.
108
41
  */
109
- card_decline: Source.CardDecline | null;
42
+ created_at: string;
110
43
  /**
111
- * The type of the resource. We may add additional possible values for this enum
112
- * over time; your application should be able to handle such additions gracefully.
44
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
45
+ * Transaction's currency. This will match the currency on the Declined
46
+ * Transaction's Account.
113
47
  *
114
- * - `ach_decline` - ACH Decline: details will be under the `ach_decline` object.
115
- * - `card_decline` - Card Decline: details will be under the `card_decline`
116
- * object.
117
- * - `check_decline` - Check Decline: details will be under the `check_decline`
118
- * object.
119
- * - `inbound_real_time_payments_transfer_decline` - Inbound Real-Time Payments
120
- * Transfer Decline: details will be under the
121
- * `inbound_real_time_payments_transfer_decline` object.
122
- * - `international_ach_decline` - International ACH Decline: details will be under
123
- * the `international_ach_decline` object.
124
- * - `wire_decline` - Wire Decline: details will be under the `wire_decline`
125
- * object.
126
- * - `other` - The Declined Transaction was made for an undocumented or deprecated
127
- * reason.
48
+ * - `CAD` - Canadian Dollar (CAD)
49
+ * - `CHF` - Swiss Franc (CHF)
50
+ * - `EUR` - Euro (EUR)
51
+ * - `GBP` - British Pound (GBP)
52
+ * - `JPY` - Japanese Yen (JPY)
53
+ * - `USD` - US Dollar (USD)
128
54
  */
129
- category:
130
- | 'ach_decline'
131
- | 'card_decline'
132
- | 'check_decline'
133
- | 'inbound_real_time_payments_transfer_decline'
134
- | 'international_ach_decline'
135
- | 'wire_decline'
136
- | 'other';
55
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
137
56
  /**
138
- * A Check Decline object. This field will be present in the JSON response if and
139
- * only if `category` is equal to `check_decline`.
57
+ * This is the description the vendor provides.
140
58
  */
141
- check_decline: Source.CheckDecline | null;
59
+ description: string;
142
60
  /**
143
- * An Inbound Real-Time Payments Transfer Decline object. This field will be
144
- * present in the JSON response if and only if `category` is equal to
145
- * `inbound_real_time_payments_transfer_decline`.
61
+ * The identifier for the route this Declined Transaction came through. Routes are
62
+ * things like cards and ACH details.
146
63
  */
147
- inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
64
+ route_id: string | null;
148
65
  /**
149
- * An International ACH Decline object. This field will be present in the JSON
150
- * response if and only if `category` is equal to `international_ach_decline`.
66
+ * The type of the route this Declined Transaction came through.
67
+ *
68
+ * - `account_number` - An Account Number.
69
+ * - `card` - A Card.
151
70
  */
152
- international_ach_decline: Source.InternationalACHDecline | null;
71
+ route_type: 'account_number' | 'card' | null;
153
72
  /**
154
- * A Wire Decline object. This field will be present in the JSON response if and
155
- * only if `category` is equal to `wire_decline`.
73
+ * This is an object giving more details on the network-level event that caused the
74
+ * Declined Transaction. For example, for a card transaction this lists the
75
+ * merchant's industry and location. Note that for backwards compatibility reasons,
76
+ * additional undocumented keys may appear in this object. These should be treated
77
+ * as deprecated and will be removed in the future.
156
78
  */
157
- wire_decline: Source.WireDecline | null;
158
- }
159
- namespace Source {
79
+ source: DeclinedTransaction.Source;
160
80
  /**
161
- * An ACH Decline object. This field will be present in the JSON response if and
162
- * only if `category` is equal to `ach_decline`.
81
+ * A constant representing the object's type. For this resource it will always be
82
+ * `declined_transaction`.
163
83
  */
164
- interface ACHDecline {
165
- /**
166
- * The ACH Decline's identifier.
167
- */
168
- id: string;
169
- /**
170
- * The declined amount in the minor unit of the destination account currency. For
171
- * dollars, for example, this is cents.
172
- */
173
- amount: number;
174
- /**
175
- * The descriptive date of the transfer.
176
- */
177
- originator_company_descriptive_date: string | null;
178
- /**
179
- * The additional information included with the transfer.
180
- */
181
- originator_company_discretionary_data: string | null;
182
- /**
183
- * The identifier of the company that initiated the transfer.
184
- */
185
- originator_company_id: string;
186
- /**
187
- * The name of the company that initiated the transfer.
188
- */
189
- originator_company_name: string;
190
- /**
191
- * Why the ACH transfer was declined.
192
- *
193
- * - `ach_route_canceled` - The account number is canceled.
194
- * - `ach_route_disabled` - The account number is disabled.
195
- * - `breaches_limit` - The transaction would cause an Increase limit to be
196
- * exceeded.
197
- * - `credit_entry_refused_by_receiver` - A credit was refused. This is a
198
- * reasonable default reason for decline of credits.
199
- * - `duplicate_return` - A rare return reason. The return this message refers to
200
- * was a duplicate.
201
- * - `entity_not_active` - The account's entity is not active.
202
- * - `group_locked` - Your account is inactive.
203
- * - `insufficient_funds` - Your account contains insufficient funds.
204
- * - `misrouted_return` - A rare return reason. The return this message refers to
205
- * was misrouted.
206
- * - `return_of_erroneous_or_reversing_debit` - The originating financial
207
- * institution made a mistake and this return corrects it.
208
- * - `no_ach_route` - The account number that was debited does not exist.
209
- * - `originator_request` - The originating financial institution asked for this
210
- * transfer to be returned.
211
- * - `transaction_not_allowed` - The transaction is not allowed per Increase's
212
- * terms.
213
- * - `user_initiated` - The user initiated the decline.
214
- */
215
- reason:
216
- | 'ach_route_canceled'
217
- | 'ach_route_disabled'
218
- | 'breaches_limit'
219
- | 'credit_entry_refused_by_receiver'
220
- | 'duplicate_return'
221
- | 'entity_not_active'
222
- | 'group_locked'
223
- | 'insufficient_funds'
224
- | 'misrouted_return'
225
- | 'return_of_erroneous_or_reversing_debit'
226
- | 'no_ach_route'
227
- | 'originator_request'
228
- | 'transaction_not_allowed'
229
- | 'user_initiated';
230
- /**
231
- * The id of the receiver of the transfer.
232
- */
233
- receiver_id_number: string | null;
234
- /**
235
- * The name of the receiver of the transfer.
236
- */
237
- receiver_name: string | null;
238
- /**
239
- * The trace number of the transfer.
240
- */
241
- trace_number: string;
242
- /**
243
- * A constant representing the object's type. For this resource it will always be
244
- * `ach_decline`.
245
- */
246
- type: 'ach_decline';
247
- }
84
+ type: 'declined_transaction';
85
+ }
86
+ export declare namespace DeclinedTransaction {
248
87
  /**
249
- * A Card Decline object. This field will be present in the JSON response if and
250
- * only if `category` is equal to `card_decline`.
88
+ * This is an object giving more details on the network-level event that caused the
89
+ * Declined Transaction. For example, for a card transaction this lists the
90
+ * merchant's industry and location. Note that for backwards compatibility reasons,
91
+ * additional undocumented keys may appear in this object. These should be treated
92
+ * as deprecated and will be removed in the future.
251
93
  */
252
- interface CardDecline {
253
- /**
254
- * The Card Decline identifier.
255
- */
256
- id: string;
257
- /**
258
- * The declined amount in the minor unit of the destination account currency. For
259
- * dollars, for example, this is cents.
260
- */
261
- amount: number;
262
- /**
263
- * The ID of the Card Payment this transaction belongs to.
264
- */
265
- card_payment_id: string | null;
266
- /**
267
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
268
- * account currency.
269
- *
270
- * - `CAD` - Canadian Dollar (CAD)
271
- * - `CHF` - Swiss Franc (CHF)
272
- * - `EUR` - Euro (EUR)
273
- * - `GBP` - British Pound (GBP)
274
- * - `JPY` - Japanese Yen (JPY)
275
- * - `USD` - US Dollar (USD)
276
- */
277
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
278
- /**
279
- * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
280
- * purchase), the identifier of the token that was used.
281
- */
282
- digital_wallet_token_id: string | null;
283
- /**
284
- * The merchant identifier (commonly abbreviated as MID) of the merchant the card
285
- * is transacting with.
286
- */
287
- merchant_acceptor_id: string;
288
- /**
289
- * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
290
- * card is transacting with.
291
- */
292
- merchant_category_code: string | null;
293
- /**
294
- * The city the merchant resides in.
295
- */
296
- merchant_city: string | null;
297
- /**
298
- * The country the merchant resides in.
299
- */
300
- merchant_country: string | null;
301
- /**
302
- * The merchant descriptor of the merchant the card is transacting with.
303
- */
304
- merchant_descriptor: string;
305
- /**
306
- * The state the merchant resides in.
307
- */
308
- merchant_state: string | null;
309
- /**
310
- * Fields specific to the `network`.
311
- */
312
- network_details: CardDecline.NetworkDetails;
313
- /**
314
- * If the authorization was made in-person with a physical card, the Physical Card
315
- * that was used.
316
- */
317
- physical_card_id: string | null;
318
- /**
319
- * The identifier of the Real-Time Decision sent to approve or decline this
320
- * transaction.
321
- */
322
- real_time_decision_id: string | null;
323
- /**
324
- * Why the transaction was declined.
325
- *
326
- * - `card_not_active` - The Card was not active.
327
- * - `physical_card_not_active` - The Physical Card was not active.
328
- * - `entity_not_active` - The account's entity was not active.
329
- * - `group_locked` - The account was inactive.
330
- * - `insufficient_funds` - The Card's Account did not have a sufficient available
331
- * balance.
332
- * - `cvv2_mismatch` - The given CVV2 did not match the card's value.
333
- * - `transaction_not_allowed` - The attempted card transaction is not allowed per
334
- * Increase's terms.
335
- * - `breaches_limit` - The transaction was blocked by a Limit.
336
- * - `webhook_declined` - Your application declined the transaction via webhook.
337
- * - `webhook_timed_out` - Your application webhook did not respond without the
338
- * required timeout.
339
- * - `declined_by_stand_in_processing` - Declined by stand-in processing.
340
- * - `invalid_physical_card` - The card read had an invalid CVV, dCVV, or
341
- * authorization request cryptogram.
342
- * - `missing_original_authorization` - The original card authorization for this
343
- * incremental authorization does not exist.
344
- * - `suspected_fraud` - The transaction was suspected to be fraudulent. Please
345
- * reach out to support@increase.com for more information.
346
- */
347
- reason:
348
- | 'card_not_active'
349
- | 'physical_card_not_active'
350
- | 'entity_not_active'
351
- | 'group_locked'
352
- | 'insufficient_funds'
353
- | 'cvv2_mismatch'
354
- | 'transaction_not_allowed'
355
- | 'breaches_limit'
356
- | 'webhook_declined'
357
- | 'webhook_timed_out'
358
- | 'declined_by_stand_in_processing'
359
- | 'invalid_physical_card'
360
- | 'missing_original_authorization'
361
- | 'suspected_fraud';
362
- }
363
- namespace CardDecline {
364
- /**
365
- * Fields specific to the `network`.
366
- */
367
- interface NetworkDetails {
94
+ interface Source {
95
+ /**
96
+ * An ACH Decline object. This field will be present in the JSON response if and
97
+ * only if `category` is equal to `ach_decline`.
98
+ */
99
+ ach_decline: Source.ACHDecline | null;
100
+ /**
101
+ * A Card Decline object. This field will be present in the JSON response if and
102
+ * only if `category` is equal to `card_decline`.
103
+ */
104
+ card_decline: Source.CardDecline | null;
368
105
  /**
369
- * The payment network used to process this card authorization.
106
+ * The type of the resource. We may add additional possible values for this enum
107
+ * over time; your application should be able to handle such additions gracefully.
370
108
  *
371
- * - `visa` - Visa
109
+ * - `ach_decline` - ACH Decline: details will be under the `ach_decline` object.
110
+ * - `card_decline` - Card Decline: details will be under the `card_decline`
111
+ * object.
112
+ * - `check_decline` - Check Decline: details will be under the `check_decline`
113
+ * object.
114
+ * - `inbound_real_time_payments_transfer_decline` - Inbound Real-Time Payments
115
+ * Transfer Decline: details will be under the
116
+ * `inbound_real_time_payments_transfer_decline` object.
117
+ * - `international_ach_decline` - International ACH Decline: details will be under
118
+ * the `international_ach_decline` object.
119
+ * - `wire_decline` - Wire Decline: details will be under the `wire_decline`
120
+ * object.
121
+ * - `other` - The Declined Transaction was made for an undocumented or deprecated
122
+ * reason.
372
123
  */
373
- category: 'visa';
124
+ category: 'ach_decline' | 'card_decline' | 'check_decline' | 'inbound_real_time_payments_transfer_decline' | 'international_ach_decline' | 'wire_decline' | 'other';
374
125
  /**
375
- * Fields specific to the `visa` network.
126
+ * A Check Decline object. This field will be present in the JSON response if and
127
+ * only if `category` is equal to `check_decline`.
376
128
  */
377
- visa: NetworkDetails.Visa | null;
378
- }
379
- namespace NetworkDetails {
129
+ check_decline: Source.CheckDecline | null;
380
130
  /**
381
- * Fields specific to the `visa` network.
131
+ * An Inbound Real-Time Payments Transfer Decline object. This field will be
132
+ * present in the JSON response if and only if `category` is equal to
133
+ * `inbound_real_time_payments_transfer_decline`.
382
134
  */
383
- interface Visa {
384
- /**
385
- * For electronic commerce transactions, this identifies the level of security used
386
- * in obtaining the customer's payment credential. For mail or telephone order
387
- * transactions, identifies the type of mail or telephone order.
388
- *
389
- * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
390
- * that the transaction is a mail/phone order purchase, not a recurring
391
- * transaction or installment payment. For domestic transactions in the US
392
- * region, this value may also indicate one bill payment transaction in the
393
- * card-present or card-absent environments.
394
- * - `recurring` - Recurring transaction: Payment indicator used to indicate a
395
- * recurring transaction that originates from an acquirer in the US region.
396
- * - `installment` - Installment payment: Payment indicator used to indicate one
397
- * purchase of goods or services that is billed to the account in multiple
398
- * charges over a period of time agreed upon by the cardholder and merchant from
399
- * transactions that originate from an acquirer in the US region.
400
- * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
401
- * indicate that the type of mail/telephone order is unknown.
402
- * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
403
- * indicate that the electronic commerce transaction has been authenticated using
404
- * e.g., 3-D Secure
405
- * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
406
- * Non-authenticated security transaction at a 3-D Secure-capable merchant, and
407
- * merchant attempted to authenticate the cardholder using 3-D Secure: Use to
408
- * identify an electronic commerce transaction where the merchant attempted to
409
- * authenticate the cardholder using 3-D Secure, but was unable to complete the
410
- * authentication because the issuer or cardholder does not participate in the
411
- * 3-D Secure program.
412
- * - `non_authenticated_security_transaction` - Non-authenticated security
413
- * transaction: Use to identify an electronic commerce transaction that uses data
414
- * encryption for security however , cardholder authentication is not performed
415
- * using 3-D Secure.
416
- * - `non_secure_transaction` - Non-secure transaction: Use to identify an
417
- * electronic commerce transaction that has no data protection.
418
- */
419
- electronic_commerce_indicator:
420
- | 'mail_phone_order'
421
- | 'recurring'
422
- | 'installment'
423
- | 'unknown_mail_phone_order'
424
- | 'secure_electronic_commerce'
425
- | 'non_authenticated_security_transaction_at_3ds_capable_merchant'
426
- | 'non_authenticated_security_transaction'
427
- | 'non_secure_transaction'
428
- | null;
429
- /**
430
- * The method used to enter the cardholder's primary account number and card
431
- * expiration date.
432
- *
433
- * - `unknown` - Unknown
434
- * - `manual` - Manual key entry
435
- * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
436
- * value
437
- * - `optical_code` - Optical code
438
- * - `integrated_circuit_card` - Contact chip card
439
- * - `contactless` - Contactless read of chip card
440
- * - `credential_on_file` - Transaction initiated using a credential that has
441
- * previously been stored on file
442
- * - `magnetic_stripe` - Magnetic stripe read
443
- * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
444
- * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
445
- * verification value
446
- */
447
- point_of_service_entry_mode:
448
- | 'unknown'
449
- | 'manual'
450
- | 'magnetic_stripe_no_cvv'
451
- | 'optical_code'
452
- | 'integrated_circuit_card'
453
- | 'contactless'
454
- | 'credential_on_file'
455
- | 'magnetic_stripe'
456
- | 'contactless_magnetic_stripe'
457
- | 'integrated_circuit_card_no_cvv'
458
- | null;
459
- }
460
- }
461
- }
462
- /**
463
- * A Check Decline object. This field will be present in the JSON response if and
464
- * only if `category` is equal to `check_decline`.
465
- */
466
- interface CheckDecline {
467
- /**
468
- * The declined amount in the minor unit of the destination account currency. For
469
- * dollars, for example, this is cents.
470
- */
471
- amount: number;
472
- /**
473
- * A computer-readable number printed on the MICR line of business checks, usually
474
- * the check number. This is useful for positive pay checks, but can be unreliably
475
- * transmitted by the bank of first deposit.
476
- */
477
- auxiliary_on_us: string | null;
478
- /**
479
- * Why the check was declined.
480
- *
481
- * - `ach_route_disabled` - The account number is disabled.
482
- * - `ach_route_canceled` - The account number is canceled.
483
- * - `breaches_limit` - The transaction would cause a limit to be exceeded.
484
- * - `entity_not_active` - The account's entity is not active.
485
- * - `group_locked` - Your account is inactive.
486
- * - `insufficient_funds` - Your account contains insufficient funds.
487
- * - `stop_payment_requested` - Stop payment requested for this check.
488
- * - `duplicate_presentment` - The check was a duplicate deposit.
489
- * - `not_authorized` - The check was not authorized.
490
- * - `amount_mismatch` - The amount the receiving bank is attempting to deposit
491
- * does not match the amount on the check.
492
- * - `not_our_item` - The check attempting to be deposited does not belong to
493
- * Increase.
494
- */
495
- reason:
496
- | 'ach_route_disabled'
497
- | 'ach_route_canceled'
498
- | 'breaches_limit'
499
- | 'entity_not_active'
500
- | 'group_locked'
501
- | 'insufficient_funds'
502
- | 'stop_payment_requested'
503
- | 'duplicate_presentment'
504
- | 'not_authorized'
505
- | 'amount_mismatch'
506
- | 'not_our_item';
507
- }
508
- /**
509
- * An Inbound Real-Time Payments Transfer Decline object. This field will be
510
- * present in the JSON response if and only if `category` is equal to
511
- * `inbound_real_time_payments_transfer_decline`.
512
- */
513
- interface InboundRealTimePaymentsTransferDecline {
514
- /**
515
- * The declined amount in the minor unit of the destination account currency. For
516
- * dollars, for example, this is cents.
517
- */
518
- amount: number;
519
- /**
520
- * The name the sender of the transfer specified as the recipient of the transfer.
521
- */
522
- creditor_name: string;
523
- /**
524
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
525
- * transfer's currency. This will always be "USD" for a Real-Time Payments
526
- * transfer.
527
- *
528
- * - `CAD` - Canadian Dollar (CAD)
529
- * - `CHF` - Swiss Franc (CHF)
530
- * - `EUR` - Euro (EUR)
531
- * - `GBP` - British Pound (GBP)
532
- * - `JPY` - Japanese Yen (JPY)
533
- * - `USD` - US Dollar (USD)
534
- */
535
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
536
- /**
537
- * The account number of the account that sent the transfer.
538
- */
539
- debtor_account_number: string;
540
- /**
541
- * The name provided by the sender of the transfer.
542
- */
543
- debtor_name: string;
544
- /**
545
- * The routing number of the account that sent the transfer.
546
- */
547
- debtor_routing_number: string;
548
- /**
549
- * Why the transfer was declined.
550
- *
551
- * - `account_number_canceled` - The account number is canceled.
552
- * - `account_number_disabled` - The account number is disabled.
553
- * - `account_restricted` - Your account is restricted.
554
- * - `group_locked` - Your account is inactive.
555
- * - `entity_not_active` - The account's entity is not active.
556
- * - `real_time_payments_not_enabled` - Your account is not enabled to receive
557
- * Real-Time Payments transfers.
558
- */
559
- reason:
560
- | 'account_number_canceled'
561
- | 'account_number_disabled'
562
- | 'account_restricted'
563
- | 'group_locked'
564
- | 'entity_not_active'
565
- | 'real_time_payments_not_enabled';
566
- /**
567
- * Additional information included with the transfer.
568
- */
569
- remittance_information: string | null;
570
- /**
571
- * The Real-Time Payments network identification of the declined transfer.
572
- */
573
- transaction_identification: string;
574
- }
575
- /**
576
- * An International ACH Decline object. This field will be present in the JSON
577
- * response if and only if `category` is equal to `international_ach_decline`.
578
- */
579
- interface InternationalACHDecline {
580
- /**
581
- * The declined amount in the minor unit of the destination account currency. For
582
- * dollars, for example, this is cents.
583
- */
584
- amount: number;
585
- /**
586
- * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
587
- * country code of the destination country.
588
- */
589
- destination_country_code: string;
590
- /**
591
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
592
- * destination bank account.
593
- */
594
- destination_currency_code: string;
595
- /**
596
- * A description of how the foreign exchange rate was calculated.
597
- *
598
- * - `fixed_to_variable` - The originator chose an amount in their own currency.
599
- * The settled amount in USD was converted using the exchange rate.
600
- * - `variable_to_fixed` - The originator chose an amount to settle in USD. The
601
- * originator's amount was variable; known only after the foreign exchange
602
- * conversion.
603
- * - `fixed_to_fixed` - The amount was originated and settled as a fixed amount in
604
- * USD. There is no foreign exchange conversion.
605
- */
606
- foreign_exchange_indicator: 'fixed_to_variable' | 'variable_to_fixed' | 'fixed_to_fixed';
607
- /**
608
- * Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a
609
- * reference to a well-known rate.
610
- */
611
- foreign_exchange_reference: string | null;
612
- /**
613
- * An instruction of how to interpret the `foreign_exchange_reference` field for
614
- * this Transaction.
615
- *
616
- * - `foreign_exchange_rate` - The ACH file contains a foreign exchange rate.
617
- * - `foreign_exchange_reference_number` - The ACH file contains a reference to a
618
- * well-known foreign exchange rate.
619
- * - `blank` - There is no foreign exchange for this transfer, so the
620
- * `foreign_exchange_reference` field is blank.
621
- */
622
- foreign_exchange_reference_indicator:
623
- | 'foreign_exchange_rate'
624
- | 'foreign_exchange_reference_number'
625
- | 'blank';
626
- /**
627
- * The amount in the minor unit of the foreign payment currency. For dollars, for
628
- * example, this is cents.
629
- */
630
- foreign_payment_amount: number;
631
- /**
632
- * A reference number in the foreign banking infrastructure.
633
- */
634
- foreign_trace_number: string | null;
635
- /**
636
- * The type of transfer. Set by the originator.
637
- *
638
- * - `annuity` - Sent as `ANN` in the Nacha file.
639
- * - `business_or_commercial` - Sent as `BUS` in the Nacha file.
640
- * - `deposit` - Sent as `DEP` in the Nacha file.
641
- * - `loan` - Sent as `LOA` in the Nacha file.
642
- * - `miscellaneous` - Sent as `MIS` in the Nacha file.
643
- * - `mortgage` - Sent as `MOR` in the Nacha file.
644
- * - `pension` - Sent as `PEN` in the Nacha file.
645
- * - `remittance` - Sent as `REM` in the Nacha file.
646
- * - `rent_or_lease` - Sent as `RLS` in the Nacha file.
647
- * - `salary_or_payroll` - Sent as `SAL` in the Nacha file.
648
- * - `tax` - Sent as `TAX` in the Nacha file.
649
- * - `accounts_receivable` - Sent as `ARC` in the Nacha file.
650
- * - `back_office_conversion` - Sent as `BOC` in the Nacha file.
651
- * - `machine_transfer` - Sent as `MTE` in the Nacha file.
652
- * - `point_of_purchase` - Sent as `POP` in the Nacha file.
653
- * - `point_of_sale` - Sent as `POS` in the Nacha file.
654
- * - `represented_check` - Sent as `RCK` in the Nacha file.
655
- * - `shared_network_transaction` - Sent as `SHR` in the Nacha file.
656
- * - `telphone_initiated` - Sent as `TEL` in the Nacha file.
657
- * - `internet_initiated` - Sent as `WEB` in the Nacha file.
658
- */
659
- international_transaction_type_code:
660
- | 'annuity'
661
- | 'business_or_commercial'
662
- | 'deposit'
663
- | 'loan'
664
- | 'miscellaneous'
665
- | 'mortgage'
666
- | 'pension'
667
- | 'remittance'
668
- | 'rent_or_lease'
669
- | 'salary_or_payroll'
670
- | 'tax'
671
- | 'accounts_receivable'
672
- | 'back_office_conversion'
673
- | 'machine_transfer'
674
- | 'point_of_purchase'
675
- | 'point_of_sale'
676
- | 'represented_check'
677
- | 'shared_network_transaction'
678
- | 'telphone_initiated'
679
- | 'internet_initiated';
680
- /**
681
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
682
- * originating bank account.
683
- */
684
- originating_currency_code: string;
685
- /**
686
- * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
687
- * country code of the originating branch country.
688
- */
689
- originating_depository_financial_institution_branch_country: string;
690
- /**
691
- * An identifier for the originating bank. One of an International Bank Account
692
- * Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
693
- * domestic identifier like a US Routing Number.
694
- */
695
- originating_depository_financial_institution_id: string;
696
- /**
697
- * An instruction of how to interpret the
698
- * `originating_depository_financial_institution_id` field for this Transaction.
699
- *
700
- * - `national_clearing_system_number` - A domestic clearing system number. In the
701
- * US, for example, this is the American Banking Association (ABA) routing
702
- * number.
703
- * - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
704
- * - `iban` - An International Bank Account Number.
705
- */
706
- originating_depository_financial_institution_id_qualifier:
707
- | 'national_clearing_system_number'
708
- | 'bic_code'
709
- | 'iban';
710
- /**
711
- * The name of the originating bank. Sometimes this will refer to an American bank
712
- * and obscure the correspondent foreign bank.
713
- */
714
- originating_depository_financial_institution_name: string;
715
- /**
716
- * A portion of the originator address. This may be incomplete.
717
- */
718
- originator_city: string;
719
- /**
720
- * A description field set by the originator.
721
- */
722
- originator_company_entry_description: string;
723
- /**
724
- * A portion of the originator address. The
725
- * [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
726
- * code of the originator country.
727
- */
728
- originator_country: string;
729
- /**
730
- * An identifier for the originating company. This is generally stable across
731
- * multiple ACH transfers.
732
- */
733
- originator_identification: string;
734
- /**
735
- * Either the name of the originator or an intermediary money transmitter.
736
- */
737
- originator_name: string;
738
- /**
739
- * A portion of the originator address. This may be incomplete.
740
- */
741
- originator_postal_code: string | null;
742
- /**
743
- * A portion of the originator address. This may be incomplete.
744
- */
745
- originator_state_or_province: string | null;
746
- /**
747
- * A portion of the originator address. This may be incomplete.
748
- */
749
- originator_street_address: string;
750
- /**
751
- * A description field set by the originator.
752
- */
753
- payment_related_information: string | null;
754
- /**
755
- * A description field set by the originator.
756
- */
757
- payment_related_information2: string | null;
758
- /**
759
- * A portion of the receiver address. This may be incomplete.
760
- */
761
- receiver_city: string;
762
- /**
763
- * A portion of the receiver address. The
764
- * [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
765
- * code of the receiver country.
766
- */
767
- receiver_country: string;
768
- /**
769
- * An identification number the originator uses for the receiver.
770
- */
771
- receiver_identification_number: string | null;
772
- /**
773
- * A portion of the receiver address. This may be incomplete.
774
- */
775
- receiver_postal_code: string | null;
776
- /**
777
- * A portion of the receiver address. This may be incomplete.
778
- */
779
- receiver_state_or_province: string | null;
780
- /**
781
- * A portion of the receiver address. This may be incomplete.
782
- */
783
- receiver_street_address: string;
784
- /**
785
- * The name of the receiver of the transfer. This is not verified by Increase.
786
- */
787
- receiving_company_or_individual_name: string;
788
- /**
789
- * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
790
- * country code of the receiving bank country.
791
- */
792
- receiving_depository_financial_institution_country: string;
793
- /**
794
- * An identifier for the receiving bank. One of an International Bank Account
795
- * Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
796
- * domestic identifier like a US Routing Number.
797
- */
798
- receiving_depository_financial_institution_id: string;
799
- /**
800
- * An instruction of how to interpret the
801
- * `receiving_depository_financial_institution_id` field for this Transaction.
802
- *
803
- * - `national_clearing_system_number` - A domestic clearing system number. In the
804
- * US, for example, this is the American Banking Association (ABA) routing
805
- * number.
806
- * - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
807
- * - `iban` - An International Bank Account Number.
808
- */
809
- receiving_depository_financial_institution_id_qualifier:
810
- | 'national_clearing_system_number'
811
- | 'bic_code'
812
- | 'iban';
813
- /**
814
- * The name of the receiving bank, as set by the sending financial institution.
815
- */
816
- receiving_depository_financial_institution_name: string;
817
- /**
818
- * A 15 digit number recorded in the Nacha file and available to both the
819
- * originating and receiving bank. Along with the amount, date, and originating
820
- * routing number, this can be used to identify the ACH transfer at either bank.
821
- * ACH trace numbers are not unique, but are
822
- * [used to correlate returns](https://increase.com/documentation/ach#returns).
823
- */
824
- trace_number: string;
135
+ inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
136
+ /**
137
+ * An International ACH Decline object. This field will be present in the JSON
138
+ * response if and only if `category` is equal to `international_ach_decline`.
139
+ */
140
+ international_ach_decline: Source.InternationalACHDecline | null;
141
+ /**
142
+ * A Wire Decline object. This field will be present in the JSON response if and
143
+ * only if `category` is equal to `wire_decline`.
144
+ */
145
+ wire_decline: Source.WireDecline | null;
825
146
  }
826
- /**
827
- * A Wire Decline object. This field will be present in the JSON response if and
828
- * only if `category` is equal to `wire_decline`.
829
- */
830
- interface WireDecline {
831
- /**
832
- * The declined amount in the minor unit of the destination account currency. For
833
- * dollars, for example, this is cents.
834
- */
835
- amount: number;
836
- /**
837
- * A free-form address field set by the sender.
838
- */
839
- beneficiary_address_line1: string | null;
840
- /**
841
- * A free-form address field set by the sender.
842
- */
843
- beneficiary_address_line2: string | null;
844
- /**
845
- * A free-form address field set by the sender.
846
- */
847
- beneficiary_address_line3: string | null;
848
- /**
849
- * A name set by the sender.
850
- */
851
- beneficiary_name: string | null;
852
- /**
853
- * A free-form reference string set by the sender, to help identify the transfer.
854
- */
855
- beneficiary_reference: string | null;
856
- /**
857
- * An Increase-constructed description of the declined transaction.
858
- */
859
- description: string;
860
- /**
861
- * A unique identifier available to the originating and receiving banks, commonly
862
- * abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
863
- * service and is helpful when debugging wires with the originating bank.
864
- */
865
- input_message_accountability_data: string | null;
866
- /**
867
- * The address of the wire originator, set by the sending bank.
868
- */
869
- originator_address_line1: string | null;
870
- /**
871
- * The address of the wire originator, set by the sending bank.
872
- */
873
- originator_address_line2: string | null;
874
- /**
875
- * The address of the wire originator, set by the sending bank.
876
- */
877
- originator_address_line3: string | null;
878
- /**
879
- * The originator of the wire, set by the sending bank.
880
- */
881
- originator_name: string | null;
882
- /**
883
- * A free-form message set by the wire originator.
884
- */
885
- originator_to_beneficiary_information_line1: string | null;
886
- /**
887
- * A free-form message set by the wire originator.
888
- */
889
- originator_to_beneficiary_information_line2: string | null;
890
- /**
891
- * A free-form message set by the wire originator.
892
- */
893
- originator_to_beneficiary_information_line3: string | null;
894
- /**
895
- * A free-form message set by the wire originator.
896
- */
897
- originator_to_beneficiary_information_line4: string | null;
898
- /**
899
- * Why the wire transfer was declined.
900
- *
901
- * - `account_number_canceled` - The account number is canceled.
902
- * - `account_number_disabled` - The account number is disabled.
903
- * - `entity_not_active` - The account's entity is not active.
904
- * - `group_locked` - Your account is inactive.
905
- * - `no_account_number` - The beneficiary account number does not exist.
906
- * - `transaction_not_allowed` - The transaction is not allowed per Increase's
907
- * terms.
908
- */
909
- reason:
910
- | 'account_number_canceled'
911
- | 'account_number_disabled'
912
- | 'entity_not_active'
913
- | 'group_locked'
914
- | 'no_account_number'
915
- | 'transaction_not_allowed';
147
+ namespace Source {
148
+ /**
149
+ * An ACH Decline object. This field will be present in the JSON response if and
150
+ * only if `category` is equal to `ach_decline`.
151
+ */
152
+ interface ACHDecline {
153
+ /**
154
+ * The ACH Decline's identifier.
155
+ */
156
+ id: string;
157
+ /**
158
+ * The declined amount in the minor unit of the destination account currency. For
159
+ * dollars, for example, this is cents.
160
+ */
161
+ amount: number;
162
+ /**
163
+ * The descriptive date of the transfer.
164
+ */
165
+ originator_company_descriptive_date: string | null;
166
+ /**
167
+ * The additional information included with the transfer.
168
+ */
169
+ originator_company_discretionary_data: string | null;
170
+ /**
171
+ * The identifier of the company that initiated the transfer.
172
+ */
173
+ originator_company_id: string;
174
+ /**
175
+ * The name of the company that initiated the transfer.
176
+ */
177
+ originator_company_name: string;
178
+ /**
179
+ * Why the ACH transfer was declined.
180
+ *
181
+ * - `ach_route_canceled` - The account number is canceled.
182
+ * - `ach_route_disabled` - The account number is disabled.
183
+ * - `breaches_limit` - The transaction would cause an Increase limit to be
184
+ * exceeded.
185
+ * - `credit_entry_refused_by_receiver` - A credit was refused. This is a
186
+ * reasonable default reason for decline of credits.
187
+ * - `duplicate_return` - A rare return reason. The return this message refers to
188
+ * was a duplicate.
189
+ * - `entity_not_active` - The account's entity is not active.
190
+ * - `group_locked` - Your account is inactive.
191
+ * - `insufficient_funds` - Your account contains insufficient funds.
192
+ * - `misrouted_return` - A rare return reason. The return this message refers to
193
+ * was misrouted.
194
+ * - `return_of_erroneous_or_reversing_debit` - The originating financial
195
+ * institution made a mistake and this return corrects it.
196
+ * - `no_ach_route` - The account number that was debited does not exist.
197
+ * - `originator_request` - The originating financial institution asked for this
198
+ * transfer to be returned.
199
+ * - `transaction_not_allowed` - The transaction is not allowed per Increase's
200
+ * terms.
201
+ * - `user_initiated` - The user initiated the decline.
202
+ */
203
+ reason: 'ach_route_canceled' | 'ach_route_disabled' | 'breaches_limit' | 'credit_entry_refused_by_receiver' | 'duplicate_return' | 'entity_not_active' | 'group_locked' | 'insufficient_funds' | 'misrouted_return' | 'return_of_erroneous_or_reversing_debit' | 'no_ach_route' | 'originator_request' | 'transaction_not_allowed' | 'user_initiated';
204
+ /**
205
+ * The id of the receiver of the transfer.
206
+ */
207
+ receiver_id_number: string | null;
208
+ /**
209
+ * The name of the receiver of the transfer.
210
+ */
211
+ receiver_name: string | null;
212
+ /**
213
+ * The trace number of the transfer.
214
+ */
215
+ trace_number: string;
216
+ /**
217
+ * A constant representing the object's type. For this resource it will always be
218
+ * `ach_decline`.
219
+ */
220
+ type: 'ach_decline';
221
+ }
222
+ /**
223
+ * A Card Decline object. This field will be present in the JSON response if and
224
+ * only if `category` is equal to `card_decline`.
225
+ */
226
+ interface CardDecline {
227
+ /**
228
+ * The Card Decline identifier.
229
+ */
230
+ id: string;
231
+ /**
232
+ * The declined amount in the minor unit of the destination account currency. For
233
+ * dollars, for example, this is cents.
234
+ */
235
+ amount: number;
236
+ /**
237
+ * The ID of the Card Payment this transaction belongs to.
238
+ */
239
+ card_payment_id: string | null;
240
+ /**
241
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
242
+ * account currency.
243
+ *
244
+ * - `CAD` - Canadian Dollar (CAD)
245
+ * - `CHF` - Swiss Franc (CHF)
246
+ * - `EUR` - Euro (EUR)
247
+ * - `GBP` - British Pound (GBP)
248
+ * - `JPY` - Japanese Yen (JPY)
249
+ * - `USD` - US Dollar (USD)
250
+ */
251
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
252
+ /**
253
+ * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
254
+ * purchase), the identifier of the token that was used.
255
+ */
256
+ digital_wallet_token_id: string | null;
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
+ * The state the merchant resides in.
281
+ */
282
+ merchant_state: string | null;
283
+ /**
284
+ * Fields specific to the `network`.
285
+ */
286
+ network_details: CardDecline.NetworkDetails;
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
+ * Why the transaction was declined.
299
+ *
300
+ * - `card_not_active` - The Card was not active.
301
+ * - `physical_card_not_active` - The Physical Card was not active.
302
+ * - `entity_not_active` - The account's entity was not active.
303
+ * - `group_locked` - The account was inactive.
304
+ * - `insufficient_funds` - The Card's Account did not have a sufficient available
305
+ * balance.
306
+ * - `cvv2_mismatch` - The given CVV2 did not match the card's value.
307
+ * - `transaction_not_allowed` - The attempted card transaction is not allowed per
308
+ * Increase's terms.
309
+ * - `breaches_limit` - The transaction was blocked by a Limit.
310
+ * - `webhook_declined` - Your application declined the transaction via webhook.
311
+ * - `webhook_timed_out` - Your application webhook did not respond without the
312
+ * required timeout.
313
+ * - `declined_by_stand_in_processing` - Declined by stand-in processing.
314
+ * - `invalid_physical_card` - The card read had an invalid CVV, dCVV, or
315
+ * authorization request cryptogram.
316
+ * - `missing_original_authorization` - The original card authorization for this
317
+ * incremental authorization does not exist.
318
+ * - `suspected_fraud` - The transaction was suspected to be fraudulent. Please
319
+ * reach out to support@increase.com for more information.
320
+ */
321
+ reason: 'card_not_active' | 'physical_card_not_active' | 'entity_not_active' | 'group_locked' | 'insufficient_funds' | 'cvv2_mismatch' | 'transaction_not_allowed' | 'breaches_limit' | 'webhook_declined' | 'webhook_timed_out' | 'declined_by_stand_in_processing' | 'invalid_physical_card' | 'missing_original_authorization' | 'suspected_fraud';
322
+ }
323
+ namespace CardDecline {
324
+ /**
325
+ * Fields specific to the `network`.
326
+ */
327
+ interface NetworkDetails {
328
+ /**
329
+ * The payment network used to process this card authorization.
330
+ *
331
+ * - `visa` - Visa
332
+ */
333
+ category: 'visa';
334
+ /**
335
+ * Fields specific to the `visa` network.
336
+ */
337
+ visa: NetworkDetails.Visa | null;
338
+ }
339
+ namespace NetworkDetails {
340
+ /**
341
+ * Fields specific to the `visa` network.
342
+ */
343
+ 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
+ * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
350
+ * that the transaction is a mail/phone order purchase, not a recurring
351
+ * transaction or installment payment. For domestic transactions in the US
352
+ * region, this value may also indicate one bill payment transaction in the
353
+ * card-present or card-absent environments.
354
+ * - `recurring` - Recurring transaction: Payment indicator used to indicate a
355
+ * recurring transaction that originates from an acquirer in the US region.
356
+ * - `installment` - Installment payment: Payment indicator used to indicate one
357
+ * purchase of goods or services that is billed to the account in multiple
358
+ * charges over a period of time agreed upon by the cardholder and merchant from
359
+ * transactions that originate from an acquirer in the US region.
360
+ * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
361
+ * indicate that the type of mail/telephone order is unknown.
362
+ * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
363
+ * indicate that the electronic commerce transaction has been authenticated using
364
+ * e.g., 3-D Secure
365
+ * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
366
+ * Non-authenticated security transaction at a 3-D Secure-capable merchant, and
367
+ * merchant attempted to authenticate the cardholder using 3-D Secure: Use to
368
+ * identify an electronic commerce transaction where the merchant attempted to
369
+ * authenticate the cardholder using 3-D Secure, but was unable to complete the
370
+ * authentication because the issuer or cardholder does not participate in the
371
+ * 3-D Secure program.
372
+ * - `non_authenticated_security_transaction` - Non-authenticated security
373
+ * transaction: Use to identify an electronic commerce transaction that uses data
374
+ * encryption for security however , cardholder authentication is not performed
375
+ * using 3-D Secure.
376
+ * - `non_secure_transaction` - Non-secure transaction: Use to identify an
377
+ * electronic commerce transaction that has no data protection.
378
+ */
379
+ 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;
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: '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;
399
+ }
400
+ }
401
+ }
402
+ /**
403
+ * A Check Decline object. This field will be present in the JSON response if and
404
+ * only if `category` is equal to `check_decline`.
405
+ */
406
+ interface CheckDecline {
407
+ /**
408
+ * The declined amount in the minor unit of the destination account currency. For
409
+ * dollars, for example, this is cents.
410
+ */
411
+ amount: number;
412
+ /**
413
+ * A computer-readable number printed on the MICR line of business checks, usually
414
+ * the check number. This is useful for positive pay checks, but can be unreliably
415
+ * transmitted by the bank of first deposit.
416
+ */
417
+ auxiliary_on_us: string | null;
418
+ /**
419
+ * Why the check was declined.
420
+ *
421
+ * - `ach_route_disabled` - The account number is disabled.
422
+ * - `ach_route_canceled` - The account number is canceled.
423
+ * - `breaches_limit` - The transaction would cause a limit to be exceeded.
424
+ * - `entity_not_active` - The account's entity is not active.
425
+ * - `group_locked` - Your account is inactive.
426
+ * - `insufficient_funds` - Your account contains insufficient funds.
427
+ * - `stop_payment_requested` - Stop payment requested for this check.
428
+ * - `duplicate_presentment` - The check was a duplicate deposit.
429
+ * - `not_authorized` - The check was not authorized.
430
+ * - `amount_mismatch` - The amount the receiving bank is attempting to deposit
431
+ * does not match the amount on the check.
432
+ * - `not_our_item` - The check attempting to be deposited does not belong to
433
+ * Increase.
434
+ */
435
+ reason: 'ach_route_disabled' | 'ach_route_canceled' | 'breaches_limit' | 'entity_not_active' | 'group_locked' | 'insufficient_funds' | 'stop_payment_requested' | 'duplicate_presentment' | 'not_authorized' | 'amount_mismatch' | 'not_our_item';
436
+ }
437
+ /**
438
+ * An Inbound Real-Time Payments Transfer Decline object. This field will be
439
+ * present in the JSON response if and only if `category` is equal to
440
+ * `inbound_real_time_payments_transfer_decline`.
441
+ */
442
+ interface InboundRealTimePaymentsTransferDecline {
443
+ /**
444
+ * The declined amount in the minor unit of the destination account currency. For
445
+ * dollars, for example, this is cents.
446
+ */
447
+ amount: number;
448
+ /**
449
+ * The name the sender of the transfer specified as the recipient of the transfer.
450
+ */
451
+ creditor_name: string;
452
+ /**
453
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
454
+ * transfer's currency. This will always be "USD" for a Real-Time Payments
455
+ * transfer.
456
+ *
457
+ * - `CAD` - Canadian Dollar (CAD)
458
+ * - `CHF` - Swiss Franc (CHF)
459
+ * - `EUR` - Euro (EUR)
460
+ * - `GBP` - British Pound (GBP)
461
+ * - `JPY` - Japanese Yen (JPY)
462
+ * - `USD` - US Dollar (USD)
463
+ */
464
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
465
+ /**
466
+ * The account number of the account that sent the transfer.
467
+ */
468
+ debtor_account_number: string;
469
+ /**
470
+ * The name provided by the sender of the transfer.
471
+ */
472
+ debtor_name: string;
473
+ /**
474
+ * The routing number of the account that sent the transfer.
475
+ */
476
+ debtor_routing_number: string;
477
+ /**
478
+ * Why the transfer was declined.
479
+ *
480
+ * - `account_number_canceled` - The account number is canceled.
481
+ * - `account_number_disabled` - The account number is disabled.
482
+ * - `account_restricted` - Your account is restricted.
483
+ * - `group_locked` - Your account is inactive.
484
+ * - `entity_not_active` - The account's entity is not active.
485
+ * - `real_time_payments_not_enabled` - Your account is not enabled to receive
486
+ * Real-Time Payments transfers.
487
+ */
488
+ reason: 'account_number_canceled' | 'account_number_disabled' | 'account_restricted' | 'group_locked' | 'entity_not_active' | 'real_time_payments_not_enabled';
489
+ /**
490
+ * Additional information included with the transfer.
491
+ */
492
+ remittance_information: string | null;
493
+ /**
494
+ * The Real-Time Payments network identification of the declined transfer.
495
+ */
496
+ transaction_identification: string;
497
+ }
498
+ /**
499
+ * An International ACH Decline object. This field will be present in the JSON
500
+ * response if and only if `category` is equal to `international_ach_decline`.
501
+ */
502
+ interface InternationalACHDecline {
503
+ /**
504
+ * The declined amount in the minor unit of the destination account currency. For
505
+ * dollars, for example, this is cents.
506
+ */
507
+ amount: number;
508
+ /**
509
+ * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
510
+ * country code of the destination country.
511
+ */
512
+ destination_country_code: string;
513
+ /**
514
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
515
+ * destination bank account.
516
+ */
517
+ destination_currency_code: string;
518
+ /**
519
+ * A description of how the foreign exchange rate was calculated.
520
+ *
521
+ * - `fixed_to_variable` - The originator chose an amount in their own currency.
522
+ * The settled amount in USD was converted using the exchange rate.
523
+ * - `variable_to_fixed` - The originator chose an amount to settle in USD. The
524
+ * originator's amount was variable; known only after the foreign exchange
525
+ * conversion.
526
+ * - `fixed_to_fixed` - The amount was originated and settled as a fixed amount in
527
+ * USD. There is no foreign exchange conversion.
528
+ */
529
+ foreign_exchange_indicator: 'fixed_to_variable' | 'variable_to_fixed' | 'fixed_to_fixed';
530
+ /**
531
+ * Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a
532
+ * reference to a well-known rate.
533
+ */
534
+ foreign_exchange_reference: string | null;
535
+ /**
536
+ * An instruction of how to interpret the `foreign_exchange_reference` field for
537
+ * this Transaction.
538
+ *
539
+ * - `foreign_exchange_rate` - The ACH file contains a foreign exchange rate.
540
+ * - `foreign_exchange_reference_number` - The ACH file contains a reference to a
541
+ * well-known foreign exchange rate.
542
+ * - `blank` - There is no foreign exchange for this transfer, so the
543
+ * `foreign_exchange_reference` field is blank.
544
+ */
545
+ foreign_exchange_reference_indicator: 'foreign_exchange_rate' | 'foreign_exchange_reference_number' | 'blank';
546
+ /**
547
+ * The amount in the minor unit of the foreign payment currency. For dollars, for
548
+ * example, this is cents.
549
+ */
550
+ foreign_payment_amount: number;
551
+ /**
552
+ * A reference number in the foreign banking infrastructure.
553
+ */
554
+ foreign_trace_number: string | null;
555
+ /**
556
+ * The type of transfer. Set by the originator.
557
+ *
558
+ * - `annuity` - Sent as `ANN` in the Nacha file.
559
+ * - `business_or_commercial` - Sent as `BUS` in the Nacha file.
560
+ * - `deposit` - Sent as `DEP` in the Nacha file.
561
+ * - `loan` - Sent as `LOA` in the Nacha file.
562
+ * - `miscellaneous` - Sent as `MIS` in the Nacha file.
563
+ * - `mortgage` - Sent as `MOR` in the Nacha file.
564
+ * - `pension` - Sent as `PEN` in the Nacha file.
565
+ * - `remittance` - Sent as `REM` in the Nacha file.
566
+ * - `rent_or_lease` - Sent as `RLS` in the Nacha file.
567
+ * - `salary_or_payroll` - Sent as `SAL` in the Nacha file.
568
+ * - `tax` - Sent as `TAX` in the Nacha file.
569
+ * - `accounts_receivable` - Sent as `ARC` in the Nacha file.
570
+ * - `back_office_conversion` - Sent as `BOC` in the Nacha file.
571
+ * - `machine_transfer` - Sent as `MTE` in the Nacha file.
572
+ * - `point_of_purchase` - Sent as `POP` in the Nacha file.
573
+ * - `point_of_sale` - Sent as `POS` in the Nacha file.
574
+ * - `represented_check` - Sent as `RCK` in the Nacha file.
575
+ * - `shared_network_transaction` - Sent as `SHR` in the Nacha file.
576
+ * - `telphone_initiated` - Sent as `TEL` in the Nacha file.
577
+ * - `internet_initiated` - Sent as `WEB` in the Nacha file.
578
+ */
579
+ international_transaction_type_code: 'annuity' | 'business_or_commercial' | 'deposit' | 'loan' | 'miscellaneous' | 'mortgage' | 'pension' | 'remittance' | 'rent_or_lease' | 'salary_or_payroll' | 'tax' | 'accounts_receivable' | 'back_office_conversion' | 'machine_transfer' | 'point_of_purchase' | 'point_of_sale' | 'represented_check' | 'shared_network_transaction' | 'telphone_initiated' | 'internet_initiated';
580
+ /**
581
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
582
+ * originating bank account.
583
+ */
584
+ originating_currency_code: string;
585
+ /**
586
+ * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
587
+ * country code of the originating branch country.
588
+ */
589
+ originating_depository_financial_institution_branch_country: string;
590
+ /**
591
+ * An identifier for the originating bank. One of an International Bank Account
592
+ * Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
593
+ * domestic identifier like a US Routing Number.
594
+ */
595
+ originating_depository_financial_institution_id: string;
596
+ /**
597
+ * An instruction of how to interpret the
598
+ * `originating_depository_financial_institution_id` field for this Transaction.
599
+ *
600
+ * - `national_clearing_system_number` - A domestic clearing system number. In the
601
+ * US, for example, this is the American Banking Association (ABA) routing
602
+ * number.
603
+ * - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
604
+ * - `iban` - An International Bank Account Number.
605
+ */
606
+ originating_depository_financial_institution_id_qualifier: 'national_clearing_system_number' | 'bic_code' | 'iban';
607
+ /**
608
+ * The name of the originating bank. Sometimes this will refer to an American bank
609
+ * and obscure the correspondent foreign bank.
610
+ */
611
+ originating_depository_financial_institution_name: string;
612
+ /**
613
+ * A portion of the originator address. This may be incomplete.
614
+ */
615
+ originator_city: string;
616
+ /**
617
+ * A description field set by the originator.
618
+ */
619
+ originator_company_entry_description: string;
620
+ /**
621
+ * A portion of the originator address. The
622
+ * [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
623
+ * code of the originator country.
624
+ */
625
+ originator_country: string;
626
+ /**
627
+ * An identifier for the originating company. This is generally stable across
628
+ * multiple ACH transfers.
629
+ */
630
+ originator_identification: string;
631
+ /**
632
+ * Either the name of the originator or an intermediary money transmitter.
633
+ */
634
+ originator_name: string;
635
+ /**
636
+ * A portion of the originator address. This may be incomplete.
637
+ */
638
+ originator_postal_code: string | null;
639
+ /**
640
+ * A portion of the originator address. This may be incomplete.
641
+ */
642
+ originator_state_or_province: string | null;
643
+ /**
644
+ * A portion of the originator address. This may be incomplete.
645
+ */
646
+ originator_street_address: string;
647
+ /**
648
+ * A description field set by the originator.
649
+ */
650
+ payment_related_information: string | null;
651
+ /**
652
+ * A description field set by the originator.
653
+ */
654
+ payment_related_information2: string | null;
655
+ /**
656
+ * A portion of the receiver address. This may be incomplete.
657
+ */
658
+ receiver_city: string;
659
+ /**
660
+ * A portion of the receiver address. The
661
+ * [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
662
+ * code of the receiver country.
663
+ */
664
+ receiver_country: string;
665
+ /**
666
+ * An identification number the originator uses for the receiver.
667
+ */
668
+ receiver_identification_number: string | null;
669
+ /**
670
+ * A portion of the receiver address. This may be incomplete.
671
+ */
672
+ receiver_postal_code: string | null;
673
+ /**
674
+ * A portion of the receiver address. This may be incomplete.
675
+ */
676
+ receiver_state_or_province: string | null;
677
+ /**
678
+ * A portion of the receiver address. This may be incomplete.
679
+ */
680
+ receiver_street_address: string;
681
+ /**
682
+ * The name of the receiver of the transfer. This is not verified by Increase.
683
+ */
684
+ receiving_company_or_individual_name: string;
685
+ /**
686
+ * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
687
+ * country code of the receiving bank country.
688
+ */
689
+ receiving_depository_financial_institution_country: string;
690
+ /**
691
+ * An identifier for the receiving bank. One of an International Bank Account
692
+ * Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
693
+ * domestic identifier like a US Routing Number.
694
+ */
695
+ receiving_depository_financial_institution_id: string;
696
+ /**
697
+ * An instruction of how to interpret the
698
+ * `receiving_depository_financial_institution_id` field for this Transaction.
699
+ *
700
+ * - `national_clearing_system_number` - A domestic clearing system number. In the
701
+ * US, for example, this is the American Banking Association (ABA) routing
702
+ * number.
703
+ * - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
704
+ * - `iban` - An International Bank Account Number.
705
+ */
706
+ receiving_depository_financial_institution_id_qualifier: 'national_clearing_system_number' | 'bic_code' | 'iban';
707
+ /**
708
+ * The name of the receiving bank, as set by the sending financial institution.
709
+ */
710
+ receiving_depository_financial_institution_name: string;
711
+ /**
712
+ * A 15 digit number recorded in the Nacha file and available to both the
713
+ * originating and receiving bank. Along with the amount, date, and originating
714
+ * routing number, this can be used to identify the ACH transfer at either bank.
715
+ * ACH trace numbers are not unique, but are
716
+ * [used to correlate returns](https://increase.com/documentation/ach#returns).
717
+ */
718
+ trace_number: string;
719
+ }
720
+ /**
721
+ * A Wire Decline object. This field will be present in the JSON response if and
722
+ * only if `category` is equal to `wire_decline`.
723
+ */
724
+ interface WireDecline {
725
+ /**
726
+ * The declined amount in the minor unit of the destination account currency. For
727
+ * dollars, for example, this is cents.
728
+ */
729
+ amount: number;
730
+ /**
731
+ * A free-form address field set by the sender.
732
+ */
733
+ beneficiary_address_line1: string | null;
734
+ /**
735
+ * A free-form address field set by the sender.
736
+ */
737
+ beneficiary_address_line2: string | null;
738
+ /**
739
+ * A free-form address field set by the sender.
740
+ */
741
+ beneficiary_address_line3: string | null;
742
+ /**
743
+ * A name set by the sender.
744
+ */
745
+ beneficiary_name: string | null;
746
+ /**
747
+ * A free-form reference string set by the sender, to help identify the transfer.
748
+ */
749
+ beneficiary_reference: string | null;
750
+ /**
751
+ * An Increase-constructed description of the declined transaction.
752
+ */
753
+ description: string;
754
+ /**
755
+ * A unique identifier available to the originating and receiving banks, commonly
756
+ * abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
757
+ * service and is helpful when debugging wires with the originating bank.
758
+ */
759
+ input_message_accountability_data: string | null;
760
+ /**
761
+ * The address of the wire originator, set by the sending bank.
762
+ */
763
+ originator_address_line1: string | null;
764
+ /**
765
+ * The address of the wire originator, set by the sending bank.
766
+ */
767
+ originator_address_line2: string | null;
768
+ /**
769
+ * The address of the wire originator, set by the sending bank.
770
+ */
771
+ originator_address_line3: string | null;
772
+ /**
773
+ * The originator of the wire, set by the sending bank.
774
+ */
775
+ originator_name: string | null;
776
+ /**
777
+ * The American Banking Association (ABA) routing number of the bank originating
778
+ * the transfer.
779
+ */
780
+ originator_routing_number: string | null;
781
+ /**
782
+ * A free-form message set by the wire originator.
783
+ */
784
+ originator_to_beneficiary_information_line1: string | null;
785
+ /**
786
+ * A free-form message set by the wire originator.
787
+ */
788
+ originator_to_beneficiary_information_line2: string | null;
789
+ /**
790
+ * A free-form message set by the wire originator.
791
+ */
792
+ originator_to_beneficiary_information_line3: string | null;
793
+ /**
794
+ * A free-form message set by the wire originator.
795
+ */
796
+ originator_to_beneficiary_information_line4: string | null;
797
+ /**
798
+ * Why the wire transfer was declined.
799
+ *
800
+ * - `account_number_canceled` - The account number is canceled.
801
+ * - `account_number_disabled` - The account number is disabled.
802
+ * - `entity_not_active` - The account's entity is not active.
803
+ * - `group_locked` - Your account is inactive.
804
+ * - `no_account_number` - The beneficiary account number does not exist.
805
+ * - `transaction_not_allowed` - The transaction is not allowed per Increase's
806
+ * terms.
807
+ */
808
+ reason: 'account_number_canceled' | 'account_number_disabled' | 'entity_not_active' | 'group_locked' | 'no_account_number' | 'transaction_not_allowed';
809
+ }
916
810
  }
917
- }
918
811
  }
919
812
  export interface DeclinedTransactionListParams extends PageParams {
920
- /**
921
- * Filter Declined Transactions to ones belonging to the specified Account.
922
- */
923
- account_id?: string;
924
- category?: DeclinedTransactionListParams.Category;
925
- created_at?: DeclinedTransactionListParams.CreatedAt;
926
- /**
927
- * Filter Declined Transactions to those belonging to the specified route.
928
- */
929
- route_id?: string;
930
- }
931
- export declare namespace DeclinedTransactionListParams {
932
- interface Category {
933
- /**
934
- * Return results whose value is in the provided list. For GET requests, this
935
- * should be encoded as a comma-delimited string, such as `?in=one,two,three`.
936
- */
937
- in?: Array<
938
- | 'ach_decline'
939
- | 'card_decline'
940
- | 'check_decline'
941
- | 'inbound_real_time_payments_transfer_decline'
942
- | 'international_ach_decline'
943
- | 'wire_decline'
944
- | 'other'
945
- >;
946
- }
947
- interface CreatedAt {
948
- /**
949
- * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
950
- * timestamp.
951
- */
952
- after?: string;
953
- /**
954
- * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
955
- * timestamp.
956
- */
957
- before?: string;
958
813
  /**
959
- * Return results on or after this
960
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
814
+ * Filter Declined Transactions to ones belonging to the specified Account.
961
815
  */
962
- on_or_after?: string;
816
+ account_id?: string;
817
+ category?: DeclinedTransactionListParams.Category;
818
+ created_at?: DeclinedTransactionListParams.CreatedAt;
963
819
  /**
964
- * Return results on or before this
965
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
820
+ * Filter Declined Transactions to those belonging to the specified route.
966
821
  */
967
- on_or_before?: string;
968
- }
822
+ route_id?: string;
823
+ }
824
+ export declare namespace DeclinedTransactionListParams {
825
+ interface Category {
826
+ /**
827
+ * Return results whose value is in the provided list. For GET requests, this
828
+ * should be encoded as a comma-delimited string, such as `?in=one,two,three`.
829
+ */
830
+ in?: Array<'ach_decline' | 'card_decline' | 'check_decline' | 'inbound_real_time_payments_transfer_decline' | 'international_ach_decline' | 'wire_decline' | 'other'>;
831
+ }
832
+ interface CreatedAt {
833
+ /**
834
+ * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
835
+ * timestamp.
836
+ */
837
+ after?: string;
838
+ /**
839
+ * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
840
+ * timestamp.
841
+ */
842
+ before?: string;
843
+ /**
844
+ * Return results on or after this
845
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
846
+ */
847
+ on_or_after?: string;
848
+ /**
849
+ * Return results on or before this
850
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
851
+ */
852
+ on_or_before?: string;
853
+ }
969
854
  }
970
855
  export declare namespace DeclinedTransactions {
971
- export import DeclinedTransaction = API.DeclinedTransaction;
972
- type DeclinedTransactionsPage = _DeclinedTransactionsPage;
973
- export import DeclinedTransactionListParams = API.DeclinedTransactionListParams;
856
+ export import DeclinedTransaction = API.DeclinedTransaction;
857
+ type DeclinedTransactionsPage = _DeclinedTransactionsPage;
858
+ export import DeclinedTransactionListParams = API.DeclinedTransactionListParams;
974
859
  }
975
860
  export {};
976
- //# sourceMappingURL=declined-transactions.d.ts.map
861
+ //# sourceMappingURL=declined-transactions.d.ts.map