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