increase 0.3.0 → 0.4.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 (286) hide show
  1. package/.release-please-manifest.json +1 -1
  2. package/.stats.yml +1 -1
  3. package/CHANGELOG.md +46 -0
  4. package/README.md +3 -4
  5. package/api.md +11 -0
  6. package/core.ts +4 -140
  7. package/dist/cjs/core.d.ts +3 -53
  8. package/dist/cjs/core.d.ts.map +1 -1
  9. package/dist/cjs/core.js +12 -179
  10. package/dist/cjs/core.js.map +1 -1
  11. package/dist/cjs/error.d.ts +72 -27
  12. package/dist/cjs/error.d.ts.map +1 -1
  13. package/dist/cjs/error.js +176 -54
  14. package/dist/cjs/error.js.map +1 -1
  15. package/dist/cjs/index.d.ts +25 -28
  16. package/dist/cjs/index.d.ts.map +1 -1
  17. package/dist/cjs/index.js +30 -77
  18. package/dist/cjs/index.js.map +1 -1
  19. package/dist/cjs/resources/account-numbers.d.ts +1 -20
  20. package/dist/cjs/resources/account-numbers.d.ts.map +1 -1
  21. package/dist/cjs/resources/account-statements.d.ts +1 -20
  22. package/dist/cjs/resources/account-statements.d.ts.map +1 -1
  23. package/dist/cjs/resources/account-transfers.d.ts +1 -20
  24. package/dist/cjs/resources/account-transfers.d.ts.map +1 -1
  25. package/dist/cjs/resources/accounts.d.ts +17 -25
  26. package/dist/cjs/resources/accounts.d.ts.map +1 -1
  27. package/dist/cjs/resources/ach-prenotifications.d.ts +6 -25
  28. package/dist/cjs/resources/ach-prenotifications.d.ts.map +1 -1
  29. package/dist/cjs/resources/ach-transfers.d.ts +70 -37
  30. package/dist/cjs/resources/ach-transfers.d.ts.map +1 -1
  31. package/dist/cjs/resources/bookkeeping-accounts.d.ts +4 -4
  32. package/dist/cjs/resources/bookkeeping-accounts.d.ts.map +1 -1
  33. package/dist/cjs/resources/bookkeeping-entry-sets.d.ts +4 -16
  34. package/dist/cjs/resources/bookkeeping-entry-sets.d.ts.map +1 -1
  35. package/dist/cjs/resources/card-disputes.d.ts +2 -26
  36. package/dist/cjs/resources/card-disputes.d.ts.map +1 -1
  37. package/dist/cjs/resources/card-profiles.d.ts +1 -63
  38. package/dist/cjs/resources/card-profiles.d.ts.map +1 -1
  39. package/dist/cjs/resources/cards.d.ts +1 -116
  40. package/dist/cjs/resources/cards.d.ts.map +1 -1
  41. package/dist/cjs/resources/check-deposits.d.ts +3 -21
  42. package/dist/cjs/resources/check-deposits.d.ts.map +1 -1
  43. package/dist/cjs/resources/check-transfers.d.ts +10 -58
  44. package/dist/cjs/resources/check-transfers.d.ts.map +1 -1
  45. package/dist/cjs/resources/declined-transactions.d.ts +2 -48
  46. package/dist/cjs/resources/declined-transactions.d.ts.map +1 -1
  47. package/dist/cjs/resources/digital-wallet-tokens.d.ts +1 -20
  48. package/dist/cjs/resources/digital-wallet-tokens.d.ts.map +1 -1
  49. package/dist/cjs/resources/documents.d.ts +2 -76
  50. package/dist/cjs/resources/documents.d.ts.map +1 -1
  51. package/dist/cjs/resources/entities/entities.d.ts +81 -1021
  52. package/dist/cjs/resources/entities/entities.d.ts.map +1 -1
  53. package/dist/cjs/resources/entities/index.d.ts +6 -1
  54. package/dist/cjs/resources/entities/index.d.ts.map +1 -1
  55. package/dist/cjs/resources/entities/index.js +8 -1
  56. package/dist/cjs/resources/entities/index.js.map +1 -1
  57. package/dist/cjs/resources/entities/supplemental-documents.d.ts +35 -0
  58. package/dist/cjs/resources/entities/supplemental-documents.d.ts.map +1 -1
  59. package/dist/cjs/resources/entities/supplemental-documents.js +14 -1
  60. package/dist/cjs/resources/entities/supplemental-documents.js.map +1 -1
  61. package/dist/cjs/resources/event-subscriptions.d.ts +4 -4
  62. package/dist/cjs/resources/event-subscriptions.d.ts.map +1 -1
  63. package/dist/cjs/resources/events.d.ts +24 -99
  64. package/dist/cjs/resources/events.d.ts.map +1 -1
  65. package/dist/cjs/resources/exports.d.ts +4 -86
  66. package/dist/cjs/resources/exports.d.ts.map +1 -1
  67. package/dist/cjs/resources/external-accounts.d.ts +5 -10
  68. package/dist/cjs/resources/external-accounts.d.ts.map +1 -1
  69. package/dist/cjs/resources/files.d.ts +6 -43
  70. package/dist/cjs/resources/files.d.ts.map +1 -1
  71. package/dist/cjs/resources/limits.d.ts +4 -4
  72. package/dist/cjs/resources/limits.d.ts.map +1 -1
  73. package/dist/cjs/resources/pending-transactions.d.ts +11 -86
  74. package/dist/cjs/resources/pending-transactions.d.ts.map +1 -1
  75. package/dist/cjs/resources/real-time-decisions.d.ts +0 -69
  76. package/dist/cjs/resources/real-time-decisions.d.ts.map +1 -1
  77. package/dist/cjs/resources/real-time-payments-transfers.d.ts +9 -28
  78. package/dist/cjs/resources/real-time-payments-transfers.d.ts.map +1 -1
  79. package/dist/cjs/resources/simulations/ach-transfers.d.ts +108 -214
  80. package/dist/cjs/resources/simulations/ach-transfers.d.ts.map +1 -1
  81. package/dist/cjs/resources/simulations/card-disputes.d.ts +4 -4
  82. package/dist/cjs/resources/simulations/card-disputes.d.ts.map +1 -1
  83. package/dist/cjs/resources/simulations/cards.d.ts +6 -83
  84. package/dist/cjs/resources/simulations/cards.d.ts.map +1 -1
  85. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.d.ts +25 -25
  86. package/dist/cjs/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -1
  87. package/dist/cjs/resources/simulations/index.d.ts +1 -0
  88. package/dist/cjs/resources/simulations/index.d.ts.map +1 -1
  89. package/dist/cjs/resources/simulations/interest-payments.d.ts +57 -184
  90. package/dist/cjs/resources/simulations/interest-payments.d.ts.map +1 -1
  91. package/dist/cjs/resources/simulations/programs.d.ts +21 -0
  92. package/dist/cjs/resources/simulations/programs.d.ts.map +1 -0
  93. package/dist/cjs/resources/simulations/programs.js +17 -0
  94. package/dist/cjs/resources/simulations/programs.js.map +1 -0
  95. package/dist/cjs/resources/simulations/real-time-payments-transfers.d.ts +58 -242
  96. package/dist/cjs/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  97. package/dist/cjs/resources/simulations/simulations.d.ts +2 -0
  98. package/dist/cjs/resources/simulations/simulations.d.ts.map +1 -1
  99. package/dist/cjs/resources/simulations/simulations.js +2 -0
  100. package/dist/cjs/resources/simulations/simulations.js.map +1 -1
  101. package/dist/cjs/resources/simulations/wire-transfers.d.ts +57 -184
  102. package/dist/cjs/resources/simulations/wire-transfers.d.ts.map +1 -1
  103. package/dist/cjs/resources/transactions.d.ts +81 -281
  104. package/dist/cjs/resources/transactions.d.ts.map +1 -1
  105. package/dist/cjs/resources/wire-drawdown-requests.d.ts +8 -8
  106. package/dist/cjs/resources/wire-drawdown-requests.d.ts.map +1 -1
  107. package/dist/cjs/resources/wire-transfers.d.ts +13 -32
  108. package/dist/cjs/resources/wire-transfers.d.ts.map +1 -1
  109. package/dist/cjs/streaming.d.ts +13 -0
  110. package/dist/cjs/streaming.d.ts.map +1 -0
  111. package/dist/cjs/streaming.js +282 -0
  112. package/dist/cjs/streaming.js.map +1 -0
  113. package/dist/cjs/tests/api-resources/account-numbers.test.js +7 -8
  114. package/dist/cjs/tests/api-resources/account-numbers.test.js.map +1 -1
  115. package/dist/cjs/tests/api-resources/account-statements.test.js +6 -4
  116. package/dist/cjs/tests/api-resources/account-statements.test.js.map +1 -1
  117. package/dist/cjs/tests/api-resources/account-transfers.test.js +6 -5
  118. package/dist/cjs/tests/api-resources/account-transfers.test.js.map +1 -1
  119. package/dist/cjs/tests/api-resources/accounts.test.js +10 -12
  120. package/dist/cjs/tests/api-resources/accounts.test.js.map +1 -1
  121. package/dist/cjs/tests/api-resources/ach-prenotifications.test.js +7 -15
  122. package/dist/cjs/tests/api-resources/ach-prenotifications.test.js.map +1 -1
  123. package/dist/cjs/tests/api-resources/ach-transfers.test.js +8 -20
  124. package/dist/cjs/tests/api-resources/ach-transfers.test.js.map +1 -1
  125. package/dist/cjs/tests/api-resources/balance-lookups.test.js +1 -4
  126. package/dist/cjs/tests/api-resources/balance-lookups.test.js.map +1 -1
  127. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.js +2 -7
  128. package/dist/cjs/tests/api-resources/bookkeeping-accounts.test.js.map +1 -1
  129. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.js +1 -3
  130. package/dist/cjs/tests/api-resources/bookkeeping-entry-sets.test.js.map +1 -1
  131. package/dist/cjs/tests/api-resources/card-disputes.test.js +7 -5
  132. package/dist/cjs/tests/api-resources/card-disputes.test.js.map +1 -1
  133. package/dist/cjs/tests/api-resources/card-profiles.test.js +1 -1
  134. package/dist/cjs/tests/api-resources/card-profiles.test.js.map +1 -1
  135. package/dist/cjs/tests/api-resources/cards.test.js +8 -16
  136. package/dist/cjs/tests/api-resources/cards.test.js.map +1 -1
  137. package/dist/cjs/tests/api-resources/check-deposits.test.js +6 -4
  138. package/dist/cjs/tests/api-resources/check-deposits.test.js.map +1 -1
  139. package/dist/cjs/tests/api-resources/check-transfers.test.js +8 -10
  140. package/dist/cjs/tests/api-resources/check-transfers.test.js.map +1 -1
  141. package/dist/cjs/tests/api-resources/declined-transactions.test.js +6 -4
  142. package/dist/cjs/tests/api-resources/declined-transactions.test.js.map +1 -1
  143. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.js +6 -4
  144. package/dist/cjs/tests/api-resources/digital-wallet-tokens.test.js.map +1 -1
  145. package/dist/cjs/tests/api-resources/documents.test.js +13 -9
  146. package/dist/cjs/tests/api-resources/documents.test.js.map +1 -1
  147. package/dist/cjs/tests/api-resources/entities/entities.test.js +8 -76
  148. package/dist/cjs/tests/api-resources/entities/entities.test.js.map +1 -1
  149. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.js +12 -0
  150. package/dist/cjs/tests/api-resources/entities/supplemental-documents.test.js.map +1 -1
  151. package/dist/cjs/tests/api-resources/event-subscriptions.test.js +3 -7
  152. package/dist/cjs/tests/api-resources/event-subscriptions.test.js.map +1 -1
  153. package/dist/cjs/tests/api-resources/events.test.js +7 -5
  154. package/dist/cjs/tests/api-resources/events.test.js.map +1 -1
  155. package/dist/cjs/tests/api-resources/exports.test.js +2 -6
  156. package/dist/cjs/tests/api-resources/exports.test.js.map +1 -1
  157. package/dist/cjs/tests/api-resources/external-accounts.test.js +3 -7
  158. package/dist/cjs/tests/api-resources/external-accounts.test.js.map +1 -1
  159. package/dist/cjs/tests/api-resources/files.test.js +8 -7
  160. package/dist/cjs/tests/api-resources/files.test.js.map +1 -1
  161. package/dist/cjs/tests/api-resources/limits.test.js +2 -7
  162. package/dist/cjs/tests/api-resources/limits.test.js.map +1 -1
  163. package/dist/cjs/tests/api-resources/pending-transactions.test.js +7 -5
  164. package/dist/cjs/tests/api-resources/pending-transactions.test.js.map +1 -1
  165. package/dist/cjs/tests/api-resources/real-time-decisions.test.js +1 -5
  166. package/dist/cjs/tests/api-resources/real-time-decisions.test.js.map +1 -1
  167. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.js +8 -10
  168. package/dist/cjs/tests/api-resources/real-time-payments-transfers.test.js.map +1 -1
  169. package/dist/cjs/tests/api-resources/routing-numbers.test.js +2 -6
  170. package/dist/cjs/tests/api-resources/routing-numbers.test.js.map +1 -1
  171. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.js +4 -8
  172. package/dist/cjs/tests/api-resources/simulations/ach-transfers.test.js.map +1 -1
  173. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.js +1 -2
  174. package/dist/cjs/tests/api-resources/simulations/card-disputes.test.js.map +1 -1
  175. package/dist/cjs/tests/api-resources/simulations/cards.test.js +2 -8
  176. package/dist/cjs/tests/api-resources/simulations/cards.test.js.map +1 -1
  177. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.js +6 -18
  178. package/dist/cjs/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.js.map +1 -1
  179. package/dist/cjs/tests/api-resources/simulations/programs.test.d.ts +2 -0
  180. package/dist/cjs/tests/api-resources/simulations/programs.test.d.ts.map +1 -0
  181. package/dist/cjs/tests/api-resources/simulations/programs.test.js +52 -0
  182. package/dist/cjs/tests/api-resources/simulations/programs.test.js.map +1 -0
  183. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.js +1 -6
  184. package/dist/cjs/tests/api-resources/simulations/real-time-payments-transfers.test.js.map +1 -1
  185. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.js +0 -13
  186. package/dist/cjs/tests/api-resources/simulations/wire-transfers.test.js.map +1 -1
  187. package/dist/cjs/tests/api-resources/transactions.test.js +9 -9
  188. package/dist/cjs/tests/api-resources/transactions.test.js.map +1 -1
  189. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.js +2 -5
  190. package/dist/cjs/tests/api-resources/wire-drawdown-requests.test.js.map +1 -1
  191. package/dist/cjs/tests/api-resources/wire-transfers.test.js +9 -14
  192. package/dist/cjs/tests/api-resources/wire-transfers.test.js.map +1 -1
  193. package/dist/cjs/tests/index.test.js +9 -4
  194. package/dist/cjs/tests/index.test.js.map +1 -1
  195. package/dist/cjs/version.d.ts +1 -1
  196. package/dist/cjs/version.js +1 -1
  197. package/error.ts +195 -27
  198. package/index.ts +26 -94
  199. package/package.json +1 -1
  200. package/release-please-config.json +5 -8
  201. package/resources/account-numbers.ts +1 -23
  202. package/resources/account-statements.ts +1 -23
  203. package/resources/account-transfers.ts +1 -23
  204. package/resources/accounts.ts +19 -28
  205. package/resources/ach-prenotifications.ts +7 -29
  206. package/resources/ach-transfers.ts +73 -42
  207. package/resources/bookkeeping-accounts.ts +5 -5
  208. package/resources/bookkeeping-entry-sets.ts +5 -19
  209. package/resources/card-disputes.ts +2 -29
  210. package/resources/card-profiles.ts +1 -74
  211. package/resources/cards.ts +1 -135
  212. package/resources/check-deposits.ts +3 -24
  213. package/resources/check-transfers.ts +11 -68
  214. package/resources/declined-transactions.ts +2 -60
  215. package/resources/digital-wallet-tokens.ts +1 -23
  216. package/resources/documents.ts +2 -79
  217. package/resources/entities/entities.ts +112 -1210
  218. package/resources/entities/index.ts +6 -1
  219. package/resources/entities/supplemental-documents.ts +46 -0
  220. package/resources/event-subscriptions.ts +5 -5
  221. package/resources/events.ts +28 -106
  222. package/resources/exports.ts +5 -99
  223. package/resources/external-accounts.ts +6 -11
  224. package/resources/files.ts +6 -46
  225. package/resources/limits.ts +5 -5
  226. package/resources/pending-transactions.ts +12 -104
  227. package/resources/real-time-decisions.ts +0 -77
  228. package/resources/real-time-payments-transfers.ts +11 -33
  229. package/resources/simulations/ach-transfers.ts +109 -263
  230. package/resources/simulations/card-disputes.ts +4 -4
  231. package/resources/simulations/cards.ts +7 -107
  232. package/resources/simulations/inbound-wire-drawdown-requests.ts +28 -28
  233. package/resources/simulations/index.ts +1 -0
  234. package/resources/simulations/interest-payments.ts +58 -224
  235. package/resources/simulations/programs.ts +26 -0
  236. package/resources/simulations/real-time-payments-transfers.ts +59 -292
  237. package/resources/simulations/simulations.ts +2 -0
  238. package/resources/simulations/wire-transfers.ts +58 -224
  239. package/resources/transactions.ts +86 -328
  240. package/resources/wire-drawdown-requests.ts +10 -10
  241. package/resources/wire-transfers.ts +15 -37
  242. package/streaming.ts +199 -0
  243. package/tests/api-resources/account-numbers.test.ts +7 -8
  244. package/tests/api-resources/account-statements.test.ts +6 -4
  245. package/tests/api-resources/account-transfers.test.ts +6 -5
  246. package/tests/api-resources/accounts.test.ts +10 -12
  247. package/tests/api-resources/ach-prenotifications.test.ts +7 -15
  248. package/tests/api-resources/ach-transfers.test.ts +8 -20
  249. package/tests/api-resources/balance-lookups.test.ts +1 -4
  250. package/tests/api-resources/bookkeeping-accounts.test.ts +2 -7
  251. package/tests/api-resources/bookkeeping-entry-sets.test.ts +1 -3
  252. package/tests/api-resources/card-disputes.test.ts +7 -5
  253. package/tests/api-resources/card-profiles.test.ts +1 -1
  254. package/tests/api-resources/cards.test.ts +8 -16
  255. package/tests/api-resources/check-deposits.test.ts +6 -4
  256. package/tests/api-resources/check-transfers.test.ts +8 -10
  257. package/tests/api-resources/declined-transactions.test.ts +6 -4
  258. package/tests/api-resources/digital-wallet-tokens.test.ts +6 -4
  259. package/tests/api-resources/documents.test.ts +9 -9
  260. package/tests/api-resources/entities/entities.test.ts +9 -80
  261. package/tests/api-resources/entities/supplemental-documents.test.ts +12 -0
  262. package/tests/api-resources/event-subscriptions.test.ts +3 -7
  263. package/tests/api-resources/events.test.ts +7 -5
  264. package/tests/api-resources/exports.test.ts +2 -6
  265. package/tests/api-resources/external-accounts.test.ts +3 -7
  266. package/tests/api-resources/files.test.ts +8 -7
  267. package/tests/api-resources/limits.test.ts +2 -7
  268. package/tests/api-resources/pending-transactions.test.ts +7 -5
  269. package/tests/api-resources/real-time-decisions.test.ts +1 -5
  270. package/tests/api-resources/real-time-payments-transfers.test.ts +8 -10
  271. package/tests/api-resources/routing-numbers.test.ts +2 -6
  272. package/tests/api-resources/simulations/ach-transfers.test.ts +1 -8
  273. package/tests/api-resources/simulations/card-disputes.test.ts +1 -2
  274. package/tests/api-resources/simulations/cards.test.ts +2 -8
  275. package/tests/api-resources/simulations/inbound-wire-drawdown-requests.test.ts +6 -18
  276. package/tests/api-resources/simulations/programs.test.ts +15 -0
  277. package/tests/api-resources/simulations/real-time-payments-transfers.test.ts +1 -6
  278. package/tests/api-resources/simulations/wire-transfers.test.ts +0 -13
  279. package/tests/api-resources/transactions.test.ts +9 -9
  280. package/tests/api-resources/wire-drawdown-requests.test.ts +2 -5
  281. package/tests/api-resources/wire-transfers.test.ts +9 -14
  282. package/tests/index.test.ts +9 -4
  283. package/version.ts +1 -1
  284. package/.github/workflows/publish-npm.yml +0 -28
  285. package/.github/workflows/release-doctor.yml +0 -20
  286. package/.github/workflows/release.yml +0 -38
