increase 0.11.0 → 0.11.2

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 (517) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/README.md +8 -4
  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 +673 -729
  76. package/core.js.map +1 -1
  77. package/core.mjs +667 -680
  78. package/core.mjs.map +1 -1
  79. package/error.d.ts +104 -177
  80. package/error.js +247 -280
  81. package/error.js.map +1 -1
  82. package/error.mjs +244 -252
  83. package/error.mjs.map +1 -1
  84. package/index.d.mts +332 -356
  85. package/index.d.ts +332 -356
  86. package/index.d.ts.map +1 -1
  87. package/index.js +193 -264
  88. package/index.mjs +170 -198
  89. package/package.json +31 -23
  90. package/pagination.d.ts +25 -25
  91. package/pagination.js +29 -25
  92. package/pagination.mjs +27 -23
  93. package/resource.d.ts +10 -10
  94. package/resource.js +12 -12
  95. package/resource.mjs +10 -10
  96. package/resources/account-numbers.d.ts +162 -168
  97. package/resources/account-numbers.js +33 -31
  98. package/resources/account-numbers.mjs +28 -26
  99. package/resources/account-statements.d.ts +79 -81
  100. package/resources/account-statements.js +21 -21
  101. package/resources/account-statements.mjs +16 -14
  102. package/resources/account-transfers.d.ts +192 -194
  103. package/resources/account-transfers.js +39 -39
  104. package/resources/account-transfers.mjs +34 -32
  105. package/resources/accounts.d.ts +148 -151
  106. package/resources/accounts.js +39 -37
  107. package/resources/accounts.mjs +34 -32
  108. package/resources/ach-prenotifications.d.ts +370 -438
  109. package/resources/ach-prenotifications.d.ts.map +1 -1
  110. package/resources/ach-prenotifications.js +27 -27
  111. package/resources/ach-prenotifications.js.map +1 -1
  112. package/resources/ach-prenotifications.mjs +22 -20
  113. package/resources/ach-prenotifications.mjs.map +1 -1
  114. package/resources/ach-transfers.d.ts +604 -679
  115. package/resources/ach-transfers.d.ts.map +1 -1
  116. package/resources/ach-transfers.js +39 -37
  117. package/resources/ach-transfers.js.map +1 -1
  118. package/resources/ach-transfers.mjs +34 -32
  119. package/resources/ach-transfers.mjs.map +1 -1
  120. package/resources/balance-lookups.d.ts +35 -38
  121. package/resources/balance-lookups.js +12 -11
  122. package/resources/balance-lookups.mjs +9 -8
  123. package/resources/bookkeeping-accounts.d.ts +66 -70
  124. package/resources/bookkeeping-accounts.js +21 -21
  125. package/resources/bookkeeping-accounts.mjs +16 -14
  126. package/resources/bookkeeping-entries.d.ts +36 -37
  127. package/resources/bookkeeping-entries.js +15 -15
  128. package/resources/bookkeeping-entries.mjs +10 -8
  129. package/resources/bookkeeping-entry-sets.d.ts +61 -64
  130. package/resources/bookkeeping-entry-sets.js +12 -13
  131. package/resources/bookkeeping-entry-sets.mjs +9 -8
  132. package/resources/card-disputes.d.ts +127 -129
  133. package/resources/card-disputes.js +27 -25
  134. package/resources/card-disputes.mjs +22 -20
  135. package/resources/card-profiles.d.ts +235 -245
  136. package/resources/card-profiles.js +33 -31
  137. package/resources/card-profiles.mjs +28 -26
  138. package/resources/card-purchase-supplements.d.ts +219 -238
  139. package/resources/card-purchase-supplements.js +21 -21
  140. package/resources/card-purchase-supplements.mjs +16 -14
  141. package/resources/cards.d.ts +288 -279
  142. package/resources/cards.d.ts.map +1 -1
  143. package/resources/cards.js +39 -37
  144. package/resources/cards.js.map +1 -1
  145. package/resources/cards.mjs +34 -32
  146. package/resources/cards.mjs.map +1 -1
  147. package/resources/check-deposits.d.ts +238 -260
  148. package/resources/check-deposits.js +27 -25
  149. package/resources/check-deposits.mjs +22 -20
  150. package/resources/check-transfers.d.ts +487 -503
  151. package/resources/check-transfers.js +45 -43
  152. package/resources/check-transfers.mjs +40 -38
  153. package/resources/declined-transactions.d.ts +806 -918
  154. package/resources/declined-transactions.d.ts.map +1 -1
  155. package/resources/declined-transactions.js +21 -21
  156. package/resources/declined-transactions.js.map +1 -1
  157. package/resources/declined-transactions.mjs +16 -14
  158. package/resources/declined-transactions.mjs.map +1 -1
  159. package/resources/digital-wallet-tokens.d.ts +75 -77
  160. package/resources/digital-wallet-tokens.js +21 -21
  161. package/resources/digital-wallet-tokens.mjs +16 -14
  162. package/resources/documents.d.ts +78 -77
  163. package/resources/documents.js +21 -19
  164. package/resources/documents.mjs +16 -14
  165. package/resources/entities/beneficial-owners.d.ts +233 -244
  166. package/resources/entities/beneficial-owners.js +24 -25
  167. package/resources/entities/beneficial-owners.mjs +21 -20
  168. package/resources/entities/entities.d.ts +1532 -1585
  169. package/resources/entities/entities.d.ts.map +1 -1
  170. package/resources/entities/entities.js +67 -83
  171. package/resources/entities/entities.mjs +43 -42
  172. package/resources/entities/index.d.ts +4 -22
  173. package/resources/entities/index.js +12 -42
  174. package/resources/entities/index.mjs +4 -4
  175. package/resources/entities/supplemental-documents.d.ts +38 -44
  176. package/resources/entities/supplemental-documents.js +24 -24
  177. package/resources/entities/supplemental-documents.mjs +20 -18
  178. package/resources/event-subscriptions.d.ts +242 -355
  179. package/resources/event-subscriptions.js +33 -33
  180. package/resources/event-subscriptions.mjs +28 -26
  181. package/resources/events.d.ts +150 -254
  182. package/resources/events.js +21 -19
  183. package/resources/events.mjs +16 -14
  184. package/resources/exports.d.ts +210 -158
  185. package/resources/exports.d.ts.map +1 -1
  186. package/resources/exports.js +27 -25
  187. package/resources/exports.js.map +1 -1
  188. package/resources/exports.mjs +22 -20
  189. package/resources/exports.mjs.map +1 -1
  190. package/resources/external-accounts.d.ts +122 -128
  191. package/resources/external-accounts.js +33 -33
  192. package/resources/external-accounts.mjs +28 -26
  193. package/resources/files.d.ts +149 -196
  194. package/resources/files.js +30 -28
  195. package/resources/files.mjs +24 -22
  196. package/resources/groups.d.ts +35 -35
  197. package/resources/groups.js +12 -11
  198. package/resources/groups.mjs +9 -8
  199. package/resources/inbound-ach-transfers.d.ts +265 -305
  200. package/resources/inbound-ach-transfers.js +42 -42
  201. package/resources/inbound-ach-transfers.mjs +37 -35
  202. package/resources/inbound-wire-drawdown-requests.d.ts +113 -119
  203. package/resources/inbound-wire-drawdown-requests.js +24 -25
  204. package/resources/inbound-wire-drawdown-requests.mjs +19 -19
  205. package/resources/index.d.ts +39 -205
  206. package/resources/index.js +114 -540
  207. package/resources/index.mjs +39 -42
  208. package/resources/oauth-connections.d.ts +43 -44
  209. package/resources/oauth-connections.js +21 -21
  210. package/resources/oauth-connections.mjs +16 -14
  211. package/resources/pending-transactions.d.ts +560 -597
  212. package/resources/pending-transactions.d.ts.map +1 -1
  213. package/resources/pending-transactions.js +21 -21
  214. package/resources/pending-transactions.js.map +1 -1
  215. package/resources/pending-transactions.mjs +16 -14
  216. package/resources/pending-transactions.mjs.map +1 -1
  217. package/resources/programs.d.ts +41 -39
  218. package/resources/programs.js +21 -19
  219. package/resources/programs.mjs +16 -14
  220. package/resources/real-time-decisions.d.ts +384 -411
  221. package/resources/real-time-decisions.js +18 -19
  222. package/resources/real-time-decisions.mjs +15 -14
  223. package/resources/real-time-payments-transfers.d.ts +304 -342
  224. package/resources/real-time-payments-transfers.js +30 -30
  225. package/resources/real-time-payments-transfers.mjs +25 -23
  226. package/resources/routing-numbers.d.ts +52 -54
  227. package/resources/routing-numbers.js +18 -16
  228. package/resources/routing-numbers.mjs +14 -12
  229. package/resources/simulations/account-statements.d.ts +12 -15
  230. package/resources/simulations/account-statements.js +13 -14
  231. package/resources/simulations/account-statements.mjs +10 -9
  232. package/resources/simulations/account-transfers.d.ts +8 -11
  233. package/resources/simulations/account-transfers.js +13 -13
  234. package/resources/simulations/account-transfers.mjs +10 -10
  235. package/resources/simulations/ach-transfers.d.ts +3612 -3835
  236. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  237. package/resources/simulations/ach-transfers.js +40 -35
  238. package/resources/simulations/ach-transfers.js.map +1 -1
  239. package/resources/simulations/ach-transfers.mjs +37 -32
  240. package/resources/simulations/ach-transfers.mjs.map +1 -1
  241. package/resources/simulations/card-disputes.d.ts +22 -26
  242. package/resources/simulations/card-disputes.js +15 -14
  243. package/resources/simulations/card-disputes.mjs +12 -11
  244. package/resources/simulations/card-profiles.d.ts +9 -9
  245. package/resources/simulations/card-profiles.js +14 -14
  246. package/resources/simulations/card-profiles.mjs +11 -11
  247. package/resources/simulations/card-refunds.d.ts +13 -16
  248. package/resources/simulations/card-refunds.js +13 -12
  249. package/resources/simulations/card-refunds.mjs +10 -9
  250. package/resources/simulations/cards.d.ts +1307 -1437
  251. package/resources/simulations/cards.d.ts.map +1 -1
  252. package/resources/simulations/cards.js +28 -27
  253. package/resources/simulations/cards.js.map +1 -1
  254. package/resources/simulations/cards.mjs +25 -24
  255. package/resources/simulations/cards.mjs.map +1 -1
  256. package/resources/simulations/check-deposits.d.ts +17 -17
  257. package/resources/simulations/check-deposits.js +26 -26
  258. package/resources/simulations/check-deposits.mjs +23 -23
  259. package/resources/simulations/check-transfers.d.ts +12 -18
  260. package/resources/simulations/check-transfers.js +19 -19
  261. package/resources/simulations/check-transfers.mjs +16 -16
  262. package/resources/simulations/digital-wallet-token-requests.d.ts +35 -43
  263. package/resources/simulations/digital-wallet-token-requests.js +13 -15
  264. package/resources/simulations/digital-wallet-token-requests.mjs +10 -9
  265. package/resources/simulations/documents.d.ts +11 -11
  266. package/resources/simulations/documents.js +12 -11
  267. package/resources/simulations/documents.mjs +9 -8
  268. package/resources/simulations/inbound-funds-holds.d.ts +63 -66
  269. package/resources/simulations/inbound-funds-holds.js +13 -14
  270. package/resources/simulations/inbound-funds-holds.mjs +10 -9
  271. package/resources/simulations/inbound-wire-drawdown-requests.d.ts +94 -97
  272. package/resources/simulations/inbound-wire-drawdown-requests.js +13 -15
  273. package/resources/simulations/inbound-wire-drawdown-requests.mjs +10 -11
  274. package/resources/simulations/index.d.ts +19 -40
  275. package/resources/simulations/index.js +40 -148
  276. package/resources/simulations/index.mjs +19 -19
  277. package/resources/simulations/interest-payments.d.ts +2482 -2743
  278. package/resources/simulations/interest-payments.d.ts.map +1 -1
  279. package/resources/simulations/interest-payments.js +13 -14
  280. package/resources/simulations/interest-payments.js.map +1 -1
  281. package/resources/simulations/interest-payments.mjs +10 -9
  282. package/resources/simulations/interest-payments.mjs.map +1 -1
  283. package/resources/simulations/programs.d.ts +13 -13
  284. package/resources/simulations/programs.js +14 -13
  285. package/resources/simulations/programs.mjs +11 -10
  286. package/resources/simulations/real-time-payments-transfers.d.ts +3342 -3727
  287. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  288. package/resources/simulations/real-time-payments-transfers.js +24 -25
  289. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  290. package/resources/simulations/real-time-payments-transfers.mjs +21 -20
  291. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  292. package/resources/simulations/simulations.d.ts +75 -75
  293. package/resources/simulations/simulations.js +78 -101
  294. package/resources/simulations/simulations.mjs +56 -56
  295. package/resources/simulations/wire-transfers.d.ts +2540 -2801
  296. package/resources/simulations/wire-transfers.d.ts.map +1 -1
  297. package/resources/simulations/wire-transfers.js +12 -11
  298. package/resources/simulations/wire-transfers.js.map +1 -1
  299. package/resources/simulations/wire-transfers.mjs +9 -8
  300. package/resources/simulations/wire-transfers.mjs.map +1 -1
  301. package/resources/transactions.d.ts +2539 -2830
  302. package/resources/transactions.d.ts.map +1 -1
  303. package/resources/transactions.js +21 -19
  304. package/resources/transactions.js.map +1 -1
  305. package/resources/transactions.mjs +16 -14
  306. package/resources/transactions.mjs.map +1 -1
  307. package/resources/wire-drawdown-requests.d.ts +140 -147
  308. package/resources/wire-drawdown-requests.js +27 -27
  309. package/resources/wire-drawdown-requests.mjs +22 -20
  310. package/resources/wire-transfers.d.ts +315 -324
  311. package/resources/wire-transfers.js +56 -54
  312. package/resources/wire-transfers.mjs +51 -49
  313. package/shims/node.d.ts +29 -0
  314. package/shims/node.d.ts.map +1 -0
  315. package/shims/node.js +31 -0
  316. package/shims/node.js.map +1 -0
  317. package/shims/node.mjs +5 -0
  318. package/shims/node.mjs.map +1 -0
  319. package/shims/web.d.ts +26 -0
  320. package/shims/web.d.ts.map +1 -0
  321. package/shims/web.js +31 -0
  322. package/shims/web.js.map +1 -0
  323. package/shims/web.mjs +5 -0
  324. package/shims/web.mjs.map +1 -0
  325. package/src/_shims/MultipartBody.ts +9 -0
  326. package/src/_shims/README.md +46 -0
  327. package/src/_shims/auto/runtime-bun.ts +4 -0
  328. package/src/_shims/auto/runtime-node.ts +4 -0
  329. package/src/_shims/auto/runtime.ts +4 -0
  330. package/src/_shims/auto/types-node.ts +4 -0
  331. package/src/_shims/auto/types.d.ts +99 -0
  332. package/src/_shims/auto/types.js +3 -0
  333. package/src/_shims/auto/types.mjs +3 -0
  334. package/src/_shims/bun-runtime.ts +14 -0
  335. package/src/_shims/index.d.ts +79 -0
  336. package/src/_shims/index.js +13 -0
  337. package/src/_shims/index.mjs +7 -0
  338. package/src/_shims/manual-types.d.ts +12 -0
  339. package/src/_shims/manual-types.js +3 -0
  340. package/src/_shims/manual-types.mjs +3 -0
  341. package/src/_shims/node-runtime.ts +79 -0
  342. package/src/_shims/node-types.d.ts +42 -0
  343. package/src/_shims/node-types.js +3 -0
  344. package/src/_shims/node-types.mjs +3 -0
  345. package/src/_shims/registry.ts +64 -0
  346. package/src/_shims/web-runtime.ts +91 -0
  347. package/src/_shims/web-types.d.ts +82 -0
  348. package/src/_shims/web-types.js +3 -0
  349. package/src/_shims/web-types.mjs +3 -0
  350. package/src/core.ts +37 -17
  351. package/src/error.ts +3 -3
  352. package/src/index.ts +6 -6
  353. package/src/pagination.ts +1 -1
  354. package/src/resource.ts +1 -1
  355. package/src/resources/account-numbers.ts +5 -5
  356. package/src/resources/account-statements.ts +5 -5
  357. package/src/resources/account-transfers.ts +5 -5
  358. package/src/resources/accounts.ts +5 -5
  359. package/src/resources/ach-prenotifications.ts +45 -16
  360. package/src/resources/ach-transfers.ts +47 -17
  361. package/src/resources/balance-lookups.ts +3 -3
  362. package/src/resources/bookkeeping-accounts.ts +5 -5
  363. package/src/resources/bookkeeping-entries.ts +5 -5
  364. package/src/resources/bookkeeping-entry-sets.ts +3 -3
  365. package/src/resources/card-disputes.ts +5 -5
  366. package/src/resources/card-profiles.ts +5 -5
  367. package/src/resources/card-purchase-supplements.ts +5 -5
  368. package/src/resources/cards.ts +15 -5
  369. package/src/resources/check-deposits.ts +5 -5
  370. package/src/resources/check-transfers.ts +5 -5
  371. package/src/resources/declined-transactions.ts +15 -5
  372. package/src/resources/digital-wallet-tokens.ts +5 -5
  373. package/src/resources/documents.ts +5 -5
  374. package/src/resources/entities/beneficial-owners.ts +5 -5
  375. package/src/resources/entities/entities.ts +18 -18
  376. package/src/resources/entities/index.ts +3 -3
  377. package/src/resources/entities/supplemental-documents.ts +5 -5
  378. package/src/resources/event-subscriptions.ts +5 -5
  379. package/src/resources/events.ts +5 -5
  380. package/src/resources/exports.ts +64 -7
  381. package/src/resources/external-accounts.ts +5 -5
  382. package/src/resources/files.ts +6 -6
  383. package/src/resources/groups.ts +3 -3
  384. package/src/resources/inbound-ach-transfers.ts +5 -5
  385. package/src/resources/inbound-wire-drawdown-requests.ts +5 -5
  386. package/src/resources/index.ts +38 -38
  387. package/src/resources/oauth-connections.ts +5 -5
  388. package/src/resources/pending-transactions.ts +10 -5
  389. package/src/resources/programs.ts +5 -5
  390. package/src/resources/real-time-decisions.ts +3 -3
  391. package/src/resources/real-time-payments-transfers.ts +5 -5
  392. package/src/resources/routing-numbers.ts +4 -4
  393. package/src/resources/simulations/account-statements.ts +4 -4
  394. package/src/resources/simulations/account-transfers.ts +3 -3
  395. package/src/resources/simulations/ach-transfers.ts +318 -30
  396. package/src/resources/simulations/card-disputes.ts +4 -4
  397. package/src/resources/simulations/card-profiles.ts +3 -3
  398. package/src/resources/simulations/card-refunds.ts +4 -4
  399. package/src/resources/simulations/cards.ts +19 -4
  400. package/src/resources/simulations/check-deposits.ts +3 -3
  401. package/src/resources/simulations/check-transfers.ts +3 -3
  402. package/src/resources/simulations/digital-wallet-token-requests.ts +3 -3
  403. package/src/resources/simulations/documents.ts +4 -4
  404. package/src/resources/simulations/inbound-funds-holds.ts +3 -3
  405. package/src/resources/simulations/inbound-wire-drawdown-requests.ts +4 -4
  406. package/src/resources/simulations/index.ts +18 -18
  407. package/src/resources/simulations/interest-payments.ts +29 -15
  408. package/src/resources/simulations/programs.ts +4 -4
  409. package/src/resources/simulations/real-time-payments-transfers.ts +40 -16
  410. package/src/resources/simulations/simulations.ts +19 -19
  411. package/src/resources/simulations/wire-transfers.ts +29 -15
  412. package/src/resources/transactions.ts +31 -17
  413. package/src/resources/wire-drawdown-requests.ts +5 -5
  414. package/src/resources/wire-transfers.ts +5 -5
  415. package/src/shims/node.ts +50 -0
  416. package/src/shims/web.ts +50 -0
  417. package/src/uploads.ts +12 -16
  418. package/src/version.ts +1 -1
  419. package/uploads.d.ts +23 -39
  420. package/uploads.d.ts.map +1 -1
  421. package/uploads.js +115 -157
  422. package/uploads.js.map +1 -1
  423. package/uploads.mjs +111 -133
  424. package/uploads.mjs.map +1 -1
  425. package/version.d.ts +2 -2
  426. package/version.js +4 -4
  427. package/version.mjs +2 -2
  428. package/_shims/ReadableStream-node.d.ts +0 -6
  429. package/_shims/ReadableStream-node.d.ts.map +0 -1
  430. package/_shims/ReadableStream-node.js +0 -14
  431. package/_shims/ReadableStream-node.js.map +0 -1
  432. package/_shims/ReadableStream-node.mjs +0 -3
  433. package/_shims/ReadableStream-node.mjs.map +0 -1
  434. package/_shims/ReadableStream.d.ts +0 -38
  435. package/_shims/ReadableStream.mjs +0 -7
  436. package/_shims/agent-node.d.ts +0 -7
  437. package/_shims/agent-node.d.ts.map +0 -1
  438. package/_shims/agent-node.js +0 -28
  439. package/_shims/agent-node.js.map +0 -1
  440. package/_shims/agent-node.mjs +0 -16
  441. package/_shims/agent-node.mjs.map +0 -1
  442. package/_shims/agent.d.ts +0 -9
  443. package/_shims/agent.d.ts.map +0 -1
  444. package/_shims/agent.js +0 -14
  445. package/_shims/agent.js.map +0 -1
  446. package/_shims/agent.mjs +0 -10
  447. package/_shims/agent.mjs.map +0 -1
  448. package/_shims/fetch-node.d.ts +0 -64
  449. package/_shims/fetch-node.js +0 -12
  450. package/_shims/fetch-node.mjs +0 -14
  451. package/_shims/fetch.d.ts +0 -60
  452. package/_shims/fetch.js +0 -13
  453. package/_shims/fetch.mjs +0 -15
  454. package/_shims/fileFromPath-node.d.ts +0 -17
  455. package/_shims/fileFromPath-node.d.ts.map +0 -1
  456. package/_shims/fileFromPath-node.js +0 -17
  457. package/_shims/fileFromPath-node.js.map +0 -1
  458. package/_shims/fileFromPath-node.mjs +0 -13
  459. package/_shims/fileFromPath-node.mjs.map +0 -1
  460. package/_shims/fileFromPath.d.ts +0 -22
  461. package/_shims/fileFromPath.d.ts.map +0 -1
  462. package/_shims/fileFromPath.js +0 -16
  463. package/_shims/fileFromPath.js.map +0 -1
  464. package/_shims/fileFromPath.mjs +0 -12
  465. package/_shims/fileFromPath.mjs.map +0 -1
  466. package/_shims/form-data-node.d.ts +0 -45
  467. package/_shims/form-data-node.js +0 -11
  468. package/_shims/form-data-node.mjs +0 -9
  469. package/_shims/form-data.d.ts +0 -43
  470. package/_shims/form-data.js +0 -17
  471. package/_shims/form-data.mjs +0 -20
  472. package/_shims/getMultipartRequestOptions-node.d.ts +0 -10
  473. package/_shims/getMultipartRequestOptions-node.d.ts.map +0 -1
  474. package/_shims/getMultipartRequestOptions-node.js +0 -22
  475. package/_shims/getMultipartRequestOptions-node.js.map +0 -1
  476. package/_shims/getMultipartRequestOptions-node.mjs +0 -18
  477. package/_shims/getMultipartRequestOptions-node.mjs.map +0 -1
  478. package/_shims/getMultipartRequestOptions.d.ts +0 -10
  479. package/_shims/getMultipartRequestOptions.d.ts.map +0 -1
  480. package/_shims/getMultipartRequestOptions.js +0 -12
  481. package/_shims/getMultipartRequestOptions.js.map +0 -1
  482. package/_shims/getMultipartRequestOptions.mjs +0 -8
  483. package/_shims/getMultipartRequestOptions.mjs.map +0 -1
  484. package/_shims/node-readable-node.d.ts +0 -8
  485. package/_shims/node-readable-node.d.ts.map +0 -1
  486. package/_shims/node-readable-node.js +0 -9
  487. package/_shims/node-readable-node.js.map +0 -1
  488. package/_shims/node-readable-node.mjs +0 -5
  489. package/_shims/node-readable-node.mjs.map +0 -1
  490. package/_shims/node-readable.d.ts +0 -23
  491. package/_shims/node-readable.d.ts.map +0 -1
  492. package/_shims/node-readable.js +0 -11
  493. package/_shims/node-readable.js.map +0 -1
  494. package/_shims/node-readable.mjs +0 -7
  495. package/_shims/node-readable.mjs.map +0 -1
  496. package/src/_shims/ReadableStream.d.ts +0 -38
  497. package/src/_shims/ReadableStream.mjs +0 -7
  498. package/src/_shims/agent-node.ts +0 -22
  499. package/src/_shims/agent.ts +0 -12
  500. package/src/_shims/fetch-node.d.ts +0 -64
  501. package/src/_shims/fetch-node.js +0 -12
  502. package/src/_shims/fetch-node.mjs +0 -14
  503. package/src/_shims/fetch.d.ts +0 -60
  504. package/src/_shims/fetch.js +0 -13
  505. package/src/_shims/fetch.mjs +0 -15
  506. package/src/_shims/fileFromPath-node.ts +0 -29
  507. package/src/_shims/fileFromPath.ts +0 -29
  508. package/src/_shims/form-data-node.d.ts +0 -45
  509. package/src/_shims/form-data-node.js +0 -11
  510. package/src/_shims/form-data-node.mjs +0 -9
  511. package/src/_shims/form-data.d.ts +0 -43
  512. package/src/_shims/form-data.js +0 -17
  513. package/src/_shims/form-data.mjs +0 -20
  514. package/src/_shims/getMultipartRequestOptions-node.ts +0 -25
  515. package/src/_shims/getMultipartRequestOptions.ts +0 -14
  516. package/src/_shims/node-readable-node.ts +0 -10
  517. package/src/_shims/node-readable.ts +0 -30
