increase 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (425) hide show
  1. package/.eslintrc.js +10 -0
  2. package/.prettierrc +6 -0
  3. package/.stats.yml +1 -0
  4. package/LICENSE +201 -0
  5. package/README.md +211 -0
  6. package/api.md +477 -0
  7. package/bin/check-test-server +50 -0
  8. package/build +12 -0
  9. package/check-version.ts +15 -0
  10. package/core.ts +908 -0
  11. package/dist/cjs/check-version.d.ts +1 -0
  12. package/dist/cjs/check-version.js +21 -0
  13. package/dist/cjs/check-version.js.map +1 -0
  14. package/dist/cjs/core.d.ts +262 -0
  15. package/dist/cjs/core.js +978 -0
  16. package/dist/cjs/core.js.map +1 -0
  17. package/dist/cjs/fetch-polyfill.d.ts +5 -0
  18. package/dist/cjs/fetch-polyfill.js +55 -0
  19. package/dist/cjs/fetch-polyfill.js.map +1 -0
  20. package/dist/cjs/index.d.ts +201 -0
  21. package/dist/cjs/index.js +180 -0
  22. package/dist/cjs/index.js.map +1 -0
  23. package/dist/cjs/pagination.d.ts +28 -0
  24. package/dist/cjs/pagination.js +30 -0
  25. package/dist/cjs/pagination.js.map +1 -0
  26. package/dist/cjs/resource.d.ts +11 -0
  27. package/dist/cjs/resource.js +17 -0
  28. package/dist/cjs/resource.js.map +1 -0
  29. package/dist/cjs/resources/account-numbers.d.ts +103 -0
  30. package/dist/cjs/resources/account-numbers.js +37 -0
  31. package/dist/cjs/resources/account-numbers.js.map +1 -0
  32. package/dist/cjs/resources/account-statements.d.ts +99 -0
  33. package/dist/cjs/resources/account-statements.js +25 -0
  34. package/dist/cjs/resources/account-statements.js.map +1 -0
  35. package/dist/cjs/resources/account-transfers.d.ts +189 -0
  36. package/dist/cjs/resources/account-transfers.js +43 -0
  37. package/dist/cjs/resources/account-transfers.js.map +1 -0
  38. package/dist/cjs/resources/accounts.d.ts +133 -0
  39. package/dist/cjs/resources/accounts.js +43 -0
  40. package/dist/cjs/resources/accounts.js.map +1 -0
  41. package/dist/cjs/resources/ach-prenotifications.d.ts +188 -0
  42. package/dist/cjs/resources/ach-prenotifications.js +35 -0
  43. package/dist/cjs/resources/ach-prenotifications.js.map +1 -0
  44. package/dist/cjs/resources/ach-transfers.d.ts +375 -0
  45. package/dist/cjs/resources/ach-transfers.js +43 -0
  46. package/dist/cjs/resources/ach-transfers.js.map +1 -0
  47. package/dist/cjs/resources/card-disputes.d.ts +143 -0
  48. package/dist/cjs/resources/card-disputes.js +31 -0
  49. package/dist/cjs/resources/card-disputes.js.map +1 -0
  50. package/dist/cjs/resources/card-profiles.d.ts +183 -0
  51. package/dist/cjs/resources/card-profiles.js +31 -0
  52. package/dist/cjs/resources/card-profiles.js.map +1 -0
  53. package/dist/cjs/resources/cards.d.ts +316 -0
  54. package/dist/cjs/resources/cards.js +43 -0
  55. package/dist/cjs/resources/cards.js.map +1 -0
  56. package/dist/cjs/resources/check-deposits.d.ts +241 -0
  57. package/dist/cjs/resources/check-deposits.js +31 -0
  58. package/dist/cjs/resources/check-deposits.js.map +1 -0
  59. package/dist/cjs/resources/check-transfers.d.ts +331 -0
  60. package/dist/cjs/resources/check-transfers.js +49 -0
  61. package/dist/cjs/resources/check-transfers.js.map +1 -0
  62. package/dist/cjs/resources/declined-transactions.d.ts +424 -0
  63. package/dist/cjs/resources/declined-transactions.js +29 -0
  64. package/dist/cjs/resources/declined-transactions.js.map +1 -0
  65. package/dist/cjs/resources/digital-wallet-tokens.d.ts +85 -0
  66. package/dist/cjs/resources/digital-wallet-tokens.js +29 -0
  67. package/dist/cjs/resources/digital-wallet-tokens.js.map +1 -0
  68. package/dist/cjs/resources/documents.d.ts +87 -0
  69. package/dist/cjs/resources/documents.js +25 -0
  70. package/dist/cjs/resources/documents.js.map +1 -0
  71. package/dist/cjs/resources/entities/entities.d.ts +1383 -0
  72. package/dist/cjs/resources/entities/entities.js +36 -0
  73. package/dist/cjs/resources/entities/entities.js.map +1 -0
  74. package/dist/cjs/resources/entities/index.d.ts +2 -0
  75. package/dist/cjs/resources/entities/index.js +12 -0
  76. package/dist/cjs/resources/entities/index.js.map +1 -0
  77. package/dist/cjs/resources/entities/supplemental-documents.d.ts +19 -0
  78. package/dist/cjs/resources/entities/supplemental-documents.js +15 -0
  79. package/dist/cjs/resources/entities/supplemental-documents.js.map +1 -0
  80. package/dist/cjs/resources/event-subscriptions.d.ts +196 -0
  81. package/dist/cjs/resources/event-subscriptions.js +37 -0
  82. package/dist/cjs/resources/event-subscriptions.js.map +1 -0
  83. package/dist/cjs/resources/events.d.ts +183 -0
  84. package/dist/cjs/resources/events.js +25 -0
  85. package/dist/cjs/resources/events.js.map +1 -0
  86. package/dist/cjs/resources/external-accounts.d.ts +121 -0
  87. package/dist/cjs/resources/external-accounts.js +37 -0
  88. package/dist/cjs/resources/external-accounts.js.map +1 -0
  89. package/dist/cjs/resources/files.d.ts +148 -0
  90. package/dist/cjs/resources/files.js +34 -0
  91. package/dist/cjs/resources/files.js.map +1 -0
  92. package/dist/cjs/resources/groups.d.ts +37 -0
  93. package/dist/cjs/resources/groups.js +15 -0
  94. package/dist/cjs/resources/groups.js.map +1 -0
  95. package/dist/cjs/resources/inbound-ach-transfer-returns.d.ts +106 -0
  96. package/dist/cjs/resources/inbound-ach-transfer-returns.js +35 -0
  97. package/dist/cjs/resources/inbound-ach-transfer-returns.js.map +1 -0
  98. package/dist/cjs/resources/inbound-wire-drawdown-requests.d.ts +124 -0
  99. package/dist/cjs/resources/inbound-wire-drawdown-requests.js +29 -0
  100. package/dist/cjs/resources/inbound-wire-drawdown-requests.js.map +1 -0
  101. package/dist/cjs/resources/index.d.ts +163 -0
  102. package/dist/cjs/resources/index.js +478 -0
  103. package/dist/cjs/resources/index.js.map +1 -0
  104. package/dist/cjs/resources/limits.d.ts +105 -0
  105. package/dist/cjs/resources/limits.js +37 -0
  106. package/dist/cjs/resources/limits.js.map +1 -0
  107. package/dist/cjs/resources/oauth-connections.d.ts +50 -0
  108. package/dist/cjs/resources/oauth-connections.js +25 -0
  109. package/dist/cjs/resources/oauth-connections.js.map +1 -0
  110. package/dist/cjs/resources/pending-transactions.d.ts +397 -0
  111. package/dist/cjs/resources/pending-transactions.js +29 -0
  112. package/dist/cjs/resources/pending-transactions.js.map +1 -0
  113. package/dist/cjs/resources/real-time-decisions.d.ts +289 -0
  114. package/dist/cjs/resources/real-time-decisions.js +21 -0
  115. package/dist/cjs/resources/real-time-decisions.js.map +1 -0
  116. package/dist/cjs/resources/routing-numbers.d.ts +49 -0
  117. package/dist/cjs/resources/routing-numbers.js +21 -0
  118. package/dist/cjs/resources/routing-numbers.js.map +1 -0
  119. package/dist/cjs/resources/shared.d.ts +15 -0
  120. package/dist/cjs/resources/shared.js +4 -0
  121. package/dist/cjs/resources/shared.js.map +1 -0
  122. package/dist/cjs/resources/simulations/account-statements.d.ts +19 -0
  123. package/dist/cjs/resources/simulations/account-statements.js +16 -0
  124. package/dist/cjs/resources/simulations/account-statements.js.map +1 -0
  125. package/dist/cjs/resources/simulations/account-transfers.d.ts +15 -0
  126. package/dist/cjs/resources/simulations/account-transfers.js +18 -0
  127. package/dist/cjs/resources/simulations/account-transfers.js.map +1 -0
  128. package/dist/cjs/resources/simulations/ach-transfers.d.ts +1488 -0
  129. package/dist/cjs/resources/simulations/ach-transfers.js +39 -0
  130. package/dist/cjs/resources/simulations/ach-transfers.js.map +1 -0
  131. package/dist/cjs/resources/simulations/card-disputes.d.ts +26 -0
  132. package/dist/cjs/resources/simulations/card-disputes.js +18 -0
  133. package/dist/cjs/resources/simulations/card-disputes.js.map +1 -0
  134. package/dist/cjs/resources/simulations/card-refunds.d.ts +20 -0
  135. package/dist/cjs/resources/simulations/card-refunds.js +16 -0
  136. package/dist/cjs/resources/simulations/card-refunds.js.map +1 -0
  137. package/dist/cjs/resources/simulations/cards.d.ts +793 -0
  138. package/dist/cjs/resources/simulations/cards.js +31 -0
  139. package/dist/cjs/resources/simulations/cards.js.map +1 -0
  140. package/dist/cjs/resources/simulations/check-deposits.d.ts +30 -0
  141. package/dist/cjs/resources/simulations/check-deposits.js +31 -0
  142. package/dist/cjs/resources/simulations/check-deposits.js.map +1 -0
  143. package/dist/cjs/resources/simulations/check-transfers.d.ts +22 -0
  144. package/dist/cjs/resources/simulations/check-transfers.js +24 -0
  145. package/dist/cjs/resources/simulations/check-transfers.js.map +1 -0
  146. package/dist/cjs/resources/simulations/digital-wallet-token-requests.d.ts +43 -0
  147. package/dist/cjs/resources/simulations/digital-wallet-token-requests.js +16 -0
  148. package/dist/cjs/resources/simulations/digital-wallet-token-requests.js.map +1 -0
  149. package/dist/cjs/resources/simulations/documents.d.ts +18 -0
  150. package/dist/cjs/resources/simulations/documents.js +15 -0
  151. package/dist/cjs/resources/simulations/documents.js.map +1 -0
  152. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.d.ts +101 -0
  153. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.js +16 -0
  154. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.js.map +1 -0
  155. package/dist/cjs/resources/simulations/index.d.ts +20 -0
  156. package/dist/cjs/resources/simulations/index.js +4 -0
  157. package/dist/cjs/resources/simulations/index.js.map +1 -0
  158. package/dist/cjs/resources/simulations/real-time-payments-transfers.d.ts +1431 -0
  159. package/dist/cjs/resources/simulations/real-time-payments-transfers.js +16 -0
  160. package/dist/cjs/resources/simulations/real-time-payments-transfers.js.map +1 -0
  161. package/dist/cjs/resources/simulations/simulations.d.ts +29 -0
  162. package/dist/cjs/resources/simulations/simulations.js +44 -0
  163. package/dist/cjs/resources/simulations/simulations.js.map +1 -0
  164. package/dist/cjs/resources/simulations/wire-transfers.d.ts +1104 -0
  165. package/dist/cjs/resources/simulations/wire-transfers.js +15 -0
  166. package/dist/cjs/resources/simulations/wire-transfers.js.map +1 -0
  167. package/dist/cjs/resources/transactions.d.ts +1101 -0
  168. package/dist/cjs/resources/transactions.js +25 -0
  169. package/dist/cjs/resources/transactions.js.map +1 -0
  170. package/dist/cjs/resources/wire-drawdown-requests.d.ts +148 -0
  171. package/dist/cjs/resources/wire-drawdown-requests.js +35 -0
  172. package/dist/cjs/resources/wire-drawdown-requests.js.map +1 -0
  173. package/dist/cjs/resources/wire-transfers.d.ts +310 -0
  174. package/dist/cjs/resources/wire-transfers.js +60 -0
  175. package/dist/cjs/resources/wire-transfers.js.map +1 -0
  176. package/dist/cjs/tests/api-resources/account-numbers.test.d.ts +1 -0
  177. package/dist/cjs/tests/api-resources/account-numbers.test.js +104 -0
  178. package/dist/cjs/tests/api-resources/account-numbers.test.js.map +1 -0
  179. package/dist/cjs/tests/api-resources/account-statements.test.d.ts +1 -0
  180. package/dist/cjs/tests/api-resources/account-statements.test.js +101 -0
  181. package/dist/cjs/tests/api-resources/account-statements.test.js.map +1 -0
  182. package/dist/cjs/tests/api-resources/account-transfers.test.d.ts +1 -0
  183. package/dist/cjs/tests/api-resources/account-transfers.test.js +146 -0
  184. package/dist/cjs/tests/api-resources/account-transfers.test.js.map +1 -0
  185. package/dist/cjs/tests/api-resources/accounts.test.d.ts +1 -0
  186. package/dist/cjs/tests/api-resources/accounts.test.js +119 -0
  187. package/dist/cjs/tests/api-resources/accounts.test.js.map +1 -0
  188. package/dist/cjs/tests/api-resources/ach-prenotifications.test.d.ts +1 -0
  189. package/dist/cjs/tests/api-resources/ach-prenotifications.test.js +125 -0
  190. package/dist/cjs/tests/api-resources/ach-prenotifications.test.js.map +1 -0
  191. package/dist/cjs/tests/api-resources/ach-transfers.test.d.ts +1 -0
  192. package/dist/cjs/tests/api-resources/ach-transfers.test.js +159 -0
  193. package/dist/cjs/tests/api-resources/ach-transfers.test.js.map +1 -0
  194. package/dist/cjs/tests/api-resources/card-disputes.test.d.ts +1 -0
  195. package/dist/cjs/tests/api-resources/card-disputes.test.js +108 -0
  196. package/dist/cjs/tests/api-resources/card-disputes.test.js.map +1 -0
  197. package/dist/cjs/tests/api-resources/card-profiles.test.d.ts +1 -0
  198. package/dist/cjs/tests/api-resources/card-profiles.test.js +97 -0
  199. package/dist/cjs/tests/api-resources/card-profiles.test.js.map +1 -0
  200. package/dist/cjs/tests/api-resources/cards.test.d.ts +1 -0
  201. package/dist/cjs/tests/api-resources/cards.test.js +138 -0
  202. package/dist/cjs/tests/api-resources/cards.test.js.map +1 -0
  203. package/dist/cjs/tests/api-resources/check-deposits.test.d.ts +1 -0
  204. package/dist/cjs/tests/api-resources/check-deposits.test.js +113 -0
  205. package/dist/cjs/tests/api-resources/check-deposits.test.js.map +1 -0
  206. package/dist/cjs/tests/api-resources/check-transfers.test.d.ts +1 -0
  207. package/dist/cjs/tests/api-resources/check-transfers.test.js +172 -0
  208. package/dist/cjs/tests/api-resources/check-transfers.test.js.map +1 -0
  209. package/dist/cjs/tests/api-resources/declined-transactions.test.d.ts +1 -0
  210. package/dist/cjs/tests/api-resources/declined-transactions.test.js +105 -0
  211. package/dist/cjs/tests/api-resources/declined-transactions.test.js.map +1 -0
  212. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.d.ts +1 -0
  213. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.js +103 -0
  214. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.js.map +1 -0
  215. package/dist/cjs/tests/api-resources/documents.test.d.ts +1 -0
  216. package/dist/cjs/tests/api-resources/documents.test.js +101 -0
  217. package/dist/cjs/tests/api-resources/documents.test.js.map +1 -0
  218. package/dist/cjs/tests/api-resources/entities/entities.test.d.ts +1 -0
  219. package/dist/cjs/tests/api-resources/entities/entities.test.js +280 -0
  220. package/dist/cjs/tests/api-resources/entities/entities.test.js.map +1 -0
  221. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.d.ts +1 -0
  222. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.js +49 -0
  223. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.js.map +1 -0
  224. package/dist/cjs/tests/api-resources/event-subscriptions.test.d.ts +1 -0
  225. package/dist/cjs/tests/api-resources/event-subscriptions.test.js +109 -0
  226. package/dist/cjs/tests/api-resources/event-subscriptions.test.js.map +1 -0
  227. package/dist/cjs/tests/api-resources/events.test.d.ts +1 -0
  228. package/dist/cjs/tests/api-resources/events.test.js +101 -0
  229. package/dist/cjs/tests/api-resources/events.test.js.map +1 -0
  230. package/dist/cjs/tests/api-resources/external-accounts.test.d.ts +1 -0
  231. package/dist/cjs/tests/api-resources/external-accounts.test.js +113 -0
  232. package/dist/cjs/tests/api-resources/external-accounts.test.js.map +1 -0
  233. package/dist/cjs/tests/api-resources/files.test.d.ts +1 -0
  234. package/dist/cjs/tests/api-resources/files.test.js +117 -0
  235. package/dist/cjs/tests/api-resources/files.test.js.map +1 -0
  236. package/dist/cjs/tests/api-resources/groups.test.d.ts +1 -0
  237. package/dist/cjs/tests/api-resources/groups.test.js +54 -0
  238. package/dist/cjs/tests/api-resources/groups.test.js.map +1 -0
  239. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.d.ts +1 -0
  240. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.js +90 -0
  241. package/dist/cjs/tests/api-resources/inbound-ach-transfer-returns.test.js.map +1 -0
  242. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.d.ts +1 -0
  243. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.js +83 -0
  244. package/dist/cjs/tests/api-resources/inbound-wire-drawdown-requests.test.js.map +1 -0
  245. package/dist/cjs/tests/api-resources/limits.test.d.ts +1 -0
  246. package/dist/cjs/tests/api-resources/limits.test.js +100 -0
  247. package/dist/cjs/tests/api-resources/limits.test.js.map +1 -0
  248. package/dist/cjs/tests/api-resources/oauth-connections.test.d.ts +1 -0
  249. package/dist/cjs/tests/api-resources/oauth-connections.test.js +78 -0
  250. package/dist/cjs/tests/api-resources/oauth-connections.test.js.map +1 -0
  251. package/dist/cjs/tests/api-resources/pending-transactions.test.d.ts +1 -0
  252. package/dist/cjs/tests/api-resources/pending-transactions.test.js +97 -0
  253. package/dist/cjs/tests/api-resources/pending-transactions.test.js.map +1 -0
  254. package/dist/cjs/tests/api-resources/real-time-decisions.test.d.ts +1 -0
  255. package/dist/cjs/tests/api-resources/real-time-decisions.test.js +71 -0
  256. package/dist/cjs/tests/api-resources/real-time-decisions.test.js.map +1 -0
  257. package/dist/cjs/tests/api-resources/routing-numbers.test.d.ts +1 -0
  258. package/dist/cjs/tests/api-resources/routing-numbers.test.js +55 -0
  259. package/dist/cjs/tests/api-resources/routing-numbers.test.js.map +1 -0
  260. package/dist/cjs/tests/api-resources/simulations/account-statements.test.d.ts +1 -0
  261. package/dist/cjs/tests/api-resources/simulations/account-statements.test.js +49 -0
  262. package/dist/cjs/tests/api-resources/simulations/account-statements.test.js.map +1 -0
  263. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.d.ts +1 -0
  264. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.js +60 -0
  265. package/dist/cjs/tests/api-resources/simulations/account-transfers.test.js.map +1 -0
  266. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.d.ts +1 -0
  267. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.js +92 -0
  268. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.js.map +1 -0
  269. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.d.ts +1 -0
  270. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.js +56 -0
  271. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.js.map +1 -0
  272. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.d.ts +1 -0
  273. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.js +49 -0
  274. package/dist/cjs/tests/api-resources/simulations/card-refunds.test.js.map +1 -0
  275. package/dist/cjs/tests/api-resources/simulations/cards.test.d.ts +1 -0
  276. package/dist/cjs/tests/api-resources/simulations/cards.test.js +70 -0
  277. package/dist/cjs/tests/api-resources/simulations/cards.test.js.map +1 -0
  278. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.d.ts +1 -0
  279. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.js +86 -0
  280. package/dist/cjs/tests/api-resources/simulations/check-deposits.test.js.map +1 -0
  281. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.d.ts +1 -0
  282. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.js +73 -0
  283. package/dist/cjs/tests/api-resources/simulations/check-transfers.test.js.map +1 -0
  284. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.d.ts +1 -0
  285. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.js +49 -0
  286. package/dist/cjs/tests/api-resources/simulations/digital-wallet-token-requests.test.js.map +1 -0
  287. package/dist/cjs/tests/api-resources/simulations/documents.test.d.ts +1 -0
  288. package/dist/cjs/tests/api-resources/simulations/documents.test.js +49 -0
  289. package/dist/cjs/tests/api-resources/simulations/documents.test.js.map +1 -0
  290. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.d.ts +1 -0
  291. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.js +81 -0
  292. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.js.map +1 -0
  293. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.d.ts +1 -0
  294. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.js +62 -0
  295. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.js.map +1 -0
  296. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.d.ts +1 -0
  297. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.js +70 -0
  298. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.js.map +1 -0
  299. package/dist/cjs/tests/api-resources/transactions.test.d.ts +1 -0
  300. package/dist/cjs/tests/api-resources/transactions.test.js +109 -0
  301. package/dist/cjs/tests/api-resources/transactions.test.js.map +1 -0
  302. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.d.ts +1 -0
  303. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.js +110 -0
  304. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.js.map +1 -0
  305. package/dist/cjs/tests/api-resources/wire-transfers.test.d.ts +1 -0
  306. package/dist/cjs/tests/api-resources/wire-transfers.test.js +184 -0
  307. package/dist/cjs/tests/api-resources/wire-transfers.test.js.map +1 -0
  308. package/dist/cjs/tests/form.test.d.ts +1 -0
  309. package/dist/cjs/tests/form.test.js +60 -0
  310. package/dist/cjs/tests/form.test.js.map +1 -0
  311. package/dist/cjs/tests/index.test.d.ts +1 -0
  312. package/dist/cjs/tests/index.test.js +44 -0
  313. package/dist/cjs/tests/index.test.js.map +1 -0
  314. package/dist/cjs/tests/responses.test.d.ts +1 -0
  315. package/dist/cjs/tests/responses.test.js +59 -0
  316. package/dist/cjs/tests/responses.test.js.map +1 -0
  317. package/dist/cjs/version.d.ts +1 -0
  318. package/dist/cjs/version.js +5 -0
  319. package/dist/cjs/version.js.map +1 -0
  320. package/fetch-polyfill.ts +69 -0
  321. package/index.ts +276 -0
  322. package/jest.config.js +8 -0
  323. package/package.json +47 -0
  324. package/pagination.ts +58 -0
  325. package/resource.ts +24 -0
  326. package/resources/account-numbers.ts +141 -0
  327. package/resources/account-statements.ts +132 -0
  328. package/resources/account-transfers.ts +244 -0
  329. package/resources/accounts.ts +179 -0
  330. package/resources/ach-prenotifications.ts +242 -0
  331. package/resources/ach-transfers.ts +465 -0
  332. package/resources/card-disputes.ts +187 -0
  333. package/resources/card-profiles.ts +236 -0
  334. package/resources/cards.ts +398 -0
  335. package/resources/check-deposits.ts +303 -0
  336. package/resources/check-transfers.ts +422 -0
  337. package/resources/declined-transactions.ts +547 -0
  338. package/resources/digital-wallet-tokens.ts +115 -0
  339. package/resources/documents.ts +119 -0
  340. package/resources/entities/entities.ts +1668 -0
  341. package/resources/entities/index.ts +4 -0
  342. package/resources/entities/supplemental-documents.ts +25 -0
  343. package/resources/event-subscriptions.ts +232 -0
  344. package/resources/events.ts +215 -0
  345. package/resources/external-accounts.ts +162 -0
  346. package/resources/files.ts +188 -0
  347. package/resources/groups.ts +47 -0
  348. package/resources/inbound-ach-transfer-returns.ts +142 -0
  349. package/resources/inbound-wire-drawdown-requests.ts +168 -0
  350. package/resources/index.ts +165 -0
  351. package/resources/limits.ts +144 -0
  352. package/resources/oauth-connections.ts +74 -0
  353. package/resources/pending-transactions.ts +491 -0
  354. package/resources/real-time-decisions.ts +345 -0
  355. package/resources/routing-numbers.ts +62 -0
  356. package/resources/shared.ts +17 -0
  357. package/resources/simulations/account-statements.ts +25 -0
  358. package/resources/simulations/account-transfers.ts +20 -0
  359. package/resources/simulations/ach-transfers.ts +1873 -0
  360. package/resources/simulations/card-disputes.ts +33 -0
  361. package/resources/simulations/card-refunds.ts +26 -0
  362. package/resources/simulations/cards.ts +979 -0
  363. package/resources/simulations/check-deposits.ts +41 -0
  364. package/resources/simulations/check-transfers.ts +30 -0
  365. package/resources/simulations/digital-wallet-token-requests.ts +52 -0
  366. package/resources/simulations/documents.ts +24 -0
  367. package/resources/simulations/inbound-wire-drawdown-requests.ts +126 -0
  368. package/resources/simulations/index.ts +22 -0
  369. package/resources/simulations/real-time-payments-transfers.ts +1809 -0
  370. package/resources/simulations/simulations.ts +32 -0
  371. package/resources/simulations/wire-transfers.ts +1391 -0
  372. package/resources/transactions.ts +1393 -0
  373. package/resources/wire-drawdown-requests.ts +195 -0
  374. package/resources/wire-transfers.ts +399 -0
  375. package/tests/api-resources/account-numbers.test.ts +67 -0
  376. package/tests/api-resources/account-statements.test.ts +64 -0
  377. package/tests/api-resources/account-transfers.test.ts +109 -0
  378. package/tests/api-resources/accounts.test.ts +82 -0
  379. package/tests/api-resources/ach-prenotifications.test.ts +86 -0
  380. package/tests/api-resources/ach-transfers.test.ts +120 -0
  381. package/tests/api-resources/card-disputes.test.ts +71 -0
  382. package/tests/api-resources/card-profiles.test.ts +60 -0
  383. package/tests/api-resources/cards.test.ts +101 -0
  384. package/tests/api-resources/check-deposits.test.ts +74 -0
  385. package/tests/api-resources/check-transfers.test.ts +135 -0
  386. package/tests/api-resources/declined-transactions.test.ts +68 -0
  387. package/tests/api-resources/digital-wallet-tokens.test.ts +64 -0
  388. package/tests/api-resources/documents.test.ts +64 -0
  389. package/tests/api-resources/entities/entities.test.ts +243 -0
  390. package/tests/api-resources/entities/supplemental-documents.test.ts +12 -0
  391. package/tests/api-resources/event-subscriptions.test.ts +69 -0
  392. package/tests/api-resources/events.test.ts +64 -0
  393. package/tests/api-resources/external-accounts.test.ts +76 -0
  394. package/tests/api-resources/files.test.ts +81 -0
  395. package/tests/api-resources/groups.test.ts +17 -0
  396. package/tests/api-resources/inbound-ach-transfer-returns.test.ts +53 -0
  397. package/tests/api-resources/inbound-wire-drawdown-requests.test.ts +46 -0
  398. package/tests/api-resources/limits.test.ts +63 -0
  399. package/tests/api-resources/oauth-connections.test.ts +41 -0
  400. package/tests/api-resources/pending-transactions.test.ts +58 -0
  401. package/tests/api-resources/real-time-decisions.test.ts +34 -0
  402. package/tests/api-resources/routing-numbers.test.ts +18 -0
  403. package/tests/api-resources/simulations/account-statements.test.ts +12 -0
  404. package/tests/api-resources/simulations/account-transfers.test.ts +23 -0
  405. package/tests/api-resources/simulations/ach-transfers.test.ts +52 -0
  406. package/tests/api-resources/simulations/card-disputes.test.ts +19 -0
  407. package/tests/api-resources/simulations/card-refunds.test.ts +12 -0
  408. package/tests/api-resources/simulations/cards.test.ts +33 -0
  409. package/tests/api-resources/simulations/check-deposits.test.ts +49 -0
  410. package/tests/api-resources/simulations/check-transfers.test.ts +34 -0
  411. package/tests/api-resources/simulations/digital-wallet-token-requests.test.ts +12 -0
  412. package/tests/api-resources/simulations/documents.test.ts +12 -0
  413. package/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.ts +44 -0
  414. package/tests/api-resources/simulations/real-time-payments-transfers.test.ts +25 -0
  415. package/tests/api-resources/simulations/wire-transfers.test.ts +33 -0
  416. package/tests/api-resources/transactions.test.ts +70 -0
  417. package/tests/api-resources/wire-drawdown-requests.test.ts +73 -0
  418. package/tests/api-resources/wire-transfers.test.ts +147 -0
  419. package/tests/form.test.ts +27 -0
  420. package/tests/index.test.ts +47 -0
  421. package/tests/responses.test.ts +25 -0
  422. package/tsconfig.cjs.json +8 -0
  423. package/tsconfig.json +37 -0
  424. package/typings/digest-fetch/index.d.ts +33 -0
  425. package/version.ts +1 -0