@@ -312,83 +312,6 @@ export namespace RealTimeDecisionActionParams {
312
312
  decision: 'approve' | 'decline';
313
313
  }
314
314
 
315
- /**
316
- * If the Real-Time Decision relates to a digital wallet token provisioning
317
- * attempt, this object contains your response to the attempt.
318
- */
319
- export interface DigitalWalletToken {
320
- /**
321
- * If your application approves the provisioning attempt, this contains metadata
322
- * about the digital wallet token that will be generated.
323
- */
324
- approval?: DigitalWalletToken.Approval;
325
-
326
- /**
327
- * If your application declines the provisioning attempt, this contains details
328
- * about the decline.
329
- */
330
- decline?: DigitalWalletToken.Decline;
331
- }
332
-
333
- export namespace DigitalWalletToken {
334
- /**
335
- * If your application approves the provisioning attempt, this contains metadata
336
- * about the digital wallet token that will be generated.
337
- */
338
- export interface Approval {
339
- /**
340
- * The identifier of the Card Profile to assign to the Digital Wallet token.
341
- */
342
- card_profile_id: string;
343
-
344
- /**
345
- * An email address that can be used to verify the cardholder via one-time
346
- * passcode.
347
- */
348
- email?: string;
349
-
350
- /**
351
- * A phone number that can be used to verify the cardholder via one-time passcode
352
- * over SMS.
353
- */
354
- phone?: string;
355
- }
356
-
357
- /**
358
- * If your application declines the provisioning attempt, this contains details
359
- * about the decline.
360
- */
361
- export interface Decline {
362
- /**
363
- * Why the tokenization attempt was declined. This is for logging purposes only and
364
- * is not displayed to the end-user.
365
- */
366
- reason?: string;
367
- }
368
- }
369
-
370
- /**
371
- * If the Real-Time Decision relates to a digital wallet authentication attempt,
372
- * this object contains your response to the authentication.
373
- */
374
- export interface DigitalWalletAuthentication {
375
- /**
376
- * Whether your application was able to deliver the one-time passcode.
377
- */
378
- result: 'success' | 'failure';
379
- }
380
-
381
- /**
382
- * If the Real-Time Decision relates to a card authorization attempt, this object
383
- * contains your response to the authorization.
384
- */
385
- export interface CardAuthorization {
386
- /**
387
- * Whether the card authorization should be approved or declined.
388
- */
389
- decision: 'approve' | 'decline';
390
- }
391
-
392
315
  /**
393
316
  * If the Real-Time Decision relates to a digital wallet authentication attempt,
394
317
  * this object contains your response to the authentication.
@@ -273,6 +273,16 @@ export interface RealTimePaymentsTransferCreateParams {
273
273
  */