@@ -1,293 +1,78 @@
1
1
  import * as Core from 'increase/core';
2
2
  import { APIResource } from 'increase/resource';
3
3
  import * as Transactions from 'increase/resources/transactions';
4
- import * as API from './index.js';
4
+ import * as API from "./index.js";
5
5
  export declare class Cards extends APIResource {
6
- /**
7
- * Simulates a purchase authorization on a [Card](#cards). Depending on the balance
8
- * available to the card and the `amount` submitted, the authorization activity
9
- * will result in a [Pending Transaction](#pending-transactions) of type
10
- * `card_authorization` or a [Declined Transaction](#declined-transactions) of type
11
- * `card_decline`. You can pass either a Card id or a
12
- * [Digital Wallet Token](#digital-wallet-tokens) id to simulate the two different
13
- * ways purchases can be made.
14
- */
15
- authorize(
16
- body: CardAuthorizeParams,
17
- options?: Core.RequestOptions,
18
- ): Core.APIPromise<CardAuthorizationSimulation>;
19
- /**
20
- * Simulates the settlement of an authorization by a card acquirer. After a card
21
- * authorization is created, the merchant will eventually send a settlement. This
22
- * simulates that event, which may occur many days after the purchase in
23
- * production. The amount settled can be different from the amount originally
24
- * authorized, for example, when adding a tip to a restaurant bill.
25
- */
26
- settlement(
27
- body: CardSettlementParams,
28
- options?: Core.RequestOptions,
29
- ): Core.APIPromise<Transactions.Transaction>;
6
+ /**
7
+ * Simulates a purchase authorization on a [Card](#cards). Depending on the balance
8
+ * available to the card and the `amount` submitted, the authorization activity
9
+ * will result in a [Pending Transaction](#pending-transactions) of type
10
+ * `card_authorization` or a [Declined Transaction](#declined-transactions) of type
11
+ * `card_decline`. You can pass either a Card id or a
12
+ * [Digital Wallet Token](#digital-wallet-tokens) id to simulate the two different
13
+ * ways purchases can be made.
14
+ */
15
+ authorize(body: CardAuthorizeParams, options?: Core.RequestOptions): Core.APIPromise<CardAuthorizationSimulation>;
16
+ /**
17
+ * Simulates the settlement of an authorization by a card acquirer. After a card
18
+ * authorization is created, the merchant will eventually send a settlement. This
19
+ * simulates that event, which may occur many days after the purchase in
20
+ * production. The amount settled can be different from the amount originally
21
+ * authorized, for example, when adding a tip to a restaurant bill.
22
+ */
23
+ settlement(body: CardSettlementParams, options?: Core.RequestOptions): Core.APIPromise<Transactions.Transaction>;
30
24
  }
31
25
  /**
32
26
  * The results of a Card Authorization simulation.
33
27
  */