@@ -0,0 +1,793 @@
1
+ import * as Core from '../../core';
2
+ import { APIResource } from '../../resource';
3
+ import * as Transactions from '../../resources/transactions';
4
+ import * as Shared from '../../resources/shared';
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
+ ): Promise<Core.APIResponse<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
+ ): Promise<Core.APIResponse<Transactions.Transaction>>;
30
+ }
31
+ /**
32
+ * The results of a Card Authorization simulation.
33
+ */
34
+ 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
+ interface PendingTransaction {
55
+ /**
56
+ * The identifier for the account this Pending Transaction belongs to.
57
+ */
58
+ account_id: string;
59
+ /**
60
+ * The Pending Transaction amount in the minor unit of its currency. For dollars,
61
+ * for example, this is cents.
62
+ */
63
+ amount: number;
64
+ /**
65
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
66
+ * Transaction occured.
67
+ */
68
+ created_at: string;
69
+ /**
70
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending
71
+ * Transaction's currency. This will match the currency on the Pending
72
+ * Transcation's Account.
73
+ */
74
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
75
+ /**
76
+ * For a Pending Transaction related to a transfer, this is the description you
77
+ * provide. For a Pending Transaction related to a payment, this is the description
78
+ * the vendor provides.
79
+ */
80
+ description: string;
81
+ /**
82
+ * The Pending Transaction identifier.
83
+ */
84
+ id: string;
85
+ /**
86
+ * The identifier for the route this Pending Transaction came through. Routes are
87
+ * things like cards and ACH details.
88
+ */
89
+ route_id: string | null;
90
+ /**
91
+ * The type of the route this Pending Transaction came through.
92
+ */
93
+ route_type: string | null;
94
+ /**
95
+ * This is an object giving more details on the network-level event that caused the
96
+ * Pending Transaction. For example, for a card transaction this lists the
97
+ * merchant's industry and location.
98
+ */
99
+ source: PendingTransaction.Source;
100
+ /**
101
+ * Whether the Pending Transaction has been confirmed and has an associated
102
+ * Transaction.
103
+ */
104
+ status: 'pending' | 'complete';
105
+ /**
106
+ * A constant representing the object's type. For this resource it will always be
107
+ * `pending_transaction`.
108
+ */
109
+ type: 'pending_transaction';
110
+ }
111
+ namespace PendingTransaction {
112
+ interface Source {
113
+ /**
114
+ * A Account Transfer Instruction object. This field will be present in the JSON
115
+ * response if and only if `category` is equal to `account_transfer_instruction`.
116
+ */
117
+ account_transfer_instruction: Source.AccountTransferInstruction | null;
118
+ /**
119
+ * A ACH Transfer Instruction object. This field will be present in the JSON
120
+ * response if and only if `category` is equal to `ach_transfer_instruction`.
121
+ */
122
+ ach_transfer_instruction: Source.ACHTransferInstruction | null;
123
+ /**
124
+ * A Card Authorization object. This field will be present in the JSON response if
125
+ * and only if `category` is equal to `card_authorization`.
126
+ */
127
+ card_authorization: Source.CardAuthorization | null;
128
+ /**
129
+ * A Deprecated Card Authorization object. This field will be present in the JSON
130
+ * response if and only if `category` is equal to `card_route_authorization`.
131
+ */
132
+ card_route_authorization: Source.CardRouteAuthorization | null;
133
+ /**
134
+ * The type of transaction that took place. We may add additional possible values
135
+ * for this enum over time; your application should be able to handle such
136
+ * additions gracefully.
137
+ */
138
+ category:
139
+ | 'account_transfer_instruction'
140
+ | 'ach_transfer_instruction'
141
+ | 'card_authorization'
142
+ | 'check_deposit_instruction'
143
+ | 'check_transfer_instruction'
144
+ | 'inbound_funds_hold'
145
+ | 'card_route_authorization'
146
+ | 'real_time_payments_transfer_instruction'
147
+ | 'wire_drawdown_payment_instruction'
148
+ | 'wire_transfer_instruction'
149
+ | 'other';
150
+ /**
151
+ * A Check Deposit Instruction object. This field will be present in the JSON
152
+ * response if and only if `category` is equal to `check_deposit_instruction`.
153
+ */
154
+ check_deposit_instruction: Source.CheckDepositInstruction | null;
155
+ /**
156
+ * A Check Transfer Instruction object. This field will be present in the JSON
157
+ * response if and only if `category` is equal to `check_transfer_instruction`.
158
+ */
159
+ check_transfer_instruction: Source.CheckTransferInstruction | null;
160
+ /**
161
+ * A Inbound Funds Hold object. This field will be present in the JSON response if
162
+ * and only if `category` is equal to `inbound_funds_hold`.
163
+ */
164
+ inbound_funds_hold: Source.InboundFundsHold | null;
165
+ /**
166
+ * A Wire Drawdown Payment Instruction object. This field will be present in the
167
+ * JSON response if and only if `category` is equal to
168
+ * `wire_drawdown_payment_instruction`.
169
+ */
170
+ wire_drawdown_payment_instruction: Source.WireDrawdownPaymentInstruction | null;
171
+ /**
172
+ * A Wire Transfer Instruction object. This field will be present in the JSON
173
+ * response if and only if `category` is equal to `wire_transfer_instruction`.
174
+ */
175
+ wire_transfer_instruction: Source.WireTransferInstruction | null;
176
+ }
177
+ namespace Source {
178
+ interface AccountTransferInstruction {
179
+ /**
180
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
181
+ * for example, this is cents.
182
+ */
183
+ amount: number;
184
+ /**
185
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
186
+ * account currency.
187
+ */
188
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
189
+ /**
190
+ * The identifier of the Account Transfer that led to this Pending Transaction.
191
+ */
192
+ transfer_id: string;
193
+ }
194
+ interface ACHTransferInstruction {
195
+ /**
196
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
197
+ * for example, this is cents.
198
+ */
199
+ amount: number;
200
+ /**
201
+ * The identifier of the ACH Transfer that led to this Pending Transaction.
202
+ */
203
+ transfer_id: string;
204
+ }
205
+ interface CardAuthorization {
206
+ /**
207
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
208
+ * for example, this is cents.
209
+ */
210
+ amount: number;
211
+ /**
212
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
213
+ * transaction's currency.
214
+ */
215
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
216
+ /**
217
+ * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
218
+ * purchase), the identifier of the token that was used.
219
+ */
220
+ digital_wallet_token_id: string | null;
221
+ /**
222
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
223
+ * is transacting with.
224
+ */
225
+ merchant_acceptor_id: string;
226
+ /**
227
+ * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
228
+ * card is transacting with.
229
+ */
230
+ merchant_category_code: string | null;
231
+ /**
232
+ * The city the merchant resides in.
233
+ */
234
+ merchant_city: string | null;
235
+ /**
236
+ * The country the merchant resides in.
237
+ */
238
+ merchant_country: string | null;
239
+ /**
240
+ * The merchant descriptor of the merchant the card is transacting with.
241
+ */
242
+ merchant_descriptor: string;
243
+ /**
244
+ * The payment network used to process this card authorization
245
+ */
246
+ network: 'visa';
247
+ /**
248
+ * Fields specific to the `network`
249
+ */
250
+ network_details: CardAuthorization.NetworkDetails;
251
+ /**
252
+ * The identifier of the Real-Time Decision sent to approve or decline this
253
+ * transaction.
254
+ */
255
+ real_time_decision_id: string | null;
256
+ }
257
+ namespace CardAuthorization {
258
+ interface NetworkDetails {
259
+ /**
260
+ * Fields specific to the `visa` network
261
+ */
262
+ visa: NetworkDetails.Visa;
263
+ }
264
+ namespace NetworkDetails {
265
+ interface Visa {
266
+ /**
267
+ * For electronic commerce transactions, this identifies the level of security used
268
+ * in obtaining the customer's payment credential. For mail or telephone order
269
+ * transactions, identifies the type of mail or telephone order.
270
+ */
271
+ electronic_commerce_indicator:
272
+ | 'mail_phone_order'
273
+ | 'recurring'
274
+ | 'installment'
275
+ | 'unknown_mail_phone_order'
276
+ | 'secure_electronic_commerce'
277
+ | 'non_authenticated_security_transaction_at_3ds_capable_merchant'
278
+ | 'non_authenticated_security_transaction'
279
+ | 'non_secure_transaction'
280
+ | null;
281
+ /**
282
+ * The method used to enter the cardholder's primary account number and card
283
+ * expiration date
284
+ */
285
+ point_of_service_entry_mode: Shared.PointOfServiceEntryMode;
286
+ }
287
+ }
288
+ }
289
+ interface CheckDepositInstruction {
290
+ /**
291
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
292
+ * for example, this is cents.
293
+ */
294
+ amount: number;
295
+ /**
296
+ * The identifier of the File containing the image of the back of the check that
297
+ * was deposited.
298
+ */
299
+ back_image_file_id: string | null;
300
+ /**
301
+ * The identifier of the Check Deposit.
302
+ */
303
+ check_deposit_id: string | null;
304
+ /**
305
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
306
+ * transaction's currency.
307
+ */
308
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
309
+ /**
310
+ * The identifier of the File containing the image of the front of the check that
311
+ * was deposited.
312
+ */
313
+ front_image_file_id: string;
314
+ }
315
+ interface CheckTransferInstruction {
316
+ /**
317
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
318
+ * for example, this is cents.
319
+ */
320
+ amount: number;
321
+ /**
322
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
323
+ * currency.
324
+ */
325
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
326
+ /**
327
+ * The identifier of the Check Transfer that led to this Pending Transaction.
328
+ */
329
+ transfer_id: string;
330
+ }
331
+ interface InboundFundsHold {
332
+ /**
333
+ * The held amount in the minor unit of the account's currency. For dollars, for
334
+ * example, this is cents.
335
+ */
336
+ amount: number;
337
+ /**
338
+ * When the hold will be released automatically. Certain conditions may cause it to
339
+ * be released before this time.
340
+ */
341
+ automatically_releases_at: string;
342
+ /**
343
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
344
+ * currency.
345
+ */
346
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
347
+ /**
348
+ * The ID of the Transaction for which funds were held.
349
+ */
350
+ held_transaction_id: string | null;
351
+ /**
352
+ * When the hold was released (if it has been released).
353
+ */
354
+ released_at: string | null;
355
+ /**
356
+ * The status of the hold.
357
+ */
358
+ status: 'held' | 'complete';
359
+ }
360
+ interface CardRouteAuthorization {
361
+ /**
362
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
363
+ * for example, this is cents.
364
+ */
365
+ amount: number;
366
+ /**
367
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
368
+ * transaction's currency.
369
+ */
370
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
371
+ merchant_acceptor_id: string;
372
+ merchant_category_code: string;
373
+ merchant_city: string | null;
374
+ merchant_country: string;
375
+ merchant_descriptor: string;
376
+ merchant_state: string | null;
377
+ }
378
+ interface WireDrawdownPaymentInstruction {
379
+ account_number: string;
380
+ /**
381
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
382
+ * for example, this is cents.
383
+ */
384
+ amount: number;
385
+ message_to_recipient: string;
386
+ routing_number: string;
387
+ }
388
+ interface WireTransferInstruction {
389
+ account_number: string;
390
+ /**
391
+ * The pending amount in the minor unit of the transaction's currency. For dollars,
392
+ * for example, this is cents.
393
+ */
394
+ amount: number;
395
+ message_to_recipient: string;
396
+ routing_number: string;
397
+ transfer_id: string;
398
+ }
399
+ }
400
+ }
401
+ interface DeclinedTransaction {
402
+ /**
403
+ * The identifier for the Account the Declined Transaction belongs to.
404
+ */
405
+ account_id: string;
406
+ /**
407
+ * The Declined Transaction amount in the minor unit of its currency. For dollars,
408
+ * for example, this is cents.
409
+ */
410
+ amount: number;
411
+ /**
412
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
413
+ * Transaction occured.
414
+ */
415
+ created_at: string;
416
+ /**
417
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
418
+ * Transaction's currency. This will match the currency on the Declined
419
+ * Transcation's Account.
420
+ */
421
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
422
+ /**
423
+ * This is the description the vendor provides.
424
+ */
425
+ description: string;
426
+ /**
427
+ * The Declined Transaction identifier.
428
+ */
429
+ id: string;
430
+ /**
431
+ * The identifier for the route this Declined Transaction came through. Routes are
432
+ * things like cards and ACH details.
433
+ */
434
+ route_id: string | null;
435
+ /**
436
+ * The type of the route this Declined Transaction came through.
437
+ */
438
+ route_type: string | null;
439
+ /**
440
+ * This is an object giving more details on the network-level event that caused the
441
+ * Declined Transaction. For example, for a card transaction this lists the
442
+ * merchant's industry and location. Note that for backwards compatibility reasons,
443
+ * additional undocumented keys may appear in this object. These should be treated
444
+ * as deprecated and will be removed in the future.
445
+ */
446
+ source: DeclinedTransaction.Source;
447
+ /**
448
+ * A constant representing the object's type. For this resource it will always be
449
+ * `declined_transaction`.
450
+ */
451
+ type: 'declined_transaction';
452
+ }
453
+ namespace DeclinedTransaction {
454
+ interface Source {
455
+ /**
456
+ * A ACH Decline object. This field will be present in the JSON response if and
457
+ * only if `category` is equal to `ach_decline`.
458
+ */
459
+ ach_decline: Source.ACHDecline | null;
460
+ /**
461
+ * A Card Decline object. This field will be present in the JSON response if and
462
+ * only if `category` is equal to `card_decline`.
463
+ */
464
+ card_decline: Source.CardDecline | null;
465
+ /**
466
+ * A Deprecated Card Decline object. This field will be present in the JSON
467
+ * response if and only if `category` is equal to `card_route_decline`.
468
+ */
469
+ card_route_decline: Source.CardRouteDecline | null;
470
+ /**
471
+ * The type of decline that took place. We may add additional possible values for
472
+ * this enum over time; your application should be able to handle such additions
473
+ * gracefully.
474
+ */
475
+ category:
476
+ | 'ach_decline'
477
+ | 'card_decline'
478
+ | 'check_decline'
479
+ | 'inbound_real_time_payments_transfer_decline'
480
+ | 'international_ach_decline'
481
+ | 'card_route_decline'
482
+ | 'other';
483
+ /**
484
+ * A Check Decline object. This field will be present in the JSON response if and
485
+ * only if `category` is equal to `check_decline`.
486
+ */
487
+ check_decline: Source.CheckDecline | null;
488
+ /**
489
+ * A Inbound Real Time Payments Transfer Decline object. This field will be present
490
+ * in the JSON response if and only if `category` is equal to
491
+ * `inbound_real_time_payments_transfer_decline`.
492
+ */
493
+ inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
494
+ /**
495
+ * A International ACH Decline object. This field will be present in the JSON
496
+ * response if and only if `category` is equal to `international_ach_decline`.
497
+ */
498
+ international_ach_decline: Source.InternationalACHDecline | null;
499
+ }
500
+ namespace Source {
501
+ interface ACHDecline {
502
+ /**
503
+ * The declined amount in the minor unit of the destination account currency. For
504
+ * dollars, for example, this is cents.
505
+ */
506
+ amount: number;
507
+ originator_company_descriptive_date: string | null;
508
+ originator_company_discretionary_data: string | null;
509
+ originator_company_id: string;
510
+ originator_company_name: string;
511
+ /**
512
+ * Why the ACH transfer was declined.
513
+ */
514
+ reason:
515
+ | 'ach_route_canceled'
516
+ | 'ach_route_disabled'
517
+ | 'breaches_limit'
518
+ | 'credit_entry_refused_by_receiver'
519
+ | 'duplicate_return'
520
+ | 'entity_not_active'
521
+ | 'transaction_not_allowed'
522
+ | 'group_locked'
523
+ | 'insufficient_funds'
524
+ | 'no_ach_route'
525
+ | 'originator_request';
526
+ receiver_id_number: string | null;
527
+ receiver_name: string | null;
528
+ trace_number: string;
529
+ }
530
+ interface CardDecline {
531
+ /**
532
+ * The declined amount in the minor unit of the destination account currency. For
533
+ * dollars, for example, this is cents.
534
+ */
535
+ amount: number;
536
+ /**
537
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
538
+ * account currency.
539
+ */
540
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
541
+ /**
542
+ * If the authorization was attempted using a Digital Wallet Token (such as an
543
+ * Apple Pay purchase), the identifier of the token that was used.
544
+ */
545
+ digital_wallet_token_id: string | null;
546
+ /**
547
+ * The merchant identifier (commonly abbreviated as MID) of the merchant the card
548
+ * is transacting with.
549
+ */
550
+ merchant_acceptor_id: string;
551
+ /**
552
+ * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
553
+ * card is transacting with.
554
+ */
555
+ merchant_category_code: string | null;
556
+ /**
557
+ * The city the merchant resides in.
558
+ */
559
+ merchant_city: string | null;
560
+ /**
561
+ * The country the merchant resides in.
562
+ */
563
+ merchant_country: string | null;
564
+ /**
565
+ * The merchant descriptor of the merchant the card is transacting with.
566
+ */
567
+ merchant_descriptor: string;
568
+ /**
569
+ * The state the merchant resides in.
570
+ */
571
+ merchant_state: string | null;
572
+ /**
573
+ * The payment network used to process this card authorization
574
+ */
575
+ network: 'visa';
576
+ /**
577
+ * Fields specific to the `network`
578
+ */
579
+ network_details: CardDecline.NetworkDetails;
580
+ /**
581
+ * The identifier of the Real-Time Decision sent to approve or decline this
582
+ * transaction.
583
+ */
584
+ real_time_decision_id: string | null;
585
+ /**
586
+ * Why the transaction was declined.
587
+ */
588
+ reason:
589
+ | 'card_not_active'
590
+ | 'entity_not_active'
591
+ | 'group_locked'
592
+ | 'insufficient_funds'
593
+ | 'cvv2_mismatch'
594
+ | 'transaction_not_allowed'
595
+ | 'breaches_limit'
596
+ | 'webhook_declined'
597
+ | 'webhook_timed_out'
598
+ | 'declined_by_stand_in_processing';
599
+ }
600
+ namespace CardDecline {
601
+ interface NetworkDetails {
602
+ /**
603
+ * Fields specific to the `visa` network
604
+ */
605
+ visa: NetworkDetails.Visa;
606
+ }
607
+ namespace NetworkDetails {
608
+ interface Visa {
609
+ /**
610
+ * For electronic commerce transactions, this identifies the level of security used
611
+ * in obtaining the customer's payment credential. For mail or telephone order
612
+ * transactions, identifies the type of mail or telephone order.
613
+ */
614
+ electronic_commerce_indicator:
615
+ | 'mail_phone_order'
616
+ | 'recurring'
617
+ | 'installment'
618
+ | 'unknown_mail_phone_order'
619
+ | 'secure_electronic_commerce'
620
+ | 'non_authenticated_security_transaction_at_3ds_capable_merchant'
621
+ | 'non_authenticated_security_transaction'
622
+ | 'non_secure_transaction'
623
+ | null;
624
+ /**
625
+ * The method used to enter the cardholder's primary account number and card
626
+ * expiration date
627
+ */
628
+ point_of_service_entry_mode: Shared.PointOfServiceEntryMode;
629
+ }
630
+ }
631
+ }
632
+ interface CheckDecline {
633
+ /**
634
+ * The declined amount in the minor unit of the destination account currency. For
635
+ * dollars, for example, this is cents.
636
+ */
637
+ amount: number;
638
+ auxiliary_on_us: string | null;
639
+ /**
640
+ * Why the check was declined.
641
+ */
642
+ reason:
643
+ | 'ach_route_canceled'
644
+ | 'ach_route_disabled'
645
+ | 'breaches_limit'
646
+ | 'entity_not_active'
647
+ | 'group_locked'
648
+ | 'insufficient_funds'
649
+ | 'unable_to_locate_account'
650
+ | 'unable_to_process'
651
+ | 'refer_to_image'
652
+ | 'stop_payment_requested'
653
+ | 'returned';
654
+ }
655
+ interface InboundRealTimePaymentsTransferDecline {
656
+ /**
657
+ * The declined amount in the minor unit of the destination account currency. For
658
+ * dollars, for example, this is cents.
659
+ */
660
+ amount: number;
661
+ /**
662
+ * The name the sender of the transfer specified as the recipient of the transfer.
663
+ */
664
+ creditor_name: string;
665
+ /**
666
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
667
+ * transfer's currency. This will always be "USD" for a Real Time Payments
668
+ * transfer.
669
+ */
670
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
671
+ /**
672
+ * The account number of the account that sent the transfer.
673
+ */
674
+ debtor_account_number: string;
675
+ /**
676
+ * The name provided by the sender of the transfer.
677
+ */
678
+ debtor_name: string;
679
+ /**
680
+ * The routing number of the account that sent the transfer.
681
+ */
682
+ debtor_routing_number: string;
683
+ /**
684
+ * Why the transfer was declined.
685
+ */
686
+ reason:
687
+ | 'account_number_canceled'
688
+ | 'account_number_disabled'
689
+ | 'group_locked'
690
+ | 'entity_not_active'
691
+ | 'real_time_payments_not_enabled';
692
+ /**
693
+ * Additional information included with the transfer.
694
+ */
695
+ remittance_information: string | null;
696
+ /**
697
+ * The Real Time Payments network identification of the declined transfer.
698
+ */
699
+ transaction_identification: string;
700
+ }
701
+ interface InternationalACHDecline {
702
+ /**
703
+ * The declined amount in the minor unit of the destination account currency. For
704
+ * dollars, for example, this is cents.
705
+ */
706
+ amount: number;
707
+ destination_country_code: string;
708
+ destination_currency_code: string;
709
+ foreign_exchange_indicator: string;
710
+ foreign_exchange_reference: string | null;
711
+ foreign_exchange_reference_indicator: string;
712
+ foreign_payment_amount: number;
713
+ foreign_trace_number: string | null;
714
+ international_transaction_type_code: string;
715
+ originating_currency_code: string;
716
+ originating_depository_financial_institution_branch_country: string;
717
+ originating_depository_financial_institution_id: string;
718
+ originating_depository_financial_institution_id_qualifier: string;
719
+ originating_depository_financial_institution_name: string;
720
+ originator_city: string;
721
+ originator_company_entry_description: string;
722
+ originator_country: string;
723
+ originator_identification: string;
724
+ originator_name: string;
725
+ originator_postal_code: string | null;
726
+ originator_state_or_province: string | null;
727
+ originator_street_address: string;
728
+ payment_related_information: string | null;
729
+ payment_related_information2: string | null;
730
+ receiver_city: string;
731
+ receiver_country: string;
732
+ receiver_identification_number: string | null;
733
+ receiver_postal_code: string | null;
734
+ receiver_state_or_province: string | null;
735
+ receiver_street_address: string;
736
+ receiving_company_or_individual_name: string;
737
+ receiving_depository_financial_institution_country: string;
738
+ receiving_depository_financial_institution_id: string;
739
+ receiving_depository_financial_institution_id_qualifier: string;
740
+ receiving_depository_financial_institution_name: string;
741
+ trace_number: string;
742
+ }
743
+ interface CardRouteDecline {
744
+ /**
745
+ * The declined amount in the minor unit of the destination account currency. For
746
+ * dollars, for example, this is cents.
747
+ */
748
+ amount: number;
749
+ /**
750
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
751
+ * account currency.
752
+ */
753
+ currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
754
+ merchant_acceptor_id: string;
755
+ merchant_category_code: string | null;
756
+ merchant_city: string | null;
757
+ merchant_country: string;
758
+ merchant_descriptor: string;
759
+ merchant_state: string | null;
760
+ }
761
+ }
762
+ }
763
+ }
764
+ export interface CardAuthorizeParams {
765
+ /**
766
+ * The authorization amount in cents.
767
+ */
768
+ amount: number;
769
+ /**
770
+ * The identifier of the Card to be authorized.
771
+ */
772
+ card_id?: string;
773
+ /**
774
+ * The identifier of the Digital Wallet Token to be authorized.
775
+ */
776
+ digital_wallet_token_id?: string;
777
+ }
778
+ export interface CardSettlementParams {
779
+ /**
780
+ * The identifier of the Card to create a settlement on.
781
+ */
782
+ card_id: string;
783
+ /**
784
+ * The identifier of the Pending Transaction for the Card Authorization you wish to
785
+ * settle.
786
+ */
787
+ pending_transaction_id: string;
788
+ /**
789
+ * The amount to be settled. This defaults to the amount of the Pending Transaction
790
+ * being settled.
791
+ */
792
+ amount?: number;
793
+ }