274
274
  creditor_name: string;
275
275
 
276
+ /**
277
+ * Unstructured information that will show on the recipient's bank statement.
278
+ */
279
+ remittance_information: string;
280
+
281
+ /**
282
+ * The identifier of the Account Number from which to send the transfer.
283
+ */
284
+ source_account_number_id: string;
285
+
276
286
  /**
277
287
  * The destination account number.
278
288
  */
@@ -291,20 +301,10 @@ export interface RealTimePaymentsTransferCreateParams {
291
301
  */
292
302
  external_account_id?: string;
293
303
 
294
- /**
295
- * Unstructured information that will show on the recipient's bank statement.
296
- */
297
- remittance_information: string;
298
-
299
304
  /**
300
305
  * Whether the transfer requires explicit approval via the dashboard or API.
301
306
  */
302
307
  require_approval?: boolean;
303
-
304
- /**
305
- * The identifier of the Account Number from which to send the transfer.
306
- */
307
- source_account_number_id: string;
308
308
  }
309
309
 
310
310
  export interface RealTimePaymentsTransferListParams extends PageParams {
@@ -313,29 +313,7 @@ export interface RealTimePaymentsTransferListParams extends PageParams {
313
313
  */
314
314
  account_id?: string;
315
315
 
316
- /**
317
- * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
318
- * timestamp.
319
- */
320
- 'created_at.after'?: string;
321
-
322
- /**
323
- * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
324
- * timestamp.
325
- */
326
- 'created_at.before'?: string;
327
-
328
- /**
329
- * Return results on or after this
330
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
331
- */
332
- 'created_at.on_or_after'?: string;
333
-
334
- /**
335
- * Return results on or before this
336
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
337
- */
338
- 'created_at.on_or_before'?: string;
316
+ created_at?: RealTimePaymentsTransferListParams.CreatedAt;
339
317
 
340
318
  /**
341
319
  * Filter Real Time Payments Transfers to those made to the specified External
@@ -158,18 +158,6 @@ export namespace ACHTransferSimulation {
158
158
  */
159
159
  account_transfer_intention: Source.AccountTransferIntention | null;
160
160
 
161
- /**
162
- * A ACH Check Conversion object. This field will be present in the JSON response
163
- * if and only if `category` is equal to `ach_check_conversion`.
164
- */
165
- ach_check_conversion: Source.ACHCheckConversion | null;
166
-
167
- /**
168
- * A ACH Check Conversion Return object. This field will be present in the JSON
169
- * response if and only if `category` is equal to `ach_check_conversion_return`.
170
- */
171
- ach_check_conversion_return: Source.ACHCheckConversionReturn | null;
172
-
173
161
  /**
174
162
  * A ACH Transfer Intention object. This field will be present in the JSON response
175
163
  * if and only if `category` is equal to `ach_transfer_intention`.
@@ -206,18 +194,6 @@ export namespace ACHTransferSimulation {
206
194
  */
207
195
  card_revenue_payment: Source.CardRevenuePayment | null;
208
196
 
209
- /**
210
- * A Deprecated Card Refund object. This field will be present in the JSON response
211
- * if and only if `category` is equal to `card_route_refund`.
212
- */
213
- card_route_refund: Source.CardRouteRefund | null;
214
-
215
- /**
216
- * A Deprecated Card Settlement object. This field will be present in the JSON
217
- * response if and only if `category` is equal to `card_route_settlement`.
218
- */
219
- card_route_settlement: Source.CardRouteSettlement | null;
220
-
221
197
  /**
222
198
  * A Card Settlement object. This field will be present in the JSON response if and
223
199
  * only if `category` is equal to `card_settlement`.
@@ -231,8 +207,6 @@ export namespace ACHTransferSimulation {
231
207
  */
232
208
  category:
233
209
  | 'account_transfer_intention'
234
- | 'ach_check_conversion_return'
235
- | 'ach_check_conversion'
236
210
  | 'ach_transfer_intention'
237
211
  | 'ach_transfer_rejection'
238
212
  | 'ach_transfer_return'
@@ -246,8 +220,6 @@ export namespace ACHTransferSimulation {
246
220
  | 'check_transfer_return'
247
221
  | 'check_transfer_rejection'
248
222
  | 'check_transfer_stop_payment_request'
249
- | 'dispute_resolution'
250
- | 'empyreal_cash_deposit'
251
223
  | 'fee_payment'
252
224
  | 'inbound_ach_transfer'
253
225
  | 'inbound_ach_transfer_return_intention'
@@ -259,14 +231,9 @@ export namespace ACHTransferSimulation {
259
231
  | 'inbound_wire_reversal'
260
232
  | 'inbound_wire_transfer'
261
233
  | 'interest_payment'
262
- | 'internal_general_ledger_transaction'
263
234
  | 'internal_source'
264
- | 'card_route_refund'
265
- | 'card_route_settlement'
266
235
  | 'real_time_payments_transfer_acknowledgement'
267
236
  | 'sample_funds'
268
- | 'wire_drawdown_payment_intention'
269
- | 'wire_drawdown_payment_rejection'
270
237
  | 'wire_transfer_intention'
271
238
  | 'wire_transfer_rejection'
272
239
  | 'other';
@@ -308,18 +275,6 @@ export namespace ACHTransferSimulation {
308
275
  */
309
276
  check_transfer_stop_payment_request: Source.CheckTransferStopPaymentRequest | null;
310
277
 
311
- /**
312
- * A Dispute Resolution object. This field will be present in the JSON response if
313
- * and only if `category` is equal to `dispute_resolution`.
314
- */
315
- dispute_resolution: Source.DisputeResolution | null;
316
-
317
- /**
318
- * A Empyreal Cash Deposit object. This field will be present in the JSON response
319
- * if and only if `category` is equal to `empyreal_cash_deposit`.
320
- */
321
- empyreal_cash_deposit: Source.EmpyrealCashDeposit | null;
322
-
323
278
  /**
324
279
  * A Fee Payment object. This field will be present in the JSON response if and
325
280
  * only if `category` is equal to `fee_payment`.
@@ -402,20 +357,6 @@ export namespace ACHTransferSimulation {
402
357
  */
403
358
  sample_funds: Source.SampleFunds | null;
404
359
 
405
- /**
406
- * A Wire Drawdown Payment Intention object. This field will be present in the JSON
407
- * response if and only if `category` is equal to
408
- * `wire_drawdown_payment_intention`.
409
- */
410
- wire_drawdown_payment_intention: Source.WireDrawdownPaymentIntention | null;
411
-
412
- /**
413
- * A Wire Drawdown Payment Rejection object. This field will be present in the JSON
414
- * response if and only if `category` is equal to
415
- * `wire_drawdown_payment_rejection`.
416
- */
417
- wire_drawdown_payment_rejection: Source.WireDrawdownPaymentRejection | null;
418
-
419
360
  /**
420
361
  * A Wire Transfer Intention object. This field will be present in the JSON
421
362
  * response if and only if `category` is equal to `wire_transfer_intention`.
@@ -468,40 +409,6 @@ export namespace ACHTransferSimulation {
468
409
  transfer_id: string;
469
410
  }
470
411
 
471
- /**
472
- * A ACH Check Conversion Return object. This field will be present in the JSON
473
- * response if and only if `category` is equal to `ach_check_conversion_return`.
474
- */
475
- export interface ACHCheckConversionReturn {
476
- /**
477
- * The amount in the minor unit of the transaction's currency. For dollars, for
478
- * example, this is cents.
479
- */
480
- amount: number;
481
-
482
- /**
483
- * Why the transfer was returned.
484
- */
485
- return_reason_code: string;
486
- }
487
-
488
- /**
489
- * A ACH Check Conversion object. This field will be present in the JSON response
490
- * if and only if `category` is equal to `ach_check_conversion`.
491
- */
492
- export interface ACHCheckConversion {
493
- /**
494
- * The amount in the minor unit of the transaction's currency. For dollars, for
495
- * example, this is cents.
496
- */
497
- amount: number;
498
-
499
- /**
500
- * The identifier of the File containing an image of the returned check.
501
- */
502
- file_id: string;
503
- }
504
-
505
412
  /**
506
413
  * A ACH Transfer Intention object. This field will be present in the JSON response
507
414
  * if and only if `category` is equal to `ach_transfer_intention`.
@@ -547,6 +454,11 @@ export namespace ACHTransferSimulation {
547
454
  */
548
455
  created_at: string;
549
456
 
457
+ /**
458
+ * The three character ACH return code, in the range R01 to R85.
459
+ */
460
+ raw_return_reason_code: string;
461
+
550
462
  /**
551
463
  * Why the ACH Transfer was returned.
552
464
  */
@@ -570,10 +482,58 @@ export namespace ACHTransferSimulation {
570
482
  | 'file_record_edit_criteria'
571
483
  | 'enr_invalid_individual_name'
572
484
  | 'returned_per_odfi_request'
573
- | 'addenda_error'
574
485
  | 'limited_participation_dfi'
575
486
  | 'incorrectly_coded_outbound_international_payment'
576
- | 'other';
487
+ | 'other'
488
+ | 'account_sold_to_another_dfi'
489
+ | 'addenda_error'
490
+ | 'beneficiary_or_account_holder_deceased'
491
+ | 'customer_advised_not_within_authorization_terms'
492
+ | 'corrected_return'
493
+ | 'duplicate_entry'
494
+ | 'duplicate_return'
495
+ | 'enr_duplicate_enrollment'
496
+ | 'enr_invalid_dfi_account_number'
497
+ | 'enr_invalid_individual_id_number'
498
+ | 'enr_invalid_representative_payee_indicator'
499
+ | 'enr_invalid_transaction_code'
500
+ | 'enr_return_of_enr_entry'
501
+ | 'enr_routing_number_check_digit_error'
502
+ | 'entry_not_processed_by_gateway'
503
+ | 'field_error'
504
+ | 'foreign_receiving_dfi_unable_to_settle'
505
+ | 'iat_entry_coding_error'
506
+ | 'improper_effective_entry_date'
507
+ | 'improper_source_document_source_document_presented'
508
+ | 'invalid_company_id'
509
+ | 'invalid_foreign_receiving_dfi_identification'
510
+ | 'invalid_individual_id_number'
511
+ | 'item_and_rck_entry_presented_for_payment'
512
+ | 'item_related_to_rck_entry_is_ineligible'
513
+ | 'mandatory_field_error'
514
+ | 'misrouted_dishonored_return'
515
+ | 'misrouted_return'
516
+ | 'no_errors_found'
517
+ | 'non_acceptance_of_r62_dishonored_return'
518
+ | 'non_participant_in_iat_program'
519
+ | 'permissible_return_entry'
520
+ | 'permissible_return_entry_not_accepted'
521
+ | 'rdfi_non_settlement'
522
+ | 'rdfi_participant_in_check_truncation_program'
523
+ | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
524
+ | 'return_not_a_duplicate'
525
+ | 'return_of_erroneous_or_reversing_debit'
526
+ | 'return_of_improper_credit_entry'
527
+ | 'return_of_improper_debit_entry'
528
+ | 'return_of_xck_entry'
529
+ | 'source_document_presented_for_payment'
530
+ | 'state_law_affecting_rck_acceptance'
531
+ | 'stop_payment_on_item_related_to_rck_entry'
532
+ | 'stop_payment_on_source_document'
533
+ | 'timely_original_return'
534
+ | 'trace_number_error'
535
+ | 'untimely_dishonored_return'
536
+ | 'untimely_return';
577
537
 
578
538
  /**
579
539
  * The identifier of the Tranasaction associated with this return.
@@ -862,7 +822,8 @@ export namespace ACHTransferSimulation {
862
822
  | 'stop_payment'
863
823
  | 'unknown_reason'
864
824
  | 'unmatched_details'
865
- | 'unreadable_image';
825
+ | 'unreadable_image'
826
+ | 'endorsement_irregular';
866
827
 
867
828
  /**
868
829
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -1001,45 +962,6 @@ export namespace ACHTransferSimulation {
1001
962
  type: 'check_transfer_stop_payment_request';
1002
963
  }
1003
964
 
1004
- /**
1005
- * A Dispute Resolution object. This field will be present in the JSON response if
1006
- * and only if `category` is equal to `dispute_resolution`.
1007
- */
1008
- export interface DisputeResolution {
1009
- /**
1010
- * The amount in the minor unit of the transaction's currency. For dollars, for
1011
- * example, this is cents.
1012
- */
1013
- amount: number;
1014
-
1015
- /**
1016
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1017
- * transaction's currency.
1018
- */
1019
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1020
-
1021
- /**
1022
- * The identifier of the Transaction that was disputed.
1023
- */
1024
- disputed_transaction_id: string;
1025
- }
1026
-
1027
- /**
1028
- * A Empyreal Cash Deposit object. This field will be present in the JSON response
1029
- * if and only if `category` is equal to `empyreal_cash_deposit`.
1030
- */
1031
- export interface EmpyrealCashDeposit {
1032
- /**
1033
- * The amount in the minor unit of the transaction's currency. For dollars, for
1034
- * example, this is cents.
1035
- */
1036
- amount: number;
1037
-
1038
- bag_id: string;
1039
-
1040
- deposit_date: string;
1041
- }
1042
-
1043
965
  /**
1044
966
  * A Fee Payment object. This field will be present in the JSON response if and
1045
967
  * only if `category` is equal to `fee_payment`.
@@ -1513,6 +1435,7 @@ export namespace ACHTransferSimulation {
1513
1435
  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1514
1436
 
1515
1437
  reason:
1438
+ | 'account_closure'
1516
1439
  | 'bank_migration'
1517
1440
  | 'cashback'
1518
1441
  | 'collection_receivable'
@@ -1526,66 +1449,6 @@ export namespace ACHTransferSimulation {
1526
1449
  | 'sample_funds_return';
1527
1450
  }
1528
1451
 
1529
- /**
1530
- * A Deprecated Card Refund object. This field will be present in the JSON response
1531
- * if and only if `category` is equal to `card_route_refund`.
1532
- */
1533
- export interface CardRouteRefund {
1534
- /**
1535
- * The refunded amount in the minor unit of the refunded currency. For dollars, for
1536
- * example, this is cents.
1537
- */
1538
- amount: number;
1539
-
1540
- /**
1541
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the refund
1542
- * currency.
1543
- */
1544
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1545
-
1546
- merchant_acceptor_id: string;
1547
-
1548
- merchant_category_code: string | null;
1549
-
1550
- merchant_city: string | null;
1551
-
1552
- merchant_country: string;
1553
-
1554
- merchant_descriptor: string;
1555
-
1556
- merchant_state: string | null;
1557
- }
1558
-
1559
- /**
1560
- * A Deprecated Card Settlement object. This field will be present in the JSON
1561
- * response if and only if `category` is equal to `card_route_settlement`.
1562
- */
1563
- export interface CardRouteSettlement {
1564
- /**
1565
- * The settled amount in the minor unit of the settlement currency. For dollars,
1566
- * for example, this is cents.
1567
- */
1568
- amount: number;
1569
-
1570
- /**
1571
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the settlement
1572
- * currency.
1573
- */
1574
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1575
-
1576
- merchant_acceptor_id: string;
1577
-
1578
- merchant_category_code: string | null;
1579
-
1580
- merchant_city: string | null;
1581
-
1582
- merchant_country: string | null;
1583
-
1584
- merchant_descriptor: string;
1585
-
1586
- merchant_state: string | null;
1587
- }
1588
-
1589
1452
  /**
1590
1453
  * A Real Time Payments Transfer Acknowledgement object. This field will be present
1591
1454
  * in the JSON response if and only if `category` is equal to
@@ -1629,35 +1492,6 @@ export namespace ACHTransferSimulation {
1629
1492
  originator: string;
1630
1493
  }
1631
1494
 
1632
- /**
1633
- * A Wire Drawdown Payment Intention object. This field will be present in the JSON
1634
- * response if and only if `category` is equal to
1635
- * `wire_drawdown_payment_intention`.
1636
- */
1637
- export interface WireDrawdownPaymentIntention {
1638
- account_number: string;
1639
-
1640
- /**
1641
- * The transfer amount in USD cents.
1642
- */
1643
- amount: number;
1644
-
1645
- message_to_recipient: string;
1646
-
1647
- routing_number: string;
1648
-
1649
- transfer_id: string;
1650
- }
1651
-
1652
- /**
1653
- * A Wire Drawdown Payment Rejection object. This field will be present in the JSON
1654
- * response if and only if `category` is equal to
1655
- * `wire_drawdown_payment_rejection`.
1656
- */
1657
- export interface WireDrawdownPaymentRejection {
1658
- transfer_id: string;
1659
- }
1660
-
1661
1495
  /**
1662
1496
  * A Wire Transfer Intention object. This field will be present in the JSON
1663
1497
  * response if and only if `category` is equal to `wire_transfer_intention`.
@@ -1784,12 +1618,6 @@ export namespace ACHTransferSimulation {
1784
1618
  */
1785
1619
  card_decline: Source.CardDecline | null;
1786
1620
 
1787
- /**
1788
- * A Deprecated Card Decline object. This field will be present in the JSON
1789
- * response if and only if `category` is equal to `card_route_decline`.
1790
- */
1791
- card_route_decline: Source.CardRouteDecline | null;
1792
-
1793
1621
  /**
1794
1622
  * The type of decline that took place. We may add additional possible values for
1795
1623
  * this enum over time; your application should be able to handle such additions
@@ -1801,7 +1629,6 @@ export namespace ACHTransferSimulation {
1801
1629
  | 'check_decline'
1802
1630
  | 'inbound_real_time_payments_transfer_decline'
1803
1631
  | 'international_ach_decline'
1804
- | 'card_route_decline'
1805
1632
  | 'wire_decline'
1806
1633
  | 'other';
1807
1634
 
@@ -2030,6 +1857,7 @@ export namespace ACHTransferSimulation {
2030
1857
  | 'group_locked'
2031
1858
  | 'insufficient_funds'
2032
1859
  | 'unable_to_locate_account'
1860
+ | 'not_our_item'
2033
1861
  | 'unable_to_process'
2034
1862
  | 'refer_to_image'
2035
1863
  | 'stop_payment_requested'
@@ -2182,36 +2010,6 @@ export namespace ACHTransferSimulation {
2182
2010
  trace_number: string;
2183
2011
  }
2184
2012
 
2185
- /**
2186
- * A Deprecated Card Decline object. This field will be present in the JSON
2187
- * response if and only if `category` is equal to `card_route_decline`.
2188
- */
2189
- export interface CardRouteDecline {
2190
- /**
2191
- * The declined amount in the minor unit of the destination account currency. For
2192
- * dollars, for example, this is cents.
2193
- */
2194
- amount: number;
2195
-
2196
- /**
2197
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
2198
- * account currency.
2199
- */
2200
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
2201
-
2202
- merchant_acceptor_id: string;
2203
-
2204
- merchant_category_code: string | null;
2205
-
2206
- merchant_city: string | null;
2207
-
2208
- merchant_country: string;
2209
-
2210
- merchant_descriptor: string;
2211
-
2212
- merchant_state: string | null;
2213
- }
2214
-
2215
2013
  /**
2216
2014
  * A Wire Decline object. This field will be present in the JSON response if and
2217
2015
  * only if `category` is equal to `wire_decline`.
@@ -2332,8 +2130,56 @@ export interface ACHTransferReturnParams {
2332
2130
  | 'file_record_edit_criteria'
2333
2131
  | 'enr_invalid_individual_name'
2334
2132
  | 'returned_per_odfi_request'
2335
- | 'addenda_error'
2336
2133
  | 'limited_participation_dfi'
2337
2134
  | 'incorrectly_coded_outbound_international_payment'
2338
- | 'other';
2135
+ | 'other'
2136
+ | 'account_sold_to_another_dfi'
2137
+ | 'addenda_error'
2138
+ | 'beneficiary_or_account_holder_deceased'
2139
+ | 'customer_advised_not_within_authorization_terms'
2140
+ | 'corrected_return'
2141
+ | 'duplicate_entry'
2142
+ | 'duplicate_return'
2143
+ | 'enr_duplicate_enrollment'
2144
+ | 'enr_invalid_dfi_account_number'
2145
+ | 'enr_invalid_individual_id_number'
2146
+ | 'enr_invalid_representative_payee_indicator'
2147
+ | 'enr_invalid_transaction_code'
2148
+ | 'enr_return_of_enr_entry'
2149
+ | 'enr_routing_number_check_digit_error'
2150
+ | 'entry_not_processed_by_gateway'
2151
+ | 'field_error'
2152
+ | 'foreign_receiving_dfi_unable_to_settle'
2153
+ | 'iat_entry_coding_error'
2154
+ | 'improper_effective_entry_date'
2155
+ | 'improper_source_document_source_document_presented'
2156
+ | 'invalid_company_id'
2157
+ | 'invalid_foreign_receiving_dfi_identification'
2158
+ | 'invalid_individual_id_number'
2159
+ | 'item_and_rck_entry_presented_for_payment'
2160
+ | 'item_related_to_rck_entry_is_ineligible'
2161
+ | 'mandatory_field_error'
2162
+ | 'misrouted_dishonored_return'
2163
+ | 'misrouted_return'
2164
+ | 'no_errors_found'
2165
+ | 'non_acceptance_of_r62_dishonored_return'
2166
+ | 'non_participant_in_iat_program'
2167
+ | 'permissible_return_entry'
2168
+ | 'permissible_return_entry_not_accepted'
2169
+ | 'rdfi_non_settlement'
2170
+ | 'rdfi_participant_in_check_truncation_program'
2171
+ | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
2172
+ | 'return_not_a_duplicate'
2173
+ | 'return_of_erroneous_or_reversing_debit'
2174
+ | 'return_of_improper_credit_entry'
2175
+ | 'return_of_improper_debit_entry'
2176
+ | 'return_of_xck_entry'
2177
+ | 'source_document_presented_for_payment'
2178
+ | 'state_law_affecting_rck_acceptance'
2179
+ | 'stop_payment_on_item_related_to_rck_entry'
2180
+ | 'stop_payment_on_source_document'
2181
+ | 'timely_original_return'
2182
+ | 'trace_number_error'
2183
+ | 'untimely_dishonored_return'
2184
+ | 'untimely_return';
2339
2185
  }
@@ -22,12 +22,12 @@ export class CardDisputes extends APIResource {
22
22
 
23
23
  export interface CardDisputeActionParams {
24
24
  /**
25
- * Why the dispute was rejected. Not required for accepting disputes.
25
+ * The status to move the dispute to.
26
26
  */
27
- explanation?: string;
27
+ status: 'accepted' | 'rejected';
28
28
 
29
29
  /**
30
- * The status to move the dispute to.
30
+ * Why the dispute was rejected. Not required for accepting disputes.
31
31
  */
32
- status: 'accepted' | 'rejected';
32
+ explanation?: string;
33
33
  }