34
28
  export interface CardAuthorizationSimulation {
35
- /**
36
- * If the authorization attempt fails, this will contain the resulting
37
- * [Declined Transaction](#declined-transactions) object. The Declined
38
- * Transaction's `source` will be of `category: card_decline`.
39
- */
40
- declined_transaction: CardAuthorizationSimulation.DeclinedTransaction | null;
41
- /**
42
- * If the authorization attempt succeeds, this will contain the resulting Pending
43
- * Transaction object. The Pending Transaction's `source` will be of
44
- * `category: card_authorization`.
45
- */
46
- pending_transaction: CardAuthorizationSimulation.PendingTransaction | null;
47
- /**
48
- * A constant representing the object's type. For this resource it will always be
49
- * `inbound_card_authorization_simulation_result`.
50
- */
51
- type: 'inbound_card_authorization_simulation_result';
52
- }
53
- export declare namespace CardAuthorizationSimulation {
54
- /**
55
- * If the authorization attempt fails, this will contain the resulting
56
- * [Declined Transaction](#declined-transactions) object. The Declined
57
- * Transaction's `source` will be of `category: card_decline`.
58
- */
59
- interface DeclinedTransaction {
60
- /**
61
- * The Declined Transaction identifier.
62
- */
63
- id: string;
64
- /**
65
- * The identifier for the Account the Declined Transaction belongs to.
66
- */
67
- account_id: string;
68
- /**
69
- * The Declined Transaction amount in the minor unit of its currency. For dollars,
70
- * for example, this is cents.
71
- */
72
- amount: number;
73
- /**
74
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
75
- * Transaction occurred.
76
- */
77
- created_at: string;
78
- /**
79
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
80
- * Transaction's currency. This will match the currency on the Declined
81
- * Transaction's Account.
82
- *
83
- * - `CAD` - Canadian Dollar (CAD)
84
- * - `CHF` - Swiss Franc (CHF)
85
- * - `EUR` - Euro (EUR)
86
- * - `GBP` - British Pound (GBP)
87
- * - `JPY` - Japanese Yen (JPY)
88
- * - `USD` - US Dollar (USD)
89
- */
90
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
91
- /**
92
- * This is the description the vendor provides.
93
- */
94
- description: string;
95
- /**
96
- * The identifier for the route this Declined Transaction came through. Routes are
97
- * things like cards and ACH details.
98
- */
99
- route_id: string | null;
100
29
  /**
101
- * The type of the route this Declined Transaction came through.
102
- *
103
- * - `account_number` - An Account Number.
104
- * - `card` - A Card.
30
+ * If the authorization attempt fails, this will contain the resulting
31
+ * [Declined Transaction](#declined-transactions) object. The Declined
32
+ * Transaction's `source` will be of `category: card_decline`.
105
33
  */
106
- route_type: 'account_number' | 'card' | null;
34
+ declined_transaction: CardAuthorizationSimulation.DeclinedTransaction | null;
107
35
  /**
108
- * This is an object giving more details on the network-level event that caused the
109
- * Declined Transaction. For example, for a card transaction this lists the
110
- * merchant's industry and location. Note that for backwards compatibility reasons,
111
- * additional undocumented keys may appear in this object. These should be treated
112
- * as deprecated and will be removed in the future.
36
+ * If the authorization attempt succeeds, this will contain the resulting Pending
37
+ * Transaction object. The Pending Transaction's `source` will be of
38
+ * `category: card_authorization`.
113
39
  */
114
- source: DeclinedTransaction.Source;
40
+ pending_transaction: CardAuthorizationSimulation.PendingTransaction | null;
115
41
  /**
116
42
  * A constant representing the object's type. For this resource it will always be
117
- * `declined_transaction`.
43
+ * `inbound_card_authorization_simulation_result`.
118
44
  */
119
- type: 'declined_transaction';
120
- }
121
- namespace DeclinedTransaction {
45
+ type: 'inbound_card_authorization_simulation_result';
46
+ }
47
+ export declare namespace CardAuthorizationSimulation {
122
48
  /**
123
- * This is an object giving more details on the network-level event that caused the
124
- * Declined Transaction. For example, for a card transaction this lists the
125
- * merchant's industry and location. Note that for backwards compatibility reasons,
126
- * additional undocumented keys may appear in this object. These should be treated
127
- * as deprecated and will be removed in the future.
49
+ * If the authorization attempt fails, this will contain the resulting
50
+ * [Declined Transaction](#declined-transactions) object. The Declined
51
+ * Transaction's `source` will be of `category: card_decline`.
128
52
  */
129
- interface Source {
130
- /**
131
- * An ACH Decline object. This field will be present in the JSON response if and
132
- * only if `category` is equal to `ach_decline`.
133
- */
134
- ach_decline: Source.ACHDecline | null;
135
- /**
136
- * A Card Decline object. This field will be present in the JSON response if and
137
- * only if `category` is equal to `card_decline`.
138
- */
139
- card_decline: Source.CardDecline | null;
140
- /**
141
- * The type of the resource. We may add additional possible values for this enum
142
- * over time; your application should be able to handle such additions gracefully.
143
- *
144
- * - `ach_decline` - ACH Decline: details will be under the `ach_decline` object.
145
- * - `card_decline` - Card Decline: details will be under the `card_decline`
146
- * object.
147
- * - `check_decline` - Check Decline: details will be under the `check_decline`
148
- * object.
149
- * - `inbound_real_time_payments_transfer_decline` - Inbound Real-Time Payments
150
- * Transfer Decline: details will be under the
151
- * `inbound_real_time_payments_transfer_decline` object.
152
- * - `international_ach_decline` - International ACH Decline: details will be under
153
- * the `international_ach_decline` object.
154
- * - `wire_decline` - Wire Decline: details will be under the `wire_decline`
155
- * object.
156
- * - `other` - The Declined Transaction was made for an undocumented or deprecated
157
- * reason.
158
- */
159
- category:
160
- | 'ach_decline'
161
- | 'card_decline'
162
- | 'check_decline'
163
- | 'inbound_real_time_payments_transfer_decline'
164
- | 'international_ach_decline'
165
- | 'wire_decline'
166
- | 'other';
167
- /**
168
- * A Check Decline object. This field will be present in the JSON response if and
169
- * only if `category` is equal to `check_decline`.
170
- */
171
- check_decline: Source.CheckDecline | null;
172
- /**
173
- * An Inbound Real-Time Payments Transfer Decline object. This field will be
174
- * present in the JSON response if and only if `category` is equal to
175
- * `inbound_real_time_payments_transfer_decline`.
176
- */
177
- inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
178
- /**
179
- * An International ACH Decline object. This field will be present in the JSON
180
- * response if and only if `category` is equal to `international_ach_decline`.
181
- */
182
- international_ach_decline: Source.InternationalACHDecline | null;
183
- /**
184
- * A Wire Decline object. This field will be present in the JSON response if and
185
- * only if `category` is equal to `wire_decline`.
186
- */
187
- wire_decline: Source.WireDecline | null;
188
- }
189
- namespace Source {
190
- /**
191
- * An ACH Decline object. This field will be present in the JSON response if and
192
- * only if `category` is equal to `ach_decline`.
193
- */
194
- interface ACHDecline {
53
+ interface DeclinedTransaction {
195
54
  /**
196
- * The ACH Decline's identifier.
55
+ * The Declined Transaction identifier.
197
56
  */
198
57
  id: string;
199
58
  /**
200
- * The declined amount in the minor unit of the destination account currency. For
201
- * dollars, for example, this is cents.
59
+ * The identifier for the Account the Declined Transaction belongs to.
202
60
  */
203
- amount: number;
61
+ account_id: string;
204
62
  /**
205
- * The descriptive date of the transfer.
206
- */
207
- originator_company_descriptive_date: string | null;
208
- /**
209
- * The additional information included with the transfer.
210
- */
211
- originator_company_discretionary_data: string | null;
212
- /**
213
- * The identifier of the company that initiated the transfer.
214
- */
215
- originator_company_id: string;
216
- /**
217
- * The name of the company that initiated the transfer.
218
- */
219
- originator_company_name: string;
220
- /**
221
- * Why the ACH transfer was declined.
222
- *
223
- * - `ach_route_canceled` - The account number is canceled.
224
- * - `ach_route_disabled` - The account number is disabled.
225
- * - `breaches_limit` - The transaction would cause an Increase limit to be
226
- * exceeded.
227
- * - `credit_entry_refused_by_receiver` - A credit was refused. This is a
228
- * reasonable default reason for decline of credits.
229
- * - `duplicate_return` - A rare return reason. The return this message refers to
230
- * was a duplicate.
231
- * - `entity_not_active` - The account's entity is not active.
232
- * - `group_locked` - Your account is inactive.
233
- * - `insufficient_funds` - Your account contains insufficient funds.
234
- * - `misrouted_return` - A rare return reason. The return this message refers to
235
- * was misrouted.
236
- * - `return_of_erroneous_or_reversing_debit` - The originating financial
237
- * institution made a mistake and this return corrects it.
238
- * - `no_ach_route` - The account number that was debited does not exist.
239
- * - `originator_request` - The originating financial institution asked for this
240
- * transfer to be returned.
241
- * - `transaction_not_allowed` - The transaction is not allowed per Increase's
242
- * terms.
243
- * - `user_initiated` - The user initiated the decline.
244
- */
245
- reason:
246
- | 'ach_route_canceled'
247
- | 'ach_route_disabled'
248
- | 'breaches_limit'
249
- | 'credit_entry_refused_by_receiver'
250
- | 'duplicate_return'
251
- | 'entity_not_active'
252
- | 'group_locked'
253
- | 'insufficient_funds'
254
- | 'misrouted_return'
255
- | 'return_of_erroneous_or_reversing_debit'
256
- | 'no_ach_route'
257
- | 'originator_request'
258
- | 'transaction_not_allowed'
259
- | 'user_initiated';
260
- /**
261
- * The id of the receiver of the transfer.
262
- */
263
- receiver_id_number: string | null;
264
- /**
265
- * The name of the receiver of the transfer.
266
- */
267
- receiver_name: string | null;
268
- /**
269
- * The trace number of the transfer.
270
- */
271
- trace_number: string;
272
- /**
273
- * A constant representing the object's type. For this resource it will always be
274
- * `ach_decline`.
63
+ * The Declined Transaction amount in the minor unit of its currency. For dollars,
64
+ * for example, this is cents.
275
65
  */
276
- type: 'ach_decline';
277
- }
278
- /**
279
- * A Card Decline object. This field will be present in the JSON response if and
280
- * only if `category` is equal to `card_decline`.
281
- */
282
- interface CardDecline {
66
+ amount: number;
283
67
  /**
284
- * The declined amount in the minor unit of the destination account currency. For
285
- * dollars, for example, this is cents.
68
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
69
+ * Transaction occurred.
286
70
  */
287
- amount: number;
71
+ created_at: string;
288
72
  /**
289
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
290
- * account currency.
73
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
74
+ * Transaction's currency. This will match the currency on the Declined
75
+ * Transaction's Account.
291
76
  *
292
77
  * - `CAD` - Canadian Dollar (CAD)
293
78
  * - `CHF` - Swiss Franc (CHF)
@@ -298,254 +83,789 @@ export declare namespace CardAuthorizationSimulation {
298
83
  */
299
84
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
300
85
  /**
301
- * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
302
- * purchase), the identifier of the token that was used.
303
- */
304
- digital_wallet_token_id: string | null;
305
- /**
306
- * The merchant identifier (commonly abbreviated as MID) of the merchant the card
307
- * is transacting with.
308
- */
309
- merchant_acceptor_id: string;
310
- /**
311
- * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
312
- * card is transacting with.
313
- */
314
- merchant_category_code: string | null;
315
- /**
316
- * The city the merchant resides in.
317
- */
318
- merchant_city: string | null;
319
- /**
320
- * The country the merchant resides in.
86
+ * This is the description the vendor provides.
321
87
  */
322
- merchant_country: string | null;
323
- /**
324
- * The merchant descriptor of the merchant the card is transacting with.
325
- */
326
- merchant_descriptor: string;
327
- /**
328
- * The state the merchant resides in.
329
- */
330
- merchant_state: string | null;
88
+ description: string;
331
89
  /**
332
- * Fields specific to the `network`.
90
+ * The identifier for the route this Declined Transaction came through. Routes are
91
+ * things like cards and ACH details.
333
92
  */
334
- network_details: CardDecline.NetworkDetails;
93
+ route_id: string | null;
335
94
  /**
336
- * If the authorization was made in-person with a physical card, the Physical Card
337
- * that was used.
95
+ * The type of the route this Declined Transaction came through.
96
+ *
97
+ * - `account_number` - An Account Number.
98
+ * - `card` - A Card.
338
99
  */
339
- physical_card_id: string | null;
100
+ route_type: 'account_number' | 'card' | null;
340
101
  /**
341
- * The identifier of the Real-Time Decision sent to approve or decline this
342
- * transaction.
102
+ * This is an object giving more details on the network-level event that caused the
103
+ * Declined Transaction. For example, for a card transaction this lists the
104
+ * merchant's industry and location. Note that for backwards compatibility reasons,
105
+ * additional undocumented keys may appear in this object. These should be treated
106
+ * as deprecated and will be removed in the future.
343
107
  */
344
- real_time_decision_id: string | null;
108
+ source: DeclinedTransaction.Source;
345
109
  /**
346
- * Why the transaction was declined.
347
- *
348
- * - `card_not_active` - The Card was not active.
349
- * - `physical_card_not_active` - The Physical Card was not active.
350
- * - `entity_not_active` - The account's entity was not active.
351
- * - `group_locked` - The account was inactive.
352
- * - `insufficient_funds` - The Card's Account did not have a sufficient available
353
- * balance.
354
- * - `cvv2_mismatch` - The given CVV2 did not match the card's value.
355
- * - `transaction_not_allowed` - The attempted card transaction is not allowed per
356
- * Increase's terms.
357
- * - `breaches_limit` - The transaction was blocked by a Limit.
358
- * - `webhook_declined` - Your application declined the transaction via webhook.
359
- * - `webhook_timed_out` - Your application webhook did not respond without the
360
- * required timeout.
361
- * - `declined_by_stand_in_processing` - Declined by stand-in processing.
362
- * - `invalid_physical_card` - The card read had an invalid CVV, dCVV, or
363
- * authorization request cryptogram.
364
- * - `missing_original_authorization` - The original card authorization for this
365
- * incremental authorization does not exist.
366
- * - `suspected_fraud` - The transaction was suspected to be fraudulent. Please
367
- * reach out to support@increase.com for more information.
110
+ * A constant representing the object's type. For this resource it will always be
111
+ * `declined_transaction`.
368
112
  */
369
- reason:
370
- | 'card_not_active'
371
- | 'physical_card_not_active'
372
- | 'entity_not_active'
373
- | 'group_locked'
374
- | 'insufficient_funds'
375
- | 'cvv2_mismatch'
376
- | 'transaction_not_allowed'
377
- | 'breaches_limit'
378
- | 'webhook_declined'
379
- | 'webhook_timed_out'
380
- | 'declined_by_stand_in_processing'
381
- | 'invalid_physical_card'
382
- | 'missing_original_authorization'
383
- | 'suspected_fraud';
384
- }
385
- namespace CardDecline {
113
+ type: 'declined_transaction';
114
+ }
115
+ namespace DeclinedTransaction {
386
116
  /**
387
- * Fields specific to the `network`.
117
+ * This is an object giving more details on the network-level event that caused the
118
+ * Declined Transaction. For example, for a card transaction this lists the
119
+ * merchant's industry and location. Note that for backwards compatibility reasons,
120
+ * additional undocumented keys may appear in this object. These should be treated
121
+ * as deprecated and will be removed in the future.
388
122
  */
389
- interface NetworkDetails {
390
- /**
391
- * The payment network used to process this card authorization.
392
- *
393
- * - `visa` - Visa
394
- */
395
- category: 'visa';
396
- /**
397
- * Fields specific to the `visa` network.
398
- */
399
- visa: NetworkDetails.Visa | null;
400
- }
401
- namespace NetworkDetails {
402
- /**
403
- * Fields specific to the `visa` network.
404
- */
405
- interface Visa {
123
+ interface Source {
406
124
  /**
407
- * For electronic commerce transactions, this identifies the level of security used
408
- * in obtaining the customer's payment credential. For mail or telephone order
409
- * transactions, identifies the type of mail or telephone order.
410
- *
411
- * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
412
- * that the transaction is a mail/phone order purchase, not a recurring
413
- * transaction or installment payment. For domestic transactions in the US
414
- * region, this value may also indicate one bill payment transaction in the
415
- * card-present or card-absent environments.
416
- * - `recurring` - Recurring transaction: Payment indicator used to indicate a
417
- * recurring transaction that originates from an acquirer in the US region.
418
- * - `installment` - Installment payment: Payment indicator used to indicate one
419
- * purchase of goods or services that is billed to the account in multiple
420
- * charges over a period of time agreed upon by the cardholder and merchant from
421
- * transactions that originate from an acquirer in the US region.
422
- * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
423
- * indicate that the type of mail/telephone order is unknown.
424
- * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
425
- * indicate that the electronic commerce transaction has been authenticated using
426
- * e.g., 3-D Secure
427
- * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
428
- * Non-authenticated security transaction at a 3-D Secure-capable merchant, and
429
- * merchant attempted to authenticate the cardholder using 3-D Secure: Use to
430
- * identify an electronic commerce transaction where the merchant attempted to
431
- * authenticate the cardholder using 3-D Secure, but was unable to complete the
432
- * authentication because the issuer or cardholder does not participate in the
433
- * 3-D Secure program.
434
- * - `non_authenticated_security_transaction` - Non-authenticated security
435
- * transaction: Use to identify an electronic commerce transaction that uses data
436
- * encryption for security however , cardholder authentication is not performed
437
- * using 3-D Secure.
438
- * - `non_secure_transaction` - Non-secure transaction: Use to identify an
439
- * electronic commerce transaction that has no data protection.
125
+ * An ACH Decline object. This field will be present in the JSON response if and
126
+ * only if `category` is equal to `ach_decline`.
440
127
  */
441
- electronic_commerce_indicator:
442
- | 'mail_phone_order'
443
- | 'recurring'
444
- | 'installment'
445
- | 'unknown_mail_phone_order'
446
- | 'secure_electronic_commerce'
447
- | 'non_authenticated_security_transaction_at_3ds_capable_merchant'
448
- | 'non_authenticated_security_transaction'
449
- | 'non_secure_transaction'
450
- | null;
128
+ ach_decline: Source.ACHDecline | null;
451
129
  /**
452
- * The method used to enter the cardholder's primary account number and card
453
- * expiration date.
130
+ * A Card Decline object. This field will be present in the JSON response if and
131
+ * only if `category` is equal to `card_decline`.
132
+ */
133
+ card_decline: Source.CardDecline | null;
134
+ /**
135
+ * The type of the resource. We may add additional possible values for this enum
136
+ * over time; your application should be able to handle such additions gracefully.
454
137
  *
455
- * - `unknown` - Unknown
456
- * - `manual` - Manual key entry
457
- * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
458
- * value
459
- * - `optical_code` - Optical code
460
- * - `integrated_circuit_card` - Contact chip card
461
- * - `contactless` - Contactless read of chip card
462
- * - `credential_on_file` - Transaction initiated using a credential that has
463
- * previously been stored on file
464
- * - `magnetic_stripe` - Magnetic stripe read
465
- * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
466
- * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
467
- * verification value
138
+ * - `ach_decline` - ACH Decline: details will be under the `ach_decline` object.
139
+ * - `card_decline` - Card Decline: details will be under the `card_decline`
140
+ * object.
141
+ * - `check_decline` - Check Decline: details will be under the `check_decline`
142
+ * object.
143
+ * - `inbound_real_time_payments_transfer_decline` - Inbound Real-Time Payments
144
+ * Transfer Decline: details will be under the
145
+ * `inbound_real_time_payments_transfer_decline` object.
146
+ * - `international_ach_decline` - International ACH Decline: details will be under
147
+ * the `international_ach_decline` object.
148
+ * - `wire_decline` - Wire Decline: details will be under the `wire_decline`
149
+ * object.
150
+ * - `other` - The Declined Transaction was made for an undocumented or deprecated
151
+ * reason.
152
+ */
153
+ category: 'ach_decline' | 'card_decline' | 'check_decline' | 'inbound_real_time_payments_transfer_decline' | 'international_ach_decline' | 'wire_decline' | 'other';
154
+ /**
155
+ * A Check Decline object. This field will be present in the JSON response if and
156
+ * only if `category` is equal to `check_decline`.
157
+ */
158
+ check_decline: Source.CheckDecline | null;
159
+ /**
160
+ * An Inbound Real-Time Payments Transfer Decline object. This field will be
161
+ * present in the JSON response if and only if `category` is equal to
162
+ * `inbound_real_time_payments_transfer_decline`.
163
+ */
164
+ inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
165
+ /**
166
+ * An International ACH Decline object. This field will be present in the JSON
167
+ * response if and only if `category` is equal to `international_ach_decline`.
168
+ */
169
+ international_ach_decline: Source.InternationalACHDecline | null;
170
+ /**
171
+ * A Wire Decline object. This field will be present in the JSON response if and
172
+ * only if `category` is equal to `wire_decline`.
173
+ */
174
+ wire_decline: Source.WireDecline | null;
175
+ }
176
+ namespace Source {
177
+ /**
178
+ * An ACH Decline object. This field will be present in the JSON response if and
179
+ * only if `category` is equal to `ach_decline`.
180
+ */
181
+ interface ACHDecline {
182
+ /**
183
+ * The ACH Decline's identifier.
184
+ */
185
+ id: string;
186
+ /**
187
+ * The declined amount in the minor unit of the destination account currency. For
188
+ * dollars, for example, this is cents.
189
+ */
190
+ amount: number;
191
+ /**
192
+ * The descriptive date of the transfer.
193
+ */
194
+ originator_company_descriptive_date: string | null;
195
+ /**
196
+ * The additional information included with the transfer.
197
+ */
198
+ originator_company_discretionary_data: string | null;
199
+ /**
200
+ * The identifier of the company that initiated the transfer.
201
+ */
202
+ originator_company_id: string;
203
+ /**
204
+ * The name of the company that initiated the transfer.
205
+ */
206
+ originator_company_name: string;
207
+ /**
208
+ * Why the ACH transfer was declined.
209
+ *
210
+ * - `ach_route_canceled` - The account number is canceled.
211
+ * - `ach_route_disabled` - The account number is disabled.
212
+ * - `breaches_limit` - The transaction would cause an Increase limit to be
213
+ * exceeded.
214
+ * - `credit_entry_refused_by_receiver` - A credit was refused. This is a
215
+ * reasonable default reason for decline of credits.
216
+ * - `duplicate_return` - A rare return reason. The return this message refers to
217
+ * was a duplicate.
218
+ * - `entity_not_active` - The account's entity is not active.
219
+ * - `group_locked` - Your account is inactive.
220
+ * - `insufficient_funds` - Your account contains insufficient funds.
221
+ * - `misrouted_return` - A rare return reason. The return this message refers to
222
+ * was misrouted.
223
+ * - `return_of_erroneous_or_reversing_debit` - The originating financial
224
+ * institution made a mistake and this return corrects it.
225
+ * - `no_ach_route` - The account number that was debited does not exist.
226
+ * - `originator_request` - The originating financial institution asked for this
227
+ * transfer to be returned.
228
+ * - `transaction_not_allowed` - The transaction is not allowed per Increase's
229
+ * terms.
230
+ * - `user_initiated` - The user initiated the decline.
231
+ */
232
+ 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';
233
+ /**
234
+ * The id of the receiver of the transfer.
235
+ */
236
+ receiver_id_number: string | null;
237
+ /**
238
+ * The name of the receiver of the transfer.
239
+ */
240
+ receiver_name: string | null;
241
+ /**
242
+ * The trace number of the transfer.
243
+ */
244
+ trace_number: string;
245
+ /**
246
+ * A constant representing the object's type. For this resource it will always be
247
+ * `ach_decline`.
248
+ */
249
+ type: 'ach_decline';
250
+ }
251
+ /**
252
+ * A Card Decline object. This field will be present in the JSON response if and
253
+ * only if `category` is equal to `card_decline`.
254
+ */
255
+ interface CardDecline {
256
+ /**
257
+ * The Card Decline identifier.
258
+ */
259
+ id: string;
260
+ /**
261
+ * The declined amount in the minor unit of the destination account currency. For
262
+ * dollars, for example, this is cents.
263
+ */
264
+ amount: number;
265
+ /**
266
+ * The ID of the Card Payment this transaction belongs to.
267
+ */
268
+ card_payment_id: string | null;
269
+ /**
270
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
271
+ * account currency.
272
+ *
273
+ * - `CAD` - Canadian Dollar (CAD)
274
+ * - `CHF` - Swiss Franc (CHF)
275
+ * - `EUR` - Euro (EUR)
276
+ * - `GBP` - British Pound (GBP)
277
+ * - `JPY` - Japanese Yen (JPY)
278
+ * - `USD` - US Dollar (USD)
279
+ */
280
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
281
+ /**
282
+ * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
283
+ * purchase), the identifier of the token that was used.
284
+ */
285
+ digital_wallet_token_id: string | null;
286
+ /**
287
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
288
+ * is transacting with.
289
+ */
290
+ merchant_acceptor_id: string;
291
+ /**
292
+ * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
293
+ * card is transacting with.
294
+ */
295
+ merchant_category_code: string | null;
296
+ /**
297
+ * The city the merchant resides in.
298
+ */
299
+ merchant_city: string | null;
300
+ /**
301
+ * The country the merchant resides in.
302
+ */
303
+ merchant_country: string | null;
304
+ /**
305
+ * The merchant descriptor of the merchant the card is transacting with.
306
+ */
307
+ merchant_descriptor: string;
308
+ /**
309
+ * The state the merchant resides in.
310
+ */
311
+ merchant_state: string | null;
312
+ /**
313
+ * Fields specific to the `network`.
314
+ */
315
+ network_details: CardDecline.NetworkDetails;
316
+ /**
317
+ * If the authorization was made in-person with a physical card, the Physical Card
318
+ * that was used.
319
+ */
320
+ physical_card_id: string | null;
321
+ /**
322
+ * The identifier of the Real-Time Decision sent to approve or decline this
323
+ * transaction.
324
+ */
325
+ real_time_decision_id: string | null;
326
+ /**
327
+ * Why the transaction was declined.
328
+ *
329
+ * - `card_not_active` - The Card was not active.
330
+ * - `physical_card_not_active` - The Physical Card was not active.
331
+ * - `entity_not_active` - The account's entity was not active.
332
+ * - `group_locked` - The account was inactive.
333
+ * - `insufficient_funds` - The Card's Account did not have a sufficient available
334
+ * balance.
335
+ * - `cvv2_mismatch` - The given CVV2 did not match the card's value.
336
+ * - `transaction_not_allowed` - The attempted card transaction is not allowed per
337
+ * Increase's terms.
338
+ * - `breaches_limit` - The transaction was blocked by a Limit.
339
+ * - `webhook_declined` - Your application declined the transaction via webhook.
340
+ * - `webhook_timed_out` - Your application webhook did not respond without the
341
+ * required timeout.
342
+ * - `declined_by_stand_in_processing` - Declined by stand-in processing.
343
+ * - `invalid_physical_card` - The card read had an invalid CVV, dCVV, or
344
+ * authorization request cryptogram.
345
+ * - `missing_original_authorization` - The original card authorization for this
346
+ * incremental authorization does not exist.
347
+ * - `suspected_fraud` - The transaction was suspected to be fraudulent. Please
348
+ * reach out to support@increase.com for more information.
349
+ */
350
+ 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';
351
+ }
352
+ namespace CardDecline {
353
+ /**
354
+ * Fields specific to the `network`.
355
+ */
356
+ interface NetworkDetails {
357
+ /**
358
+ * The payment network used to process this card authorization.
359
+ *
360
+ * - `visa` - Visa
361
+ */
362
+ category: 'visa';
363
+ /**
364
+ * Fields specific to the `visa` network.
365
+ */
366
+ visa: NetworkDetails.Visa | null;
367
+ }
368
+ namespace NetworkDetails {
369
+ /**
370
+ * Fields specific to the `visa` network.
371
+ */
372
+ interface Visa {
373
+ /**
374
+ * For electronic commerce transactions, this identifies the level of security used
375
+ * in obtaining the customer's payment credential. For mail or telephone order
376
+ * transactions, identifies the type of mail or telephone order.
377
+ *
378
+ * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
379
+ * that the transaction is a mail/phone order purchase, not a recurring
380
+ * transaction or installment payment. For domestic transactions in the US
381
+ * region, this value may also indicate one bill payment transaction in the
382
+ * card-present or card-absent environments.
383
+ * - `recurring` - Recurring transaction: Payment indicator used to indicate a
384
+ * recurring transaction that originates from an acquirer in the US region.
385
+ * - `installment` - Installment payment: Payment indicator used to indicate one
386
+ * purchase of goods or services that is billed to the account in multiple
387
+ * charges over a period of time agreed upon by the cardholder and merchant from
388
+ * transactions that originate from an acquirer in the US region.
389
+ * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
390
+ * indicate that the type of mail/telephone order is unknown.
391
+ * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
392
+ * indicate that the electronic commerce transaction has been authenticated using
393
+ * e.g., 3-D Secure
394
+ * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
395
+ * Non-authenticated security transaction at a 3-D Secure-capable merchant, and
396
+ * merchant attempted to authenticate the cardholder using 3-D Secure: Use to
397
+ * identify an electronic commerce transaction where the merchant attempted to
398
+ * authenticate the cardholder using 3-D Secure, but was unable to complete the
399
+ * authentication because the issuer or cardholder does not participate in the
400
+ * 3-D Secure program.
401
+ * - `non_authenticated_security_transaction` - Non-authenticated security
402
+ * transaction: Use to identify an electronic commerce transaction that uses data
403
+ * encryption for security however , cardholder authentication is not performed
404
+ * using 3-D Secure.
405
+ * - `non_secure_transaction` - Non-secure transaction: Use to identify an
406
+ * electronic commerce transaction that has no data protection.
407
+ */
408
+ 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;
409
+ /**
410
+ * The method used to enter the cardholder's primary account number and card
411
+ * expiration date.
412
+ *
413
+ * - `unknown` - Unknown
414
+ * - `manual` - Manual key entry
415
+ * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
416
+ * value
417
+ * - `optical_code` - Optical code
418
+ * - `integrated_circuit_card` - Contact chip card
419
+ * - `contactless` - Contactless read of chip card
420
+ * - `credential_on_file` - Transaction initiated using a credential that has
421
+ * previously been stored on file
422
+ * - `magnetic_stripe` - Magnetic stripe read
423
+ * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
424
+ * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
425
+ * verification value
426
+ */
427
+ 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;
428
+ }
429
+ }
430
+ }
431
+ /**
432
+ * A Check Decline object. This field will be present in the JSON response if and
433
+ * only if `category` is equal to `check_decline`.
434
+ */
435
+ interface CheckDecline {
436
+ /**
437
+ * The declined amount in the minor unit of the destination account currency. For
438
+ * dollars, for example, this is cents.
439
+ */
440
+ amount: number;
441
+ /**
442
+ * A computer-readable number printed on the MICR line of business checks, usually
443
+ * the check number. This is useful for positive pay checks, but can be unreliably
444
+ * transmitted by the bank of first deposit.
445
+ */
446
+ auxiliary_on_us: string | null;
447
+ /**
448
+ * Why the check was declined.
449
+ *
450
+ * - `ach_route_disabled` - The account number is disabled.
451
+ * - `ach_route_canceled` - The account number is canceled.
452
+ * - `breaches_limit` - The transaction would cause a limit to be exceeded.
453
+ * - `entity_not_active` - The account's entity is not active.
454
+ * - `group_locked` - Your account is inactive.
455
+ * - `insufficient_funds` - Your account contains insufficient funds.
456
+ * - `stop_payment_requested` - Stop payment requested for this check.
457
+ * - `duplicate_presentment` - The check was a duplicate deposit.
458
+ * - `not_authorized` - The check was not authorized.
459
+ * - `amount_mismatch` - The amount the receiving bank is attempting to deposit
460
+ * does not match the amount on the check.
461
+ * - `not_our_item` - The check attempting to be deposited does not belong to
462
+ * Increase.
463
+ */
464
+ 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';
465
+ }
466
+ /**
467
+ * An Inbound Real-Time Payments Transfer Decline object. This field will be
468
+ * present in the JSON response if and only if `category` is equal to
469
+ * `inbound_real_time_payments_transfer_decline`.
470
+ */
471
+ interface InboundRealTimePaymentsTransferDecline {
472
+ /**
473
+ * The declined amount in the minor unit of the destination account currency. For
474
+ * dollars, for example, this is cents.
475
+ */
476
+ amount: number;
477
+ /**
478
+ * The name the sender of the transfer specified as the recipient of the transfer.
479
+ */
480
+ creditor_name: string;
481
+ /**
482
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
483
+ * transfer's currency. This will always be "USD" for a Real-Time Payments
484
+ * transfer.
485
+ *
486
+ * - `CAD` - Canadian Dollar (CAD)
487
+ * - `CHF` - Swiss Franc (CHF)
488
+ * - `EUR` - Euro (EUR)
489
+ * - `GBP` - British Pound (GBP)
490
+ * - `JPY` - Japanese Yen (JPY)
491
+ * - `USD` - US Dollar (USD)
492
+ */
493
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
494
+ /**
495
+ * The account number of the account that sent the transfer.
496
+ */
497
+ debtor_account_number: string;
498
+ /**
499
+ * The name provided by the sender of the transfer.
500
+ */
501
+ debtor_name: string;
502
+ /**
503
+ * The routing number of the account that sent the transfer.
504
+ */
505
+ debtor_routing_number: string;
506
+ /**
507
+ * Why the transfer was declined.
508
+ *
509
+ * - `account_number_canceled` - The account number is canceled.
510
+ * - `account_number_disabled` - The account number is disabled.
511
+ * - `account_restricted` - Your account is restricted.
512
+ * - `group_locked` - Your account is inactive.
513
+ * - `entity_not_active` - The account's entity is not active.
514
+ * - `real_time_payments_not_enabled` - Your account is not enabled to receive
515
+ * Real-Time Payments transfers.
516
+ */
517
+ reason: 'account_number_canceled' | 'account_number_disabled' | 'account_restricted' | 'group_locked' | 'entity_not_active' | 'real_time_payments_not_enabled';
518
+ /**
519
+ * Additional information included with the transfer.
520
+ */
521
+ remittance_information: string | null;
522
+ /**
523
+ * The Real-Time Payments network identification of the declined transfer.
524
+ */
525
+ transaction_identification: string;
526
+ }
527
+ /**
528
+ * An International ACH Decline object. This field will be present in the JSON
529
+ * response if and only if `category` is equal to `international_ach_decline`.
530
+ */
531
+ interface InternationalACHDecline {
532
+ /**
533
+ * The declined amount in the minor unit of the destination account currency. For
534
+ * dollars, for example, this is cents.
535
+ */
536
+ amount: number;
537
+ /**
538
+ * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
539
+ * country code of the destination country.
540
+ */
541
+ destination_country_code: string;
542
+ /**
543
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
544
+ * destination bank account.
545
+ */
546
+ destination_currency_code: string;
547
+ /**
548
+ * A description of how the foreign exchange rate was calculated.
549
+ *
550
+ * - `fixed_to_variable` - The originator chose an amount in their own currency.
551
+ * The settled amount in USD was converted using the exchange rate.
552
+ * - `variable_to_fixed` - The originator chose an amount to settle in USD. The
553
+ * originator's amount was variable; known only after the foreign exchange
554
+ * conversion.
555
+ * - `fixed_to_fixed` - The amount was originated and settled as a fixed amount in
556
+ * USD. There is no foreign exchange conversion.
557
+ */
558
+ foreign_exchange_indicator: 'fixed_to_variable' | 'variable_to_fixed' | 'fixed_to_fixed';
559
+ /**
560
+ * Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a
561
+ * reference to a well-known rate.
562
+ */
563
+ foreign_exchange_reference: string | null;
564
+ /**
565
+ * An instruction of how to interpret the `foreign_exchange_reference` field for
566
+ * this Transaction.
567
+ *
568
+ * - `foreign_exchange_rate` - The ACH file contains a foreign exchange rate.
569
+ * - `foreign_exchange_reference_number` - The ACH file contains a reference to a
570
+ * well-known foreign exchange rate.
571
+ * - `blank` - There is no foreign exchange for this transfer, so the
572
+ * `foreign_exchange_reference` field is blank.
573
+ */
574
+ foreign_exchange_reference_indicator: 'foreign_exchange_rate' | 'foreign_exchange_reference_number' | 'blank';
575
+ /**
576
+ * The amount in the minor unit of the foreign payment currency. For dollars, for
577
+ * example, this is cents.
578
+ */
579
+ foreign_payment_amount: number;
580
+ /**
581
+ * A reference number in the foreign banking infrastructure.
582
+ */
583
+ foreign_trace_number: string | null;
584
+ /**
585
+ * The type of transfer. Set by the originator.
586
+ *
587
+ * - `annuity` - Sent as `ANN` in the Nacha file.
588
+ * - `business_or_commercial` - Sent as `BUS` in the Nacha file.
589
+ * - `deposit` - Sent as `DEP` in the Nacha file.
590
+ * - `loan` - Sent as `LOA` in the Nacha file.
591
+ * - `miscellaneous` - Sent as `MIS` in the Nacha file.
592
+ * - `mortgage` - Sent as `MOR` in the Nacha file.
593
+ * - `pension` - Sent as `PEN` in the Nacha file.
594
+ * - `remittance` - Sent as `REM` in the Nacha file.
595
+ * - `rent_or_lease` - Sent as `RLS` in the Nacha file.
596
+ * - `salary_or_payroll` - Sent as `SAL` in the Nacha file.
597
+ * - `tax` - Sent as `TAX` in the Nacha file.
598
+ * - `accounts_receivable` - Sent as `ARC` in the Nacha file.
599
+ * - `back_office_conversion` - Sent as `BOC` in the Nacha file.
600
+ * - `machine_transfer` - Sent as `MTE` in the Nacha file.
601
+ * - `point_of_purchase` - Sent as `POP` in the Nacha file.
602
+ * - `point_of_sale` - Sent as `POS` in the Nacha file.
603
+ * - `represented_check` - Sent as `RCK` in the Nacha file.
604
+ * - `shared_network_transaction` - Sent as `SHR` in the Nacha file.
605
+ * - `telphone_initiated` - Sent as `TEL` in the Nacha file.
606
+ * - `internet_initiated` - Sent as `WEB` in the Nacha file.
607
+ */
608
+ 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';
609
+ /**
610
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
611
+ * originating bank account.
612
+ */
613
+ originating_currency_code: string;
614
+ /**
615
+ * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
616
+ * country code of the originating branch country.
617
+ */
618
+ originating_depository_financial_institution_branch_country: string;
619
+ /**
620
+ * An identifier for the originating bank. One of an International Bank Account
621
+ * Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
622
+ * domestic identifier like a US Routing Number.
623
+ */
624
+ originating_depository_financial_institution_id: string;
625
+ /**
626
+ * An instruction of how to interpret the
627
+ * `originating_depository_financial_institution_id` field for this Transaction.
628
+ *
629
+ * - `national_clearing_system_number` - A domestic clearing system number. In the
630
+ * US, for example, this is the American Banking Association (ABA) routing
631
+ * number.
632
+ * - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
633
+ * - `iban` - An International Bank Account Number.
634
+ */
635
+ originating_depository_financial_institution_id_qualifier: 'national_clearing_system_number' | 'bic_code' | 'iban';
636
+ /**
637
+ * The name of the originating bank. Sometimes this will refer to an American bank
638
+ * and obscure the correspondent foreign bank.
639
+ */
640
+ originating_depository_financial_institution_name: string;
641
+ /**
642
+ * A portion of the originator address. This may be incomplete.
643
+ */
644
+ originator_city: string;
645
+ /**
646
+ * A description field set by the originator.
647
+ */
648
+ originator_company_entry_description: string;
649
+ /**
650
+ * A portion of the originator address. The
651
+ * [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
652
+ * code of the originator country.
653
+ */
654
+ originator_country: string;
655
+ /**
656
+ * An identifier for the originating company. This is generally stable across
657
+ * multiple ACH transfers.
658
+ */
659
+ originator_identification: string;
660
+ /**
661
+ * Either the name of the originator or an intermediary money transmitter.
662
+ */
663
+ originator_name: string;
664
+ /**
665
+ * A portion of the originator address. This may be incomplete.
666
+ */
667
+ originator_postal_code: string | null;
668
+ /**
669
+ * A portion of the originator address. This may be incomplete.
670
+ */
671
+ originator_state_or_province: string | null;
672
+ /**
673
+ * A portion of the originator address. This may be incomplete.
674
+ */
675
+ originator_street_address: string;
676
+ /**
677
+ * A description field set by the originator.
678
+ */
679
+ payment_related_information: string | null;
680
+ /**
681
+ * A description field set by the originator.
682
+ */
683
+ payment_related_information2: string | null;
684
+ /**
685
+ * A portion of the receiver address. This may be incomplete.
686
+ */
687
+ receiver_city: string;
688
+ /**
689
+ * A portion of the receiver address. The
690
+ * [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
691
+ * code of the receiver country.
692
+ */
693
+ receiver_country: string;
694
+ /**
695
+ * An identification number the originator uses for the receiver.
696
+ */
697
+ receiver_identification_number: string | null;
698
+ /**
699
+ * A portion of the receiver address. This may be incomplete.
700
+ */
701
+ receiver_postal_code: string | null;
702
+ /**
703
+ * A portion of the receiver address. This may be incomplete.
704
+ */
705
+ receiver_state_or_province: string | null;
706
+ /**
707
+ * A portion of the receiver address. This may be incomplete.
708
+ */
709
+ receiver_street_address: string;
710
+ /**
711
+ * The name of the receiver of the transfer. This is not verified by Increase.
712
+ */
713
+ receiving_company_or_individual_name: string;
714
+ /**
715
+ * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
716
+ * country code of the receiving bank country.
717
+ */
718
+ receiving_depository_financial_institution_country: string;
719
+ /**
720
+ * An identifier for the receiving bank. One of an International Bank Account
721
+ * Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
722
+ * domestic identifier like a US Routing Number.
723
+ */
724
+ receiving_depository_financial_institution_id: string;
725
+ /**
726
+ * An instruction of how to interpret the
727
+ * `receiving_depository_financial_institution_id` field for this Transaction.
728
+ *
729
+ * - `national_clearing_system_number` - A domestic clearing system number. In the
730
+ * US, for example, this is the American Banking Association (ABA) routing
731
+ * number.
732
+ * - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
733
+ * - `iban` - An International Bank Account Number.
734
+ */
735
+ receiving_depository_financial_institution_id_qualifier: 'national_clearing_system_number' | 'bic_code' | 'iban';
736
+ /**
737
+ * The name of the receiving bank, as set by the sending financial institution.
738
+ */
739
+ receiving_depository_financial_institution_name: string;
740
+ /**
741
+ * A 15 digit number recorded in the Nacha file and available to both the
742
+ * originating and receiving bank. Along with the amount, date, and originating
743
+ * routing number, this can be used to identify the ACH transfer at either bank.
744
+ * ACH trace numbers are not unique, but are
745
+ * [used to correlate returns](https://increase.com/documentation/ach#returns).
746
+ */
747
+ trace_number: string;
748
+ }
749
+ /**
750
+ * A Wire Decline object. This field will be present in the JSON response if and
751
+ * only if `category` is equal to `wire_decline`.
468
752
  */
469
- point_of_service_entry_mode:
470
- | 'unknown'
471
- | 'manual'
472
- | 'magnetic_stripe_no_cvv'
473
- | 'optical_code'
474
- | 'integrated_circuit_card'
475
- | 'contactless'
476
- | 'credential_on_file'
477
- | 'magnetic_stripe'
478
- | 'contactless_magnetic_stripe'
479
- | 'integrated_circuit_card_no_cvv'
480
- | null;
481
- }
753
+ interface WireDecline {
754
+ /**
755
+ * The declined amount in the minor unit of the destination account currency. For
756
+ * dollars, for example, this is cents.
757
+ */
758
+ amount: number;
759
+ /**
760
+ * A free-form address field set by the sender.
761
+ */
762
+ beneficiary_address_line1: string | null;
763
+ /**
764
+ * A free-form address field set by the sender.
765
+ */
766
+ beneficiary_address_line2: string | null;
767
+ /**
768
+ * A free-form address field set by the sender.
769
+ */
770
+ beneficiary_address_line3: string | null;
771
+ /**
772
+ * A name set by the sender.
773
+ */
774
+ beneficiary_name: string | null;
775
+ /**
776
+ * A free-form reference string set by the sender, to help identify the transfer.
777
+ */
778
+ beneficiary_reference: string | null;
779
+ /**
780
+ * An Increase-constructed description of the declined transaction.
781
+ */
782
+ description: string;
783
+ /**
784
+ * A unique identifier available to the originating and receiving banks, commonly
785
+ * abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
786
+ * service and is helpful when debugging wires with the originating bank.
787
+ */
788
+ input_message_accountability_data: string | null;
789
+ /**
790
+ * The address of the wire originator, set by the sending bank.
791
+ */
792
+ originator_address_line1: string | null;
793
+ /**
794
+ * The address of the wire originator, set by the sending bank.
795
+ */
796
+ originator_address_line2: string | null;
797
+ /**
798
+ * The address of the wire originator, set by the sending bank.
799
+ */
800
+ originator_address_line3: string | null;
801
+ /**
802
+ * The originator of the wire, set by the sending bank.
803
+ */
804
+ originator_name: string | null;
805
+ /**
806
+ * A free-form message set by the wire originator.
807
+ */
808
+ originator_to_beneficiary_information_line1: string | null;
809
+ /**
810
+ * A free-form message set by the wire originator.
811
+ */
812
+ originator_to_beneficiary_information_line2: string | null;
813
+ /**
814
+ * A free-form message set by the wire originator.
815
+ */
816
+ originator_to_beneficiary_information_line3: string | null;
817
+ /**
818
+ * A free-form message set by the wire originator.
819
+ */
820
+ originator_to_beneficiary_information_line4: string | null;
821
+ /**
822
+ * Why the wire transfer was declined.
823
+ *
824
+ * - `account_number_canceled` - The account number is canceled.
825
+ * - `account_number_disabled` - The account number is disabled.
826
+ * - `entity_not_active` - The account's entity is not active.
827
+ * - `group_locked` - Your account is inactive.
828
+ * - `no_account_number` - The beneficiary account number does not exist.
829
+ * - `transaction_not_allowed` - The transaction is not allowed per Increase's
830
+ * terms.
831
+ */
832
+ reason: 'account_number_canceled' | 'account_number_disabled' | 'entity_not_active' | 'group_locked' | 'no_account_number' | 'transaction_not_allowed';
833
+ }
482
834
  }
483
- }
484
- /**
485
- * A Check Decline object. This field will be present in the JSON response if and
486
- * only if `category` is equal to `check_decline`.
487
- */
488
- interface CheckDecline {
835
+ }
836
+ /**
837
+ * If the authorization attempt succeeds, this will contain the resulting Pending
838
+ * Transaction object. The Pending Transaction's `source` will be of
839
+ * `category: card_authorization`.
840
+ */
841
+ interface PendingTransaction {
489
842
  /**
490
- * The declined amount in the minor unit of the destination account currency. For
491
- * dollars, for example, this is cents.
843
+ * The Pending Transaction identifier.
492
844
  */
493
- amount: number;
845
+ id: string;
494
846
  /**
495
- * A computer-readable number printed on the MICR line of business checks, usually
496
- * the check number. This is useful for positive pay checks, but can be unreliably
497
- * transmitted by the bank of first deposit.
847
+ * The identifier for the account this Pending Transaction belongs to.
498
848
  */
499
- auxiliary_on_us: string | null;
849
+ account_id: string;
500
850
  /**
501
- * Why the check was declined.
502
- *
503
- * - `ach_route_disabled` - The account number is disabled.
504
- * - `ach_route_canceled` - The account number is canceled.
505
- * - `breaches_limit` - The transaction would cause a limit to be exceeded.
506
- * - `entity_not_active` - The account's entity is not active.
507
- * - `group_locked` - Your account is inactive.
508
- * - `insufficient_funds` - Your account contains insufficient funds.
509
- * - `stop_payment_requested` - Stop payment requested for this check.
510
- * - `duplicate_presentment` - The check was a duplicate deposit.
511
- * - `not_authorized` - The check was not authorized.
512
- * - `amount_mismatch` - The amount the receiving bank is attempting to deposit
513
- * does not match the amount on the check.
514
- * - `not_our_item` - The check attempting to be deposited does not belong to
515
- * Increase.
851
+ * The Pending Transaction amount in the minor unit of its currency. For dollars,
852
+ * for example, this is cents.
516
853
  */
517
- reason:
518
- | 'ach_route_disabled'
519
- | 'ach_route_canceled'
520
- | 'breaches_limit'
521
- | 'entity_not_active'
522
- | 'group_locked'
523
- | 'insufficient_funds'
524
- | 'stop_payment_requested'
525
- | 'duplicate_presentment'
526
- | 'not_authorized'
527
- | 'amount_mismatch'
528
- | 'not_our_item';
529
- }
530
- /**
531
- * An Inbound Real-Time Payments Transfer Decline object. This field will be
532
- * present in the JSON response if and only if `category` is equal to
533
- * `inbound_real_time_payments_transfer_decline`.
534
- */
535
- interface InboundRealTimePaymentsTransferDecline {
854
+ amount: number;
536
855
  /**
537
- * The declined amount in the minor unit of the destination account currency. For
538
- * dollars, for example, this is cents.
856
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
857
+ * Transaction was completed.
539
858
  */
540
- amount: number;
859
+ completed_at: string | null;
541
860
  /**
542
- * The name the sender of the transfer specified as the recipient of the transfer.
861
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
862
+ * Transaction occurred.
543
863
  */
544
- creditor_name: string;
864
+ created_at: string;
545
865
  /**
546
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
547
- * transfer's currency. This will always be "USD" for a Real-Time Payments
548
- * transfer.
866
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending
867
+ * Transaction's currency. This will match the currency on the Pending
868
+ * Transaction's Account.
549
869
  *
550
870
  * - `CAD` - Canadian Dollar (CAD)
551
871
  * - `CHF` - Swiss Franc (CHF)
@@ -556,994 +876,544 @@ export declare namespace CardAuthorizationSimulation {
556
876
  */
557
877
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
558
878
  /**
559
- * The account number of the account that sent the transfer.
560
- */
561
- debtor_account_number: string;
562
- /**
563
- * The name provided by the sender of the transfer.
564
- */
565
- debtor_name: string;
566
- /**
567
- * The routing number of the account that sent the transfer.
568
- */
569
- debtor_routing_number: string;
570
- /**
571
- * Why the transfer was declined.
572
- *
573
- * - `account_number_canceled` - The account number is canceled.
574
- * - `account_number_disabled` - The account number is disabled.
575
- * - `account_restricted` - Your account is restricted.
576
- * - `group_locked` - Your account is inactive.
577
- * - `entity_not_active` - The account's entity is not active.
578
- * - `real_time_payments_not_enabled` - Your account is not enabled to receive
579
- * Real-Time Payments transfers.
580
- */
581
- reason:
582
- | 'account_number_canceled'
583
- | 'account_number_disabled'
584
- | 'account_restricted'
585
- | 'group_locked'
586
- | 'entity_not_active'
587
- | 'real_time_payments_not_enabled';
588
- /**
589
- * Additional information included with the transfer.
590
- */
591
- remittance_information: string | null;
592
- /**
593
- * The Real-Time Payments network identification of the declined transfer.
594
- */
595
- transaction_identification: string;
596
- }
597
- /**
598
- * An International ACH Decline object. This field will be present in the JSON
599
- * response if and only if `category` is equal to `international_ach_decline`.
600
- */
601
- interface InternationalACHDecline {
602
- /**
603
- * The declined amount in the minor unit of the destination account currency. For
604
- * dollars, for example, this is cents.
605
- */
606
- amount: number;
607
- /**
608
- * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
609
- * country code of the destination country.
610
- */
611
- destination_country_code: string;
612
- /**
613
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
614
- * destination bank account.
615
- */
616
- destination_currency_code: string;
617
- /**
618
- * A description of how the foreign exchange rate was calculated.
619
- *
620
- * - `fixed_to_variable` - The originator chose an amount in their own currency.
621
- * The settled amount in USD was converted using the exchange rate.
622
- * - `variable_to_fixed` - The originator chose an amount to settle in USD. The
623
- * originator's amount was variable; known only after the foreign exchange
624
- * conversion.
625
- * - `fixed_to_fixed` - The amount was originated and settled as a fixed amount in
626
- * USD. There is no foreign exchange conversion.
627
- */
628
- foreign_exchange_indicator: 'fixed_to_variable' | 'variable_to_fixed' | 'fixed_to_fixed';
629
- /**
630
- * Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a
631
- * reference to a well-known rate.
632
- */
633
- foreign_exchange_reference: string | null;
634
- /**
635
- * An instruction of how to interpret the `foreign_exchange_reference` field for
636
- * this Transaction.
637
- *
638
- * - `foreign_exchange_rate` - The ACH file contains a foreign exchange rate.
639
- * - `foreign_exchange_reference_number` - The ACH file contains a reference to a
640
- * well-known foreign exchange rate.
641
- * - `blank` - There is no foreign exchange for this transfer, so the
642
- * `foreign_exchange_reference` field is blank.
643
- */
644
- foreign_exchange_reference_indicator:
645
- | 'foreign_exchange_rate'
646
- | 'foreign_exchange_reference_number'
647
- | 'blank';
648
- /**
649
- * The amount in the minor unit of the foreign payment currency. For dollars, for
650
- * example, this is cents.
651
- */
652
- foreign_payment_amount: number;
653
- /**
654
- * A reference number in the foreign banking infrastructure.
655
- */
656
- foreign_trace_number: string | null;
657
- /**
658
- * The type of transfer. Set by the originator.
659
- *
660
- * - `annuity` - Sent as `ANN` in the Nacha file.
661
- * - `business_or_commercial` - Sent as `BUS` in the Nacha file.
662
- * - `deposit` - Sent as `DEP` in the Nacha file.
663
- * - `loan` - Sent as `LOA` in the Nacha file.
664
- * - `miscellaneous` - Sent as `MIS` in the Nacha file.
665
- * - `mortgage` - Sent as `MOR` in the Nacha file.
666
- * - `pension` - Sent as `PEN` in the Nacha file.
667
- * - `remittance` - Sent as `REM` in the Nacha file.
668
- * - `rent_or_lease` - Sent as `RLS` in the Nacha file.
669
- * - `salary_or_payroll` - Sent as `SAL` in the Nacha file.
670
- * - `tax` - Sent as `TAX` in the Nacha file.
671
- * - `accounts_receivable` - Sent as `ARC` in the Nacha file.
672
- * - `back_office_conversion` - Sent as `BOC` in the Nacha file.
673
- * - `machine_transfer` - Sent as `MTE` in the Nacha file.
674
- * - `point_of_purchase` - Sent as `POP` in the Nacha file.
675
- * - `point_of_sale` - Sent as `POS` in the Nacha file.
676
- * - `represented_check` - Sent as `RCK` in the Nacha file.
677
- * - `shared_network_transaction` - Sent as `SHR` in the Nacha file.
678
- * - `telphone_initiated` - Sent as `TEL` in the Nacha file.
679
- * - `internet_initiated` - Sent as `WEB` in the Nacha file.
680
- */
681
- international_transaction_type_code:
682
- | 'annuity'
683
- | 'business_or_commercial'
684
- | 'deposit'
685
- | 'loan'
686
- | 'miscellaneous'
687
- | 'mortgage'
688
- | 'pension'
689
- | 'remittance'
690
- | 'rent_or_lease'
691
- | 'salary_or_payroll'
692
- | 'tax'
693
- | 'accounts_receivable'
694
- | 'back_office_conversion'
695
- | 'machine_transfer'
696
- | 'point_of_purchase'
697
- | 'point_of_sale'
698
- | 'represented_check'
699
- | 'shared_network_transaction'
700
- | 'telphone_initiated'
701
- | 'internet_initiated';
702
- /**
703
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
704
- * originating bank account.
879
+ * For a Pending Transaction related to a transfer, this is the description you
880
+ * provide. For a Pending Transaction related to a payment, this is the description
881
+ * the vendor provides.
705
882
  */
706
- originating_currency_code: string;
707
- /**
708
- * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
709
- * country code of the originating branch country.
710
- */
711
- originating_depository_financial_institution_branch_country: string;
883
+ description: string;
712
884
  /**
713
- * An identifier for the originating bank. One of an International Bank Account
714
- * Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
715
- * domestic identifier like a US Routing Number.
885
+ * The identifier for the route this Pending Transaction came through. Routes are
886
+ * things like cards and ACH details.
716
887
  */
717
- originating_depository_financial_institution_id: string;
888
+ route_id: string | null;
718
889
  /**
719
- * An instruction of how to interpret the
720
- * `originating_depository_financial_institution_id` field for this Transaction.
890
+ * The type of the route this Pending Transaction came through.
721
891
  *
722
- * - `national_clearing_system_number` - A domestic clearing system number. In the
723
- * US, for example, this is the American Banking Association (ABA) routing
724
- * number.
725
- * - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
726
- * - `iban` - An International Bank Account Number.
892
+ * - `account_number` - An Account Number.
893
+ * - `card` - A Card.
727
894
  */
728
- originating_depository_financial_institution_id_qualifier:
729
- | 'national_clearing_system_number'
730
- | 'bic_code'
731
- | 'iban';
895
+ route_type: 'account_number' | 'card' | null;
732
896
  /**
733
- * The name of the originating bank. Sometimes this will refer to an American bank
734
- * and obscure the correspondent foreign bank.
897
+ * This is an object giving more details on the network-level event that caused the
898
+ * Pending Transaction. For example, for a card transaction this lists the
899
+ * merchant's industry and location.
735
900
  */
736
- originating_depository_financial_institution_name: string;
901
+ source: PendingTransaction.Source;
737
902
  /**
738
- * A portion of the originator address. This may be incomplete.
739
- */
740
- originator_city: string;
741
- /**
742
- * A description field set by the originator.
743
- */
744
- originator_company_entry_description: string;
745
- /**
746
- * A portion of the originator address. The
747
- * [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
748
- * code of the originator country.
749
- */
750
- originator_country: string;
751
- /**
752
- * An identifier for the originating company. This is generally stable across
753
- * multiple ACH transfers.
754
- */
755
- originator_identification: string;
756
- /**
757
- * Either the name of the originator or an intermediary money transmitter.
758
- */
759
- originator_name: string;
760
- /**
761
- * A portion of the originator address. This may be incomplete.
762
- */
763
- originator_postal_code: string | null;
764
- /**
765
- * A portion of the originator address. This may be incomplete.
766
- */
767
- originator_state_or_province: string | null;
768
- /**
769
- * A portion of the originator address. This may be incomplete.
770
- */
771
- originator_street_address: string;
772
- /**
773
- * A description field set by the originator.
774
- */
775
- payment_related_information: string | null;
776
- /**
777
- * A description field set by the originator.
778
- */
779
- payment_related_information2: string | null;
780
- /**
781
- * A portion of the receiver address. This may be incomplete.
782
- */
783
- receiver_city: string;
784
- /**
785
- * A portion of the receiver address. The
786
- * [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
787
- * code of the receiver country.
788
- */
789
- receiver_country: string;
790
- /**
791
- * An identification number the originator uses for the receiver.
792
- */
793
- receiver_identification_number: string | null;
794
- /**
795
- * A portion of the receiver address. This may be incomplete.
796
- */
797
- receiver_postal_code: string | null;
798
- /**
799
- * A portion of the receiver address. This may be incomplete.
800
- */
801
- receiver_state_or_province: string | null;
802
- /**
803
- * A portion of the receiver address. This may be incomplete.
804
- */
805
- receiver_street_address: string;
806
- /**
807
- * The name of the receiver of the transfer. This is not verified by Increase.
808
- */
809
- receiving_company_or_individual_name: string;
810
- /**
811
- * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
812
- * country code of the receiving bank country.
813
- */
814
- receiving_depository_financial_institution_country: string;
815
- /**
816
- * An identifier for the receiving bank. One of an International Bank Account
817
- * Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
818
- * domestic identifier like a US Routing Number.
819
- */
820
- receiving_depository_financial_institution_id: string;
821
- /**
822
- * An instruction of how to interpret the
823
- * `receiving_depository_financial_institution_id` field for this Transaction.
903
+ * Whether the Pending Transaction has been confirmed and has an associated
904
+ * Transaction.
824
905
  *
825
- * - `national_clearing_system_number` - A domestic clearing system number. In the
826
- * US, for example, this is the American Banking Association (ABA) routing
827
- * number.
828
- * - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
829
- * - `iban` - An International Bank Account Number.
830
- */
831
- receiving_depository_financial_institution_id_qualifier:
832
- | 'national_clearing_system_number'
833
- | 'bic_code'
834
- | 'iban';
835
- /**
836
- * The name of the receiving bank, as set by the sending financial institution.
837
- */
838
- receiving_depository_financial_institution_name: string;
839
- /**
840
- * A 15 digit number recorded in the Nacha file and available to both the
841
- * originating and receiving bank. Along with the amount, date, and originating
842
- * routing number, this can be used to identify the ACH transfer at either bank.
843
- * ACH trace numbers are not unique, but are
844
- * [used to correlate returns](https://increase.com/documentation/ach#returns).
845
- */
846
- trace_number: string;
847
- }
848
- /**
849
- * A Wire Decline object. This field will be present in the JSON response if and
850
- * only if `category` is equal to `wire_decline`.
851
- */
852
- interface WireDecline {
853
- /**
854
- * The declined amount in the minor unit of the destination account currency. For
855
- * dollars, for example, this is cents.
856
- */
857
- amount: number;
858
- /**
859
- * A free-form address field set by the sender.
860
- */
861
- beneficiary_address_line1: string | null;
862
- /**
863
- * A free-form address field set by the sender.
864
- */
865
- beneficiary_address_line2: string | null;
866
- /**
867
- * A free-form address field set by the sender.
868
- */
869
- beneficiary_address_line3: string | null;
870
- /**
871
- * A name set by the sender.
906
+ * - `pending` - The Pending Transaction is still awaiting confirmation.
907
+ * - `complete` - The Pending Transaction is confirmed. An associated Transaction
908
+ * exists for this object. The Pending Transaction will no longer count against
909
+ * your balance and can generally be hidden from UIs, etc.
872
910
  */
873
- beneficiary_name: string | null;
911
+ status: 'pending' | 'complete';
874
912
  /**
875
- * A free-form reference string set by the sender, to help identify the transfer.
876
- */
877
- beneficiary_reference: string | null;
878
- /**
879
- * An Increase-constructed description of the declined transaction.
880
- */
881
- description: string;
882
- /**
883
- * A unique identifier available to the originating and receiving banks, commonly
884
- * abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
885
- * service and is helpful when debugging wires with the originating bank.
886
- */
887
- input_message_accountability_data: string | null;
888
- /**
889
- * The address of the wire originator, set by the sending bank.
890
- */
891
- originator_address_line1: string | null;
892
- /**
893
- * The address of the wire originator, set by the sending bank.
894
- */
895
- originator_address_line2: string | null;
896
- /**
897
- * The address of the wire originator, set by the sending bank.
898
- */
899
- originator_address_line3: string | null;
900
- /**
901
- * The originator of the wire, set by the sending bank.
902
- */
903
- originator_name: string | null;
904
- /**
905
- * A free-form message set by the wire originator.
906
- */
907
- originator_to_beneficiary_information_line1: string | null;
908
- /**
909
- * A free-form message set by the wire originator.
910
- */
911
- originator_to_beneficiary_information_line2: string | null;
912
- /**
913
- * A free-form message set by the wire originator.
914
- */
915
- originator_to_beneficiary_information_line3: string | null;
916
- /**
917
- * A free-form message set by the wire originator.
913
+ * A constant representing the object's type. For this resource it will always be
914
+ * `pending_transaction`.
918
915
  */
919
- originator_to_beneficiary_information_line4: string | null;
916
+ type: 'pending_transaction';
917
+ }
918
+ namespace PendingTransaction {
920
919
  /**
921
- * Why the wire transfer was declined.
922
- *
923
- * - `account_number_canceled` - The account number is canceled.
924
- * - `account_number_disabled` - The account number is disabled.
925
- * - `entity_not_active` - The account's entity is not active.
926
- * - `group_locked` - Your account is inactive.
927
- * - `no_account_number` - The beneficiary account number does not exist.
928
- * - `transaction_not_allowed` - The transaction is not allowed per Increase's
929
- * terms.
920
+ * This is an object giving more details on the network-level event that caused the
921
+ * Pending Transaction. For example, for a card transaction this lists the
922
+ * merchant's industry and location.
930
923
  */
931
- reason:
932
- | 'account_number_canceled'
933
- | 'account_number_disabled'
934
- | 'entity_not_active'
935
- | 'group_locked'
936
- | 'no_account_number'
937
- | 'transaction_not_allowed';
938
- }
924
+ interface Source {
925
+ /**
926
+ * An Account Transfer Instruction object. This field will be present in the JSON
927
+ * response if and only if `category` is equal to `account_transfer_instruction`.
928
+ */
929
+ account_transfer_instruction: Source.AccountTransferInstruction | null;
930
+ /**
931
+ * An ACH Transfer Instruction object. This field will be present in the JSON
932
+ * response if and only if `category` is equal to `ach_transfer_instruction`.
933
+ */
934
+ ach_transfer_instruction: Source.ACHTransferInstruction | null;
935
+ /**
936
+ * A Card Authorization object. This field will be present in the JSON response if
937
+ * and only if `category` is equal to `card_authorization`.
938
+ */
939
+ card_authorization: Source.CardAuthorization | null;
940
+ /**
941
+ * The type of the resource. We may add additional possible values for this enum
942
+ * over time; your application should be able to handle such additions gracefully.
943
+ *
944
+ * - `account_transfer_instruction` - Account Transfer Instruction: details will be
945
+ * under the `account_transfer_instruction` object.
946
+ * - `ach_transfer_instruction` - ACH Transfer Instruction: details will be under
947
+ * the `ach_transfer_instruction` object.
948
+ * - `card_authorization` - Card Authorization: details will be under the
949
+ * `card_authorization` object.
950
+ * - `check_deposit_instruction` - Check Deposit Instruction: details will be under
951
+ * the `check_deposit_instruction` object.
952
+ * - `check_transfer_instruction` - Check Transfer Instruction: details will be
953
+ * under the `check_transfer_instruction` object.
954
+ * - `inbound_funds_hold` - Inbound Funds Hold: details will be under the
955
+ * `inbound_funds_hold` object.
956
+ * - `real_time_payments_transfer_instruction` - Real-Time Payments Transfer
957
+ * Instruction: details will be under the
958
+ * `real_time_payments_transfer_instruction` object.
959
+ * - `wire_transfer_instruction` - Wire Transfer Instruction: details will be under
960
+ * the `wire_transfer_instruction` object.
961
+ * - `other` - The Pending Transaction was made for an undocumented or deprecated
962
+ * reason.
963
+ */
964
+ category: 'account_transfer_instruction' | 'ach_transfer_instruction' | 'card_authorization' | 'check_deposit_instruction' | 'check_transfer_instruction' | 'inbound_funds_hold' | 'real_time_payments_transfer_instruction' | 'wire_transfer_instruction' | 'other';
965
+ /**
966
+ * A Check Deposit Instruction object. This field will be present in the JSON
967
+ * response if and only if `category` is equal to `check_deposit_instruction`.
968
+ */
969
+ check_deposit_instruction: Source.CheckDepositInstruction | null;
970
+ /**
971
+ * A Check Transfer Instruction object. This field will be present in the JSON
972
+ * response if and only if `category` is equal to `check_transfer_instruction`.
973
+ */
974
+ check_transfer_instruction: Source.CheckTransferInstruction | null;
975
+ /**
976
+ * An Inbound Funds Hold object. This field will be present in the JSON response if
977
+ * and only if `category` is equal to `inbound_funds_hold`.
978
+ */
979
+ inbound_funds_hold: Source.InboundFundsHold | null;
980
+ /**
981
+ * A Real-Time Payments Transfer Instruction object. This field will be present in
982
+ * the JSON response if and only if `category` is equal to
983
+ * `real_time_payments_transfer_instruction`.
984
+ */
985
+ real_time_payments_transfer_instruction: Source.RealTimePaymentsTransferInstruction | null;
986
+ /**
987
+ * A Wire Transfer Instruction object. This field will be present in the JSON
988
+ * response if and only if `category` is equal to `wire_transfer_instruction`.
989
+ */
990
+ wire_transfer_instruction: Source.WireTransferInstruction | null;
991
+ }
992
+ namespace Source {
993
+ /**
994
+ * An Account Transfer Instruction object. This field will be present in the JSON
995
+ * response if and only if `category` is equal to `account_transfer_instruction`.
996
+ */
997
+ interface AccountTransferInstruction {
998
+ /**
999
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
1000
+ * for example, this is cents.
1001
+ */
1002
+ amount: number;
1003
+ /**
1004
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
1005
+ * account currency.
1006
+ *
1007
+ * - `CAD` - Canadian Dollar (CAD)
1008
+ * - `CHF` - Swiss Franc (CHF)
1009
+ * - `EUR` - Euro (EUR)
1010
+ * - `GBP` - British Pound (GBP)
1011
+ * - `JPY` - Japanese Yen (JPY)
1012
+ * - `USD` - US Dollar (USD)
1013
+ */
1014
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1015
+ /**
1016
+ * The identifier of the Account Transfer that led to this Pending Transaction.
1017
+ */
1018
+ transfer_id: string;
1019
+ }
1020
+ /**
1021
+ * An ACH Transfer Instruction object. This field will be present in the JSON
1022
+ * response if and only if `category` is equal to `ach_transfer_instruction`.
1023
+ */
1024
+ interface ACHTransferInstruction {
1025
+ /**
1026
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
1027
+ * for example, this is cents.
1028
+ */
1029
+ amount: number;
1030
+ /**
1031
+ * The identifier of the ACH Transfer that led to this Pending Transaction.
1032
+ */
1033
+ transfer_id: string;
1034
+ }
1035
+ /**
1036
+ * A Card Authorization object. This field will be present in the JSON response if
1037
+ * and only if `category` is equal to `card_authorization`.
1038
+ */
1039
+ interface CardAuthorization {
1040
+ /**
1041
+ * The Card Authorization identifier.
1042
+ */
1043
+ id: string;
1044
+ /**
1045
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
1046
+ * for example, this is cents.
1047
+ */
1048
+ amount: number;
1049
+ /**
1050
+ * The ID of the Card Payment this transaction belongs to.
1051
+ */
1052
+ card_payment_id: string | null;
1053
+ /**
1054
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1055
+ * transaction's currency.
1056
+ *
1057
+ * - `CAD` - Canadian Dollar (CAD)
1058
+ * - `CHF` - Swiss Franc (CHF)
1059
+ * - `EUR` - Euro (EUR)
1060
+ * - `GBP` - British Pound (GBP)
1061
+ * - `JPY` - Japanese Yen (JPY)
1062
+ * - `USD` - US Dollar (USD)
1063
+ */
1064
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1065
+ /**
1066
+ * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
1067
+ * purchase), the identifier of the token that was used.
1068
+ */
1069
+ digital_wallet_token_id: string | null;
1070
+ /**
1071
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
1072
+ * will expire and the pending transaction will be released.
1073
+ */
1074
+ expires_at: string;
1075
+ /**
1076
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
1077
+ * is transacting with.
1078
+ */
1079
+ merchant_acceptor_id: string;
1080
+ /**
1081
+ * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
1082
+ * card is transacting with.
1083
+ */
1084
+ merchant_category_code: string | null;
1085
+ /**
1086
+ * The city the merchant resides in.
1087
+ */
1088
+ merchant_city: string | null;
1089
+ /**
1090
+ * The country the merchant resides in.
1091
+ */
1092
+ merchant_country: string | null;
1093
+ /**
1094
+ * The merchant descriptor of the merchant the card is transacting with.
1095
+ */
1096
+ merchant_descriptor: string;
1097
+ /**
1098
+ * Fields specific to the `network`.
1099
+ */
1100
+ network_details: CardAuthorization.NetworkDetails;
1101
+ /**
1102
+ * The identifier of the Pending Transaction associated with this Transaction.
1103
+ */
1104
+ pending_transaction_id: string | null;
1105
+ /**
1106
+ * If the authorization was made in-person with a physical card, the Physical Card
1107
+ * that was used.
1108
+ */
1109
+ physical_card_id: string | null;
1110
+ /**
1111
+ * The identifier of the Real-Time Decision sent to approve or decline this
1112
+ * transaction.
1113
+ */
1114
+ real_time_decision_id: string | null;
1115
+ /**
1116
+ * A constant representing the object's type. For this resource it will always be
1117
+ * `card_authorization`.
1118
+ */
1119
+ type: 'card_authorization';
1120
+ }
1121
+ namespace CardAuthorization {
1122
+ /**
1123
+ * Fields specific to the `network`.
1124
+ */
1125
+ interface NetworkDetails {
1126
+ /**
1127
+ * The payment network used to process this card authorization.
1128
+ *
1129
+ * - `visa` - Visa
1130
+ */
1131
+ category: 'visa';
1132
+ /**
1133
+ * Fields specific to the `visa` network.
1134
+ */
1135
+ visa: NetworkDetails.Visa | null;
1136
+ }
1137
+ namespace NetworkDetails {
1138
+ /**
1139
+ * Fields specific to the `visa` network.
1140
+ */
1141
+ interface Visa {
1142
+ /**
1143
+ * For electronic commerce transactions, this identifies the level of security used
1144
+ * in obtaining the customer's payment credential. For mail or telephone order
1145
+ * transactions, identifies the type of mail or telephone order.
1146
+ *
1147
+ * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
1148
+ * that the transaction is a mail/phone order purchase, not a recurring
1149
+ * transaction or installment payment. For domestic transactions in the US
1150
+ * region, this value may also indicate one bill payment transaction in the
1151
+ * card-present or card-absent environments.
1152
+ * - `recurring` - Recurring transaction: Payment indicator used to indicate a
1153
+ * recurring transaction that originates from an acquirer in the US region.
1154
+ * - `installment` - Installment payment: Payment indicator used to indicate one
1155
+ * purchase of goods or services that is billed to the account in multiple
1156
+ * charges over a period of time agreed upon by the cardholder and merchant from
1157
+ * transactions that originate from an acquirer in the US region.
1158
+ * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
1159
+ * indicate that the type of mail/telephone order is unknown.
1160
+ * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
1161
+ * indicate that the electronic commerce transaction has been authenticated using
1162
+ * e.g., 3-D Secure
1163
+ * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
1164
+ * Non-authenticated security transaction at a 3-D Secure-capable merchant, and
1165
+ * merchant attempted to authenticate the cardholder using 3-D Secure: Use to
1166
+ * identify an electronic commerce transaction where the merchant attempted to
1167
+ * authenticate the cardholder using 3-D Secure, but was unable to complete the
1168
+ * authentication because the issuer or cardholder does not participate in the
1169
+ * 3-D Secure program.
1170
+ * - `non_authenticated_security_transaction` - Non-authenticated security
1171
+ * transaction: Use to identify an electronic commerce transaction that uses data
1172
+ * encryption for security however , cardholder authentication is not performed
1173
+ * using 3-D Secure.
1174
+ * - `non_secure_transaction` - Non-secure transaction: Use to identify an
1175
+ * electronic commerce transaction that has no data protection.
1176
+ */
1177
+ 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;
1178
+ /**
1179
+ * The method used to enter the cardholder's primary account number and card
1180
+ * expiration date.
1181
+ *
1182
+ * - `unknown` - Unknown
1183
+ * - `manual` - Manual key entry
1184
+ * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
1185
+ * value
1186
+ * - `optical_code` - Optical code
1187
+ * - `integrated_circuit_card` - Contact chip card
1188
+ * - `contactless` - Contactless read of chip card
1189
+ * - `credential_on_file` - Transaction initiated using a credential that has
1190
+ * previously been stored on file
1191
+ * - `magnetic_stripe` - Magnetic stripe read
1192
+ * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
1193
+ * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
1194
+ * verification value
1195
+ */
1196
+ 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;
1197
+ }
1198
+ }
1199
+ }
1200
+ /**
1201
+ * A Check Deposit Instruction object. This field will be present in the JSON
1202
+ * response if and only if `category` is equal to `check_deposit_instruction`.
1203
+ */
1204
+ interface CheckDepositInstruction {
1205
+ /**
1206
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
1207
+ * for example, this is cents.
1208
+ */
1209
+ amount: number;
1210
+ /**
1211
+ * The identifier of the File containing the image of the back of the check that
1212
+ * was deposited.
1213
+ */
1214
+ back_image_file_id: string | null;
1215
+ /**
1216
+ * The identifier of the Check Deposit.
1217
+ */
1218
+ check_deposit_id: string | null;
1219
+ /**
1220
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1221
+ * transaction's currency.
1222
+ *
1223
+ * - `CAD` - Canadian Dollar (CAD)
1224
+ * - `CHF` - Swiss Franc (CHF)
1225
+ * - `EUR` - Euro (EUR)
1226
+ * - `GBP` - British Pound (GBP)
1227
+ * - `JPY` - Japanese Yen (JPY)
1228
+ * - `USD` - US Dollar (USD)
1229
+ */
1230
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1231
+ /**
1232
+ * The identifier of the File containing the image of the front of the check that
1233
+ * was deposited.
1234
+ */
1235
+ front_image_file_id: string;
1236
+ }
1237
+ /**
1238
+ * A Check Transfer Instruction object. This field will be present in the JSON
1239
+ * response if and only if `category` is equal to `check_transfer_instruction`.
1240
+ */
1241
+ interface CheckTransferInstruction {
1242
+ /**
1243
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
1244
+ * for example, this is cents.
1245
+ */
1246
+ amount: number;
1247
+ /**
1248
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
1249
+ * currency.
1250
+ *
1251
+ * - `CAD` - Canadian Dollar (CAD)
1252
+ * - `CHF` - Swiss Franc (CHF)
1253
+ * - `EUR` - Euro (EUR)
1254
+ * - `GBP` - British Pound (GBP)
1255
+ * - `JPY` - Japanese Yen (JPY)
1256
+ * - `USD` - US Dollar (USD)
1257
+ */
1258
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1259
+ /**
1260
+ * The identifier of the Check Transfer that led to this Pending Transaction.
1261
+ */
1262
+ transfer_id: string;
1263
+ }
1264
+ /**
1265
+ * An Inbound Funds Hold object. This field will be present in the JSON response if
1266
+ * and only if `category` is equal to `inbound_funds_hold`.
1267
+ */
1268
+ interface InboundFundsHold {
1269
+ /**
1270
+ * The Inbound Funds Hold identifier.
1271
+ */
1272
+ id: string;
1273
+ /**
1274
+ * The held amount in the minor unit of the account's currency. For dollars, for
1275
+ * example, this is cents.
1276
+ */
1277
+ amount: number;
1278
+ /**
1279
+ * When the hold will be released automatically. Certain conditions may cause it to
1280
+ * be released before this time.
1281
+ */
1282
+ automatically_releases_at: string;
1283
+ /**
1284
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
1285
+ * was created.
1286
+ */
1287
+ created_at: string;
1288
+ /**
1289
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
1290
+ * currency.
1291
+ *
1292
+ * - `CAD` - Canadian Dollar (CAD)
1293
+ * - `CHF` - Swiss Franc (CHF)
1294
+ * - `EUR` - Euro (EUR)
1295
+ * - `GBP` - British Pound (GBP)
1296
+ * - `JPY` - Japanese Yen (JPY)
1297
+ * - `USD` - US Dollar (USD)
1298
+ */
1299
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1300
+ /**
1301
+ * The ID of the Transaction for which funds were held.
1302
+ */
1303
+ held_transaction_id: string | null;
1304
+ /**
1305
+ * The ID of the Pending Transaction representing the held funds.
1306
+ */
1307
+ pending_transaction_id: string | null;
1308
+ /**
1309
+ * When the hold was released (if it has been released).
1310
+ */
1311
+ released_at: string | null;
1312
+ /**
1313
+ * The status of the hold.
1314
+ *
1315
+ * - `held` - Funds are still being held.
1316
+ * - `complete` - Funds have been released.
1317
+ */
1318
+ status: 'held' | 'complete';
1319
+ /**
1320
+ * A constant representing the object's type. For this resource it will always be
1321
+ * `inbound_funds_hold`.
1322
+ */
1323
+ type: 'inbound_funds_hold';
1324
+ }
1325
+ /**
1326
+ * A Real-Time Payments Transfer Instruction object. This field will be present in
1327
+ * the JSON response if and only if `category` is equal to
1328
+ * `real_time_payments_transfer_instruction`.
1329
+ */
1330
+ interface RealTimePaymentsTransferInstruction {
1331
+ /**
1332
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
1333
+ * for example, this is cents.
1334
+ */
1335
+ amount: number;
1336
+ /**
1337
+ * The identifier of the Real-Time Payments Transfer that led to this Pending
1338
+ * Transaction.
1339
+ */
1340
+ transfer_id: string;
1341
+ }
1342
+ /**
1343
+ * A Wire Transfer Instruction object. This field will be present in the JSON
1344
+ * response if and only if `category` is equal to `wire_transfer_instruction`.
1345
+ */
1346
+ interface WireTransferInstruction {
1347
+ /**
1348
+ * The account number for the destination account.
1349
+ */
1350
+ account_number: string;
1351
+ /**
1352
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
1353
+ * for example, this is cents.
1354
+ */
1355
+ amount: number;
1356
+ /**
1357
+ * The message that will show on the recipient's bank statement.
1358
+ */
1359
+ message_to_recipient: string;
1360
+ /**
1361
+ * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
1362
+ * destination account.
1363
+ */
1364
+ routing_number: string;
1365
+ /**
1366
+ * The identifier of the Wire Transfer that led to this Pending Transaction.
1367
+ */
1368
+ transfer_id: string;
1369
+ }
1370
+ }
939
1371
  }
940
- }
941
- /**
942
- * If the authorization attempt succeeds, this will contain the resulting Pending
943
- * Transaction object. The Pending Transaction's `source` will be of
944
- * `category: card_authorization`.
945
- */
946
- interface PendingTransaction {
947
- /**
948
- * The Pending Transaction identifier.
949
- */
950
- id: string;
951
- /**
952
- * The identifier for the account this Pending Transaction belongs to.
953
- */
954
- account_id: string;
1372
+ }
1373
+ export interface CardAuthorizeParams {
955
1374
  /**
956
- * The Pending Transaction amount in the minor unit of its currency. For dollars,
957
- * for example, this is cents.
1375
+ * The authorization amount in cents.
958
1376
  */
959
1377
  amount: number;
960
1378
  /**
961
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
962
- * Transaction was completed.
963
- */
964
- completed_at: string | null;
965
- /**
966
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
967
- * Transaction occurred.
1379
+ * The identifier of the Card to be authorized.
968
1380
  */
969
- created_at: string;
1381
+ card_id?: string;
970
1382
  /**
971
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending
972
- * Transaction's currency. This will match the currency on the Pending
973
- * Transaction's Account.
974
- *
975
- * - `CAD` - Canadian Dollar (CAD)
976
- * - `CHF` - Swiss Franc (CHF)
977
- * - `EUR` - Euro (EUR)
978
- * - `GBP` - British Pound (GBP)
979
- * - `JPY` - Japanese Yen (JPY)
980
- * - `USD` - US Dollar (USD)
1383
+ * The identifier of the Digital Wallet Token to be authorized.
981
1384
  */
982
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1385
+ digital_wallet_token_id?: string;
983
1386
  /**
984
- * For a Pending Transaction related to a transfer, this is the description you
985
- * provide. For a Pending Transaction related to a payment, this is the description
986
- * the vendor provides.
1387
+ * The identifier of the Event Subscription to use. If provided, will override the
1388
+ * default real time event subscription. Because you can only create one real time
1389
+ * decision event subscription, you can use this field to route events to any
1390
+ * specified event subscription for testing purposes.
987
1391
  */
988
- description: string;
1392
+ event_subscription_id?: string;
989
1393
  /**
990
- * The identifier for the route this Pending Transaction came through. Routes are
991
- * things like cards and ACH details.
1394
+ * The identifier of the Physical Card to be authorized.
992
1395
  */
993
- route_id: string | null;
994
- /**
995
- * The type of the route this Pending Transaction came through.
996
- *
997
- * - `account_number` - An Account Number.
998
- * - `card` - A Card.
999
- */
1000
- route_type: 'account_number' | 'card' | null;
1001
- /**
1002
- * This is an object giving more details on the network-level event that caused the
1003
- * Pending Transaction. For example, for a card transaction this lists the
1004
- * merchant's industry and location.
1005
- */
1006
- source: PendingTransaction.Source;
1396
+ physical_card_id?: string;
1397
+ }
1398
+ export interface CardSettlementParams {
1007
1399
  /**
1008
- * Whether the Pending Transaction has been confirmed and has an associated
1009
- * Transaction.
1010
- *
1011
- * - `pending` - The Pending Transaction is still awaiting confirmation.
1012
- * - `complete` - The Pending Transaction is confirmed. An associated Transaction
1013
- * exists for this object. The Pending Transaction will no longer count against
1014
- * your balance and can generally be hidden from UIs, etc.
1400
+ * The identifier of the Card to create a settlement on.
1015
1401
  */
1016
- status: 'pending' | 'complete';
1402
+ card_id: string;
1017
1403
  /**
1018
- * A constant representing the object's type. For this resource it will always be
1019
- * `pending_transaction`.
1404
+ * The identifier of the Pending Transaction for the Card Authorization you wish to
1405
+ * settle.
1020
1406
  */
1021
- type: 'pending_transaction';
1022
- }
1023
- namespace PendingTransaction {
1407
+ pending_transaction_id: string;
1024
1408
  /**
1025
- * This is an object giving more details on the network-level event that caused the
1026
- * Pending Transaction. For example, for a card transaction this lists the
1027
- * merchant's industry and location.
1409
+ * The amount to be settled. This defaults to the amount of the Pending Transaction
1410
+ * being settled.
1028
1411
  */
1029
- interface Source {
1030
- /**
1031
- * An Account Transfer Instruction object. This field will be present in the JSON
1032
- * response if and only if `category` is equal to `account_transfer_instruction`.
1033
- */
1034
- account_transfer_instruction: Source.AccountTransferInstruction | null;
1035
- /**
1036
- * An ACH Transfer Instruction object. This field will be present in the JSON
1037
- * response if and only if `category` is equal to `ach_transfer_instruction`.
1038
- */
1039
- ach_transfer_instruction: Source.ACHTransferInstruction | null;
1040
- /**
1041
- * A Card Authorization object. This field will be present in the JSON response if
1042
- * and only if `category` is equal to `card_authorization`.
1043
- */
1044
- card_authorization: Source.CardAuthorization | null;
1045
- /**
1046
- * The type of the resource. We may add additional possible values for this enum
1047
- * over time; your application should be able to handle such additions gracefully.
1048
- *
1049
- * - `account_transfer_instruction` - Account Transfer Instruction: details will be
1050
- * under the `account_transfer_instruction` object.
1051
- * - `ach_transfer_instruction` - ACH Transfer Instruction: details will be under
1052
- * the `ach_transfer_instruction` object.
1053
- * - `card_authorization` - Card Authorization: details will be under the
1054
- * `card_authorization` object.
1055
- * - `check_deposit_instruction` - Check Deposit Instruction: details will be under
1056
- * the `check_deposit_instruction` object.
1057
- * - `check_transfer_instruction` - Check Transfer Instruction: details will be
1058
- * under the `check_transfer_instruction` object.
1059
- * - `inbound_funds_hold` - Inbound Funds Hold: details will be under the
1060
- * `inbound_funds_hold` object.
1061
- * - `real_time_payments_transfer_instruction` - Real-Time Payments Transfer
1062
- * Instruction: details will be under the
1063
- * `real_time_payments_transfer_instruction` object.
1064
- * - `wire_transfer_instruction` - Wire Transfer Instruction: details will be under
1065
- * the `wire_transfer_instruction` object.
1066
- * - `other` - The Pending Transaction was made for an undocumented or deprecated
1067
- * reason.
1068
- */
1069
- category:
1070
- | 'account_transfer_instruction'
1071
- | 'ach_transfer_instruction'
1072
- | 'card_authorization'
1073
- | 'check_deposit_instruction'
1074
- | 'check_transfer_instruction'
1075
- | 'inbound_funds_hold'
1076
- | 'real_time_payments_transfer_instruction'
1077
- | 'wire_transfer_instruction'
1078
- | 'other';
1079
- /**
1080
- * A Check Deposit Instruction object. This field will be present in the JSON
1081
- * response if and only if `category` is equal to `check_deposit_instruction`.
1082
- */
1083
- check_deposit_instruction: Source.CheckDepositInstruction | null;
1084
- /**
1085
- * A Check Transfer Instruction object. This field will be present in the JSON
1086
- * response if and only if `category` is equal to `check_transfer_instruction`.
1087
- */
1088
- check_transfer_instruction: Source.CheckTransferInstruction | null;
1089
- /**
1090
- * An Inbound Funds Hold object. This field will be present in the JSON response if
1091
- * and only if `category` is equal to `inbound_funds_hold`.
1092
- */
1093
- inbound_funds_hold: Source.InboundFundsHold | null;
1094
- /**
1095
- * A Real-Time Payments Transfer Instruction object. This field will be present in
1096
- * the JSON response if and only if `category` is equal to
1097
- * `real_time_payments_transfer_instruction`.
1098
- */
1099
- real_time_payments_transfer_instruction: Source.RealTimePaymentsTransferInstruction | null;
1100
- /**
1101
- * A Wire Transfer Instruction object. This field will be present in the JSON
1102
- * response if and only if `category` is equal to `wire_transfer_instruction`.
1103
- */
1104
- wire_transfer_instruction: Source.WireTransferInstruction | null;
1105
- }
1106
- namespace Source {
1107
- /**
1108
- * An Account Transfer Instruction object. This field will be present in the JSON
1109
- * response if and only if `category` is equal to `account_transfer_instruction`.
1110
- */
1111
- interface AccountTransferInstruction {
1112
- /**
1113
- * The pending amount in the minor unit of the transaction's currency. For dollars,
1114
- * for example, this is cents.
1115
- */
1116
- amount: number;
1117
- /**
1118
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
1119
- * account currency.
1120
- *
1121
- * - `CAD` - Canadian Dollar (CAD)
1122
- * - `CHF` - Swiss Franc (CHF)
1123
- * - `EUR` - Euro (EUR)
1124
- * - `GBP` - British Pound (GBP)
1125
- * - `JPY` - Japanese Yen (JPY)
1126
- * - `USD` - US Dollar (USD)
1127
- */
1128
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1129
- /**
1130
- * The identifier of the Account Transfer that led to this Pending Transaction.
1131
- */
1132
- transfer_id: string;
1133
- }
1134
- /**
1135
- * An ACH Transfer Instruction object. This field will be present in the JSON
1136
- * response if and only if `category` is equal to `ach_transfer_instruction`.
1137
- */
1138
- interface ACHTransferInstruction {
1139
- /**
1140
- * The pending amount in the minor unit of the transaction's currency. For dollars,
1141
- * for example, this is cents.
1142
- */
1143
- amount: number;
1144
- /**
1145
- * The identifier of the ACH Transfer that led to this Pending Transaction.
1146
- */
1147
- transfer_id: string;
1148
- }
1149
- /**
1150
- * A Card Authorization object. This field will be present in the JSON response if
1151
- * and only if `category` is equal to `card_authorization`.
1152
- */
1153
- interface CardAuthorization {
1154
- /**
1155
- * The Card Authorization identifier.
1156
- */
1157
- id: string;
1158
- /**
1159
- * The pending amount in the minor unit of the transaction's currency. For dollars,
1160
- * for example, this is cents.
1161
- */
1162
- amount: number;
1163
- /**
1164
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1165
- * transaction's currency.
1166
- *
1167
- * - `CAD` - Canadian Dollar (CAD)
1168
- * - `CHF` - Swiss Franc (CHF)
1169
- * - `EUR` - Euro (EUR)
1170
- * - `GBP` - British Pound (GBP)
1171
- * - `JPY` - Japanese Yen (JPY)
1172
- * - `USD` - US Dollar (USD)
1173
- */
1174
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1175
- /**
1176
- * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
1177
- * purchase), the identifier of the token that was used.
1178
- */
1179
- digital_wallet_token_id: string | null;
1180
- /**
1181
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
1182
- * will expire and the pending transaction will be released.
1183
- */
1184
- expires_at: string;
1185
- /**
1186
- * The merchant identifier (commonly abbreviated as MID) of the merchant the card
1187
- * is transacting with.
1188
- */
1189
- merchant_acceptor_id: string;
1190
- /**
1191
- * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
1192
- * card is transacting with.
1193
- */
1194
- merchant_category_code: string | null;
1195
- /**
1196
- * The city the merchant resides in.
1197
- */
1198
- merchant_city: string | null;
1199
- /**
1200
- * The country the merchant resides in.
1201
- */
1202
- merchant_country: string | null;
1203
- /**
1204
- * The merchant descriptor of the merchant the card is transacting with.
1205
- */
1206
- merchant_descriptor: string;
1207
- /**
1208
- * Fields specific to the `network`.
1209
- */
1210
- network_details: CardAuthorization.NetworkDetails;
1211
- /**
1212
- * The identifier of the Pending Transaction associated with this Transaction.
1213
- */
1214
- pending_transaction_id: string | null;
1215
- /**
1216
- * If the authorization was made in-person with a physical card, the Physical Card
1217
- * that was used.
1218
- */
1219
- physical_card_id: string | null;
1220
- /**
1221
- * The identifier of the Real-Time Decision sent to approve or decline this
1222
- * transaction.
1223
- */
1224
- real_time_decision_id: string | null;
1225
- /**
1226
- * A constant representing the object's type. For this resource it will always be
1227
- * `card_authorization`.
1228
- */
1229
- type: 'card_authorization';
1230
- }
1231
- namespace CardAuthorization {
1232
- /**
1233
- * Fields specific to the `network`.
1234
- */
1235
- interface NetworkDetails {
1236
- /**
1237
- * The payment network used to process this card authorization.
1238
- *
1239
- * - `visa` - Visa
1240
- */
1241
- category: 'visa';
1242
- /**
1243
- * Fields specific to the `visa` network.
1244
- */
1245
- visa: NetworkDetails.Visa | null;
1246
- }
1247
- namespace NetworkDetails {
1248
- /**
1249
- * Fields specific to the `visa` network.
1250
- */
1251
- interface Visa {
1252
- /**
1253
- * For electronic commerce transactions, this identifies the level of security used
1254
- * in obtaining the customer's payment credential. For mail or telephone order
1255
- * transactions, identifies the type of mail or telephone order.
1256
- *
1257
- * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
1258
- * that the transaction is a mail/phone order purchase, not a recurring
1259
- * transaction or installment payment. For domestic transactions in the US
1260
- * region, this value may also indicate one bill payment transaction in the
1261
- * card-present or card-absent environments.
1262
- * - `recurring` - Recurring transaction: Payment indicator used to indicate a
1263
- * recurring transaction that originates from an acquirer in the US region.
1264
- * - `installment` - Installment payment: Payment indicator used to indicate one
1265
- * purchase of goods or services that is billed to the account in multiple
1266
- * charges over a period of time agreed upon by the cardholder and merchant from
1267
- * transactions that originate from an acquirer in the US region.
1268
- * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
1269
- * indicate that the type of mail/telephone order is unknown.
1270
- * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
1271
- * indicate that the electronic commerce transaction has been authenticated using
1272
- * e.g., 3-D Secure
1273
- * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
1274
- * Non-authenticated security transaction at a 3-D Secure-capable merchant, and
1275
- * merchant attempted to authenticate the cardholder using 3-D Secure: Use to
1276
- * identify an electronic commerce transaction where the merchant attempted to
1277
- * authenticate the cardholder using 3-D Secure, but was unable to complete the
1278
- * authentication because the issuer or cardholder does not participate in the
1279
- * 3-D Secure program.
1280
- * - `non_authenticated_security_transaction` - Non-authenticated security
1281
- * transaction: Use to identify an electronic commerce transaction that uses data
1282
- * encryption for security however , cardholder authentication is not performed
1283
- * using 3-D Secure.
1284
- * - `non_secure_transaction` - Non-secure transaction: Use to identify an
1285
- * electronic commerce transaction that has no data protection.
1286
- */
1287
- electronic_commerce_indicator:
1288
- | 'mail_phone_order'
1289
- | 'recurring'
1290
- | 'installment'
1291
- | 'unknown_mail_phone_order'
1292
- | 'secure_electronic_commerce'
1293
- | 'non_authenticated_security_transaction_at_3ds_capable_merchant'
1294
- | 'non_authenticated_security_transaction'
1295
- | 'non_secure_transaction'
1296
- | null;
1297
- /**
1298
- * The method used to enter the cardholder's primary account number and card
1299
- * expiration date.
1300
- *
1301
- * - `unknown` - Unknown
1302
- * - `manual` - Manual key entry
1303
- * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
1304
- * value
1305
- * - `optical_code` - Optical code
1306
- * - `integrated_circuit_card` - Contact chip card
1307
- * - `contactless` - Contactless read of chip card
1308
- * - `credential_on_file` - Transaction initiated using a credential that has
1309
- * previously been stored on file
1310
- * - `magnetic_stripe` - Magnetic stripe read
1311
- * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
1312
- * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
1313
- * verification value
1314
- */
1315
- point_of_service_entry_mode:
1316
- | 'unknown'
1317
- | 'manual'
1318
- | 'magnetic_stripe_no_cvv'
1319
- | 'optical_code'
1320
- | 'integrated_circuit_card'
1321
- | 'contactless'
1322
- | 'credential_on_file'
1323
- | 'magnetic_stripe'
1324
- | 'contactless_magnetic_stripe'
1325
- | 'integrated_circuit_card_no_cvv'
1326
- | null;
1327
- }
1328
- }
1329
- }
1330
- /**
1331
- * A Check Deposit Instruction object. This field will be present in the JSON
1332
- * response if and only if `category` is equal to `check_deposit_instruction`.
1333
- */
1334
- interface CheckDepositInstruction {
1335
- /**
1336
- * The pending amount in the minor unit of the transaction's currency. For dollars,
1337
- * for example, this is cents.
1338
- */
1339
- amount: number;
1340
- /**
1341
- * The identifier of the File containing the image of the back of the check that
1342
- * was deposited.
1343
- */
1344
- back_image_file_id: string | null;
1345
- /**
1346
- * The identifier of the Check Deposit.
1347
- */
1348
- check_deposit_id: string | null;
1349
- /**
1350
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1351
- * transaction's currency.
1352
- *
1353
- * - `CAD` - Canadian Dollar (CAD)
1354
- * - `CHF` - Swiss Franc (CHF)
1355
- * - `EUR` - Euro (EUR)
1356
- * - `GBP` - British Pound (GBP)
1357
- * - `JPY` - Japanese Yen (JPY)
1358
- * - `USD` - US Dollar (USD)
1359
- */
1360
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1361
- /**
1362
- * The identifier of the File containing the image of the front of the check that
1363
- * was deposited.
1364
- */
1365
- front_image_file_id: string;
1366
- }
1367
- /**
1368
- * A Check Transfer Instruction object. This field will be present in the JSON
1369
- * response if and only if `category` is equal to `check_transfer_instruction`.
1370
- */
1371
- interface CheckTransferInstruction {
1372
- /**
1373
- * The pending amount in the minor unit of the transaction's currency. For dollars,
1374
- * for example, this is cents.
1375
- */
1376
- amount: number;
1377
- /**
1378
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
1379
- * currency.
1380
- *
1381
- * - `CAD` - Canadian Dollar (CAD)
1382
- * - `CHF` - Swiss Franc (CHF)
1383
- * - `EUR` - Euro (EUR)
1384
- * - `GBP` - British Pound (GBP)
1385
- * - `JPY` - Japanese Yen (JPY)
1386
- * - `USD` - US Dollar (USD)
1387
- */
1388
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1389
- /**
1390
- * The identifier of the Check Transfer that led to this Pending Transaction.
1391
- */
1392
- transfer_id: string;
1393
- }
1394
- /**
1395
- * An Inbound Funds Hold object. This field will be present in the JSON response if
1396
- * and only if `category` is equal to `inbound_funds_hold`.
1397
- */
1398
- interface InboundFundsHold {
1399
- /**
1400
- * The Inbound Funds Hold identifier.
1401
- */
1402
- id: string;
1403
- /**
1404
- * The held amount in the minor unit of the account's currency. For dollars, for
1405
- * example, this is cents.
1406
- */
1407
- amount: number;
1408
- /**
1409
- * When the hold will be released automatically. Certain conditions may cause it to
1410
- * be released before this time.
1411
- */
1412
- automatically_releases_at: string;
1413
- /**
1414
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
1415
- * was created.
1416
- */
1417
- created_at: string;
1418
- /**
1419
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
1420
- * currency.
1421
- *
1422
- * - `CAD` - Canadian Dollar (CAD)
1423
- * - `CHF` - Swiss Franc (CHF)
1424
- * - `EUR` - Euro (EUR)
1425
- * - `GBP` - British Pound (GBP)
1426
- * - `JPY` - Japanese Yen (JPY)
1427
- * - `USD` - US Dollar (USD)
1428
- */
1429
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1430
- /**
1431
- * The ID of the Transaction for which funds were held.
1432
- */
1433
- held_transaction_id: string | null;
1434
- /**
1435
- * The ID of the Pending Transaction representing the held funds.
1436
- */
1437
- pending_transaction_id: string | null;
1438
- /**
1439
- * When the hold was released (if it has been released).
1440
- */
1441
- released_at: string | null;
1442
- /**
1443
- * The status of the hold.
1444
- *
1445
- * - `held` - Funds are still being held.
1446
- * - `complete` - Funds have been released.
1447
- */
1448
- status: 'held' | 'complete';
1449
- /**
1450
- * A constant representing the object's type. For this resource it will always be
1451
- * `inbound_funds_hold`.
1452
- */
1453
- type: 'inbound_funds_hold';
1454
- }
1455
- /**
1456
- * A Real-Time Payments Transfer Instruction object. This field will be present in
1457
- * the JSON response if and only if `category` is equal to
1458
- * `real_time_payments_transfer_instruction`.
1459
- */
1460
- interface RealTimePaymentsTransferInstruction {
1461
- /**
1462
- * The pending amount in the minor unit of the transaction's currency. For dollars,
1463
- * for example, this is cents.
1464
- */
1465
- amount: number;
1466
- /**
1467
- * The identifier of the Real-Time Payments Transfer that led to this Pending
1468
- * Transaction.
1469
- */
1470
- transfer_id: string;
1471
- }
1472
- /**
1473
- * A Wire Transfer Instruction object. This field will be present in the JSON
1474
- * response if and only if `category` is equal to `wire_transfer_instruction`.
1475
- */
1476
- interface WireTransferInstruction {
1477
- /**
1478
- * The account number for the destination account.
1479
- */
1480
- account_number: string;
1481
- /**
1482
- * The pending amount in the minor unit of the transaction's currency. For dollars,
1483
- * for example, this is cents.
1484
- */
1485
- amount: number;
1486
- /**
1487
- * The message that will show on the recipient's bank statement.
1488
- */
1489
- message_to_recipient: string;
1490
- /**
1491
- * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
1492
- * destination account.
1493
- */
1494
- routing_number: string;
1495
- /**
1496
- * The identifier of the Wire Transfer that led to this Pending Transaction.
1497
- */
1498
- transfer_id: string;
1499
- }
1500
- }
1501
- }
1502
- }
1503
- export interface CardAuthorizeParams {
1504
- /**
1505
- * The authorization amount in cents.
1506
- */
1507
- amount: number;
1508
- /**
1509
- * The identifier of the Card to be authorized.
1510
- */
1511
- card_id?: string;
1512
- /**
1513
- * The identifier of the Digital Wallet Token to be authorized.
1514
- */
1515
- digital_wallet_token_id?: string;
1516
- /**
1517
- * The identifier of the Event Subscription to use. If provided, will override the
1518
- * default real time event subscription. Because you can only create one real time
1519
- * decision event subscription, you can use this field to route events to any
1520
- * specified event subscription for testing purposes.
1521
- */
1522
- event_subscription_id?: string;
1523
- /**
1524
- * The identifier of the Physical Card to be authorized.
1525
- */
1526
- physical_card_id?: string;
1527
- }
1528
- export interface CardSettlementParams {
1529
- /**
1530
- * The identifier of the Card to create a settlement on.
1531
- */
1532
- card_id: string;
1533
- /**
1534
- * The identifier of the Pending Transaction for the Card Authorization you wish to
1535
- * settle.
1536
- */
1537
- pending_transaction_id: string;
1538
- /**
1539
- * The amount to be settled. This defaults to the amount of the Pending Transaction
1540
- * being settled.
1541
- */
1542
- amount?: number;
1412
+ amount?: number;
1543
1413
  }
1544
1414
  export declare namespace Cards {
1545
- export import CardAuthorizationSimulation = API.CardAuthorizationSimulation;
1546
- export import CardAuthorizeParams = API.CardAuthorizeParams;
1547
- export import CardSettlementParams = API.CardSettlementParams;
1415
+ export import CardAuthorizationSimulation = API.CardAuthorizationSimulation;
1416
+ export import CardAuthorizeParams = API.CardAuthorizeParams;
1417
+ export import CardSettlementParams = API.CardSettlementParams;
1548
1418
  }
1549
- //# sourceMappingURL=cards.d.ts.map
1419
+ //# sourceMappingURL=cards.d.ts.map