increase 0.59.0 → 0.60.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 (299) hide show
  1. package/CHANGELOG.md +31 -0
  2. package/README.md +41 -17
  3. package/error.d.ts.map +1 -1
  4. package/error.js +0 -3
  5. package/error.js.map +1 -1
  6. package/error.mjs +0 -3
  7. package/error.mjs.map +1 -1
  8. package/index.d.mts +190 -172
  9. package/index.d.ts +190 -172
  10. package/index.d.ts.map +1 -1
  11. package/index.js +96 -87
  12. package/index.js.map +1 -1
  13. package/index.mjs +96 -87
  14. package/index.mjs.map +1 -1
  15. package/package.json +1 -1
  16. package/resources/cards.d.ts +1 -1
  17. package/resources/cards.d.ts.map +1 -1
  18. package/resources/cards.js +1 -1
  19. package/resources/cards.js.map +1 -1
  20. package/resources/cards.mjs +1 -1
  21. package/resources/cards.mjs.map +1 -1
  22. package/resources/declined-transactions.d.ts +2 -231
  23. package/resources/declined-transactions.d.ts.map +1 -1
  24. package/resources/declined-transactions.js.map +1 -1
  25. package/resources/declined-transactions.mjs.map +1 -1
  26. package/resources/{entities/entities.d.ts → entities.d.ts} +276 -46
  27. package/resources/entities.d.ts.map +1 -0
  28. package/resources/{entities/entities.js → entities.js} +28 -17
  29. package/resources/entities.js.map +1 -0
  30. package/resources/{entities/entities.mjs → entities.mjs} +28 -17
  31. package/resources/entities.mjs.map +1 -0
  32. package/resources/groups.d.ts +1 -1
  33. package/resources/groups.d.ts.map +1 -1
  34. package/resources/groups.js +1 -1
  35. package/resources/groups.js.map +1 -1
  36. package/resources/groups.mjs +1 -1
  37. package/resources/groups.mjs.map +1 -1
  38. package/resources/inbound-ach-transfers.d.ts +218 -7
  39. package/resources/inbound-ach-transfers.d.ts.map +1 -1
  40. package/resources/inbound-ach-transfers.js +8 -8
  41. package/resources/inbound-ach-transfers.js.map +1 -1
  42. package/resources/inbound-ach-transfers.mjs +8 -8
  43. package/resources/inbound-ach-transfers.mjs.map +1 -1
  44. package/resources/inbound-check-deposits.d.ts +25 -1
  45. package/resources/inbound-check-deposits.d.ts.map +1 -1
  46. package/resources/inbound-check-deposits.js +6 -0
  47. package/resources/inbound-check-deposits.js.map +1 -1
  48. package/resources/inbound-check-deposits.mjs +6 -0
  49. package/resources/inbound-check-deposits.mjs.map +1 -1
  50. package/resources/inbound-mail-items.d.ts +0 -14
  51. package/resources/inbound-mail-items.d.ts.map +1 -1
  52. package/resources/inbound-mail-items.js.map +1 -1
  53. package/resources/inbound-mail-items.mjs.map +1 -1
  54. package/resources/inbound-wire-transfers.d.ts +4 -0
  55. package/resources/inbound-wire-transfers.d.ts.map +1 -1
  56. package/resources/inbound-wire-transfers.js.map +1 -1
  57. package/resources/inbound-wire-transfers.mjs.map +1 -1
  58. package/resources/index.d.ts +11 -8
  59. package/resources/index.d.ts.map +1 -1
  60. package/resources/index.js +15 -6
  61. package/resources/index.js.map +1 -1
  62. package/resources/index.mjs +7 -4
  63. package/resources/index.mjs.map +1 -1
  64. package/resources/{intrafi/account-enrollments.d.ts → intrafi-account-enrollments.d.ts} +17 -17
  65. package/resources/intrafi-account-enrollments.d.ts.map +1 -0
  66. package/resources/{intrafi/account-enrollments.js → intrafi-account-enrollments.js} +11 -11
  67. package/resources/intrafi-account-enrollments.js.map +1 -0
  68. package/resources/{intrafi/account-enrollments.mjs → intrafi-account-enrollments.mjs} +9 -9
  69. package/resources/intrafi-account-enrollments.mjs.map +1 -0
  70. package/resources/{intrafi/balances.d.ts → intrafi-balances.d.ts} +7 -7
  71. package/resources/intrafi-balances.d.ts.map +1 -0
  72. package/resources/{intrafi/balances.js → intrafi-balances.js} +7 -7
  73. package/resources/intrafi-balances.js.map +1 -0
  74. package/resources/{intrafi/balances.mjs → intrafi-balances.mjs} +5 -5
  75. package/resources/intrafi-balances.mjs.map +1 -0
  76. package/resources/{intrafi/exclusions.d.ts → intrafi-exclusions.d.ts} +15 -15
  77. package/resources/intrafi-exclusions.d.ts.map +1 -0
  78. package/resources/{intrafi/exclusions.js → intrafi-exclusions.js} +11 -11
  79. package/resources/intrafi-exclusions.js.map +1 -0
  80. package/resources/{intrafi/exclusions.mjs → intrafi-exclusions.mjs} +9 -9
  81. package/resources/intrafi-exclusions.mjs.map +1 -0
  82. package/resources/lockboxes.d.ts +0 -14
  83. package/resources/lockboxes.d.ts.map +1 -1
  84. package/resources/lockboxes.js.map +1 -1
  85. package/resources/lockboxes.mjs.map +1 -1
  86. package/resources/routing-numbers.d.ts +5 -5
  87. package/resources/routing-numbers.d.ts.map +1 -1
  88. package/resources/routing-numbers.js +5 -5
  89. package/resources/routing-numbers.js.map +1 -1
  90. package/resources/routing-numbers.mjs +3 -3
  91. package/resources/routing-numbers.mjs.map +1 -1
  92. package/resources/simulations/ach-transfers.d.ts +10 -61
  93. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  94. package/resources/simulations/ach-transfers.js +10 -14
  95. package/resources/simulations/ach-transfers.js.map +1 -1
  96. package/resources/simulations/ach-transfers.mjs +10 -14
  97. package/resources/simulations/ach-transfers.mjs.map +1 -1
  98. package/resources/simulations/card-authorization-expirations.d.ts +20 -0
  99. package/resources/simulations/card-authorization-expirations.d.ts.map +1 -0
  100. package/resources/simulations/card-authorization-expirations.js +17 -0
  101. package/resources/simulations/card-authorization-expirations.js.map +1 -0
  102. package/resources/simulations/card-authorization-expirations.mjs +13 -0
  103. package/resources/simulations/card-authorization-expirations.mjs.map +1 -0
  104. package/resources/simulations/card-authorizations.d.ts +91 -0
  105. package/resources/simulations/card-authorizations.d.ts.map +1 -0
  106. package/resources/simulations/{cards.js → card-authorizations.js} +7 -17
  107. package/resources/simulations/card-authorizations.js.map +1 -0
  108. package/resources/simulations/{cards.mjs → card-authorizations.mjs} +5 -15
  109. package/resources/simulations/card-authorizations.mjs.map +1 -0
  110. package/resources/simulations/card-fuel-confirmations.d.ts +27 -0
  111. package/resources/simulations/card-fuel-confirmations.d.ts.map +1 -0
  112. package/resources/simulations/card-fuel-confirmations.js +19 -0
  113. package/resources/simulations/card-fuel-confirmations.js.map +1 -0
  114. package/resources/simulations/card-fuel-confirmations.mjs +15 -0
  115. package/resources/simulations/card-fuel-confirmations.mjs.map +1 -0
  116. package/resources/simulations/card-increments.d.ts +32 -0
  117. package/resources/simulations/card-increments.d.ts.map +1 -0
  118. package/resources/simulations/card-increments.js +18 -0
  119. package/resources/simulations/card-increments.js.map +1 -0
  120. package/resources/simulations/card-increments.mjs +14 -0
  121. package/resources/simulations/card-increments.mjs.map +1 -0
  122. package/resources/simulations/card-reversals.d.ts +28 -0
  123. package/resources/simulations/card-reversals.d.ts.map +1 -0
  124. package/resources/simulations/card-reversals.js +20 -0
  125. package/resources/simulations/card-reversals.js.map +1 -0
  126. package/resources/simulations/card-reversals.mjs +16 -0
  127. package/resources/simulations/card-reversals.mjs.map +1 -0
  128. package/resources/simulations/card-settlements.d.ts +34 -0
  129. package/resources/simulations/card-settlements.d.ts.map +1 -0
  130. package/resources/simulations/card-settlements.js +21 -0
  131. package/resources/simulations/card-settlements.js.map +1 -0
  132. package/resources/simulations/card-settlements.mjs +17 -0
  133. package/resources/simulations/card-settlements.mjs.map +1 -0
  134. package/resources/simulations/inbound-ach-transfers.d.ts +89 -0
  135. package/resources/simulations/inbound-ach-transfers.d.ts.map +1 -0
  136. package/resources/simulations/inbound-ach-transfers.js +26 -0
  137. package/resources/simulations/inbound-ach-transfers.js.map +1 -0
  138. package/resources/simulations/inbound-ach-transfers.mjs +22 -0
  139. package/resources/simulations/inbound-ach-transfers.mjs.map +1 -0
  140. package/resources/simulations/inbound-real-time-payments-transfers.d.ts +71 -0
  141. package/resources/simulations/inbound-real-time-payments-transfers.d.ts.map +1 -0
  142. package/resources/simulations/inbound-real-time-payments-transfers.js +18 -0
  143. package/resources/simulations/inbound-real-time-payments-transfers.js.map +1 -0
  144. package/resources/simulations/inbound-real-time-payments-transfers.mjs +14 -0
  145. package/resources/simulations/inbound-real-time-payments-transfers.mjs.map +1 -0
  146. package/resources/simulations/inbound-wire-transfers.d.ts +99 -0
  147. package/resources/simulations/inbound-wire-transfers.d.ts.map +1 -0
  148. package/resources/simulations/inbound-wire-transfers.js +17 -0
  149. package/resources/simulations/inbound-wire-transfers.js.map +1 -0
  150. package/resources/simulations/inbound-wire-transfers.mjs +13 -0
  151. package/resources/simulations/inbound-wire-transfers.mjs.map +1 -0
  152. package/resources/simulations/index.d.ts +14 -7
  153. package/resources/simulations/index.d.ts.map +1 -1
  154. package/resources/simulations/index.js +21 -7
  155. package/resources/simulations/index.js.map +1 -1
  156. package/resources/simulations/index.mjs +11 -4
  157. package/resources/simulations/index.mjs.map +1 -1
  158. package/resources/simulations/interest-payments.js +1 -1
  159. package/resources/simulations/interest-payments.js.map +1 -1
  160. package/resources/simulations/interest-payments.mjs +1 -1
  161. package/resources/simulations/interest-payments.mjs.map +1 -1
  162. package/resources/simulations/physical-cards.d.ts +3 -3
  163. package/resources/simulations/physical-cards.js +2 -2
  164. package/resources/simulations/physical-cards.mjs +2 -2
  165. package/resources/simulations/real-time-payments-transfers.d.ts +0 -3686
  166. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  167. package/resources/simulations/real-time-payments-transfers.js +0 -7
  168. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  169. package/resources/simulations/real-time-payments-transfers.mjs +0 -7
  170. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  171. package/resources/simulations/simulations.d.ts +67 -118
  172. package/resources/simulations/simulations.d.ts.map +1 -1
  173. package/resources/simulations/simulations.js +45 -54
  174. package/resources/simulations/simulations.js.map +1 -1
  175. package/resources/simulations/simulations.mjs +45 -54
  176. package/resources/simulations/simulations.mjs.map +1 -1
  177. package/resources/simulations/wire-transfers.d.ts +10 -85
  178. package/resources/simulations/wire-transfers.d.ts.map +1 -1
  179. package/resources/simulations/wire-transfers.js +14 -5
  180. package/resources/simulations/wire-transfers.js.map +1 -1
  181. package/resources/simulations/wire-transfers.mjs +14 -5
  182. package/resources/simulations/wire-transfers.mjs.map +1 -1
  183. package/resources/{entities/supplemental-documents.d.ts → supplemental-documents.d.ts} +17 -10
  184. package/resources/supplemental-documents.d.ts.map +1 -0
  185. package/resources/{entities/supplemental-documents.js → supplemental-documents.js} +9 -9
  186. package/resources/supplemental-documents.js.map +1 -0
  187. package/resources/{entities/supplemental-documents.mjs → supplemental-documents.mjs} +7 -7
  188. package/resources/supplemental-documents.mjs.map +1 -0
  189. package/resources/transactions.d.ts +6 -276
  190. package/resources/transactions.d.ts.map +1 -1
  191. package/resources/transactions.js.map +1 -1
  192. package/resources/transactions.mjs.map +1 -1
  193. package/resources/wire-transfers.d.ts +4 -13
  194. package/resources/wire-transfers.d.ts.map +1 -1
  195. package/resources/wire-transfers.js +0 -17
  196. package/resources/wire-transfers.js.map +1 -1
  197. package/resources/wire-transfers.mjs +0 -17
  198. package/resources/wire-transfers.mjs.map +1 -1
  199. package/src/error.ts +0 -8
  200. package/src/index.ts +210 -189
  201. package/src/resources/cards.ts +1 -1
  202. package/src/resources/declined-transactions.ts +0 -297
  203. package/src/resources/{entities/entities.ts → entities.ts} +351 -56
  204. package/src/resources/groups.ts +1 -1
  205. package/src/resources/inbound-ach-transfers.ts +288 -13
  206. package/src/resources/inbound-check-deposits.ts +34 -1
  207. package/src/resources/inbound-mail-items.ts +0 -16
  208. package/src/resources/inbound-wire-transfers.ts +5 -0
  209. package/src/resources/index.ts +32 -14
  210. package/src/resources/{intrafi/account-enrollments.ts → intrafi-account-enrollments.ts} +18 -18
  211. package/src/resources/{intrafi/balances.ts → intrafi-balances.ts} +6 -6
  212. package/src/resources/{intrafi/exclusions.ts → intrafi-exclusions.ts} +19 -16
  213. package/src/resources/lockboxes.ts +0 -16
  214. package/src/resources/routing-numbers.ts +6 -6
  215. package/src/resources/simulations/ach-transfers.ts +15 -76
  216. package/src/resources/simulations/card-authorization-expirations.ts +29 -0
  217. package/src/resources/simulations/card-authorizations.ts +112 -0
  218. package/src/resources/simulations/card-fuel-confirmations.ts +37 -0
  219. package/src/resources/simulations/card-increments.ts +43 -0
  220. package/src/resources/simulations/card-reversals.ts +38 -0
  221. package/src/resources/simulations/card-settlements.ts +45 -0
  222. package/src/resources/simulations/inbound-ach-transfers.ts +124 -0
  223. package/src/resources/simulations/inbound-real-time-payments-transfers.ts +89 -0
  224. package/src/resources/simulations/inbound-wire-transfers.ts +124 -0
  225. package/src/resources/simulations/index.ts +26 -21
  226. package/src/resources/simulations/interest-payments.ts +1 -1
  227. package/src/resources/simulations/physical-cards.ts +5 -5
  228. package/src/resources/simulations/real-time-payments-transfers.ts +0 -4659
  229. package/src/resources/simulations/simulations.ts +80 -157
  230. package/src/resources/simulations/wire-transfers.ts +18 -104
  231. package/src/resources/{entities/supplemental-documents.ts → supplemental-documents.ts} +21 -13
  232. package/src/resources/transactions.ts +5 -350
  233. package/src/resources/wire-transfers.ts +5 -19
  234. package/src/version.ts +1 -1
  235. package/version.d.ts +1 -1
  236. package/version.js +1 -1
  237. package/version.mjs +1 -1
  238. package/resources/entities/beneficial-owners.d.ts +0 -279
  239. package/resources/entities/beneficial-owners.d.ts.map +0 -1
  240. package/resources/entities/beneficial-owners.js +0 -29
  241. package/resources/entities/beneficial-owners.js.map +0 -1
  242. package/resources/entities/beneficial-owners.mjs +0 -25
  243. package/resources/entities/beneficial-owners.mjs.map +0 -1
  244. package/resources/entities/entities.d.ts.map +0 -1
  245. package/resources/entities/entities.js.map +0 -1
  246. package/resources/entities/entities.mjs.map +0 -1
  247. package/resources/entities/index.d.ts +0 -5
  248. package/resources/entities/index.d.ts.map +0 -1
  249. package/resources/entities/index.js +0 -15
  250. package/resources/entities/index.js.map +0 -1
  251. package/resources/entities/index.mjs +0 -6
  252. package/resources/entities/index.mjs.map +0 -1
  253. package/resources/entities/industry-code.d.ts +0 -23
  254. package/resources/entities/industry-code.d.ts.map +0 -1
  255. package/resources/entities/industry-code.js +0 -17
  256. package/resources/entities/industry-code.js.map +0 -1
  257. package/resources/entities/industry-code.mjs +0 -13
  258. package/resources/entities/industry-code.mjs.map +0 -1
  259. package/resources/entities/supplemental-documents.d.ts.map +0 -1
  260. package/resources/entities/supplemental-documents.js.map +0 -1
  261. package/resources/entities/supplemental-documents.mjs.map +0 -1
  262. package/resources/intrafi/account-enrollments.d.ts.map +0 -1
  263. package/resources/intrafi/account-enrollments.js.map +0 -1
  264. package/resources/intrafi/account-enrollments.mjs.map +0 -1
  265. package/resources/intrafi/balances.d.ts.map +0 -1
  266. package/resources/intrafi/balances.js.map +0 -1
  267. package/resources/intrafi/balances.mjs.map +0 -1
  268. package/resources/intrafi/exclusions.d.ts.map +0 -1
  269. package/resources/intrafi/exclusions.js.map +0 -1
  270. package/resources/intrafi/exclusions.mjs.map +0 -1
  271. package/resources/intrafi/index.d.ts +0 -5
  272. package/resources/intrafi/index.d.ts.map +0 -1
  273. package/resources/intrafi/index.js +0 -15
  274. package/resources/intrafi/index.js.map +0 -1
  275. package/resources/intrafi/index.mjs +0 -6
  276. package/resources/intrafi/index.mjs.map +0 -1
  277. package/resources/intrafi/intrafi.d.ts +0 -24
  278. package/resources/intrafi/intrafi.d.ts.map +0 -1
  279. package/resources/intrafi/intrafi.js +0 -48
  280. package/resources/intrafi/intrafi.js.map +0 -1
  281. package/resources/intrafi/intrafi.mjs +0 -21
  282. package/resources/intrafi/intrafi.mjs.map +0 -1
  283. package/resources/simulations/cards.d.ts +0 -1763
  284. package/resources/simulations/cards.d.ts.map +0 -1
  285. package/resources/simulations/cards.js.map +0 -1
  286. package/resources/simulations/cards.mjs.map +0 -1
  287. package/resources/simulations/inbound-international-ach-transfers.d.ts +0 -285
  288. package/resources/simulations/inbound-international-ach-transfers.d.ts.map +0 -1
  289. package/resources/simulations/inbound-international-ach-transfers.js +0 -21
  290. package/resources/simulations/inbound-international-ach-transfers.js.map +0 -1
  291. package/resources/simulations/inbound-international-ach-transfers.mjs +0 -17
  292. package/resources/simulations/inbound-international-ach-transfers.mjs.map +0 -1
  293. package/src/resources/entities/beneficial-owners.ts +0 -346
  294. package/src/resources/entities/index.ts +0 -25
  295. package/src/resources/entities/industry-code.ts +0 -33
  296. package/src/resources/intrafi/index.ts +0 -18
  297. package/src/resources/intrafi/intrafi.ts +0 -29
  298. package/src/resources/simulations/cards.ts +0 -2188
  299. package/src/resources/simulations/inbound-international-ach-transfers.ts +0 -367
@@ -21,4625 +21,6 @@ export class RealTimePaymentsTransfers extends APIResource {
21
21
  { body, ...options },
22
22
  );
23
23
  }
24
-
25
- /**
26
- * Simulates an inbound Real-Time Payments transfer to your account. Real-Time
27
- * Payments are a beta feature.
28
- */
29
- createInbound(
30
- body: RealTimePaymentsTransferCreateInboundParams,
31
- options?: Core.RequestOptions,
32
- ): Core.APIPromise<InboundRealTimePaymentsTransferSimulationResult> {
33
- return this._client.post('/simulations/inbound_real_time_payments_transfers', { body, ...options });
34
- }
35
- }
36
-
37
- /**
38
- * The results of an inbound Real-Time Payments Transfer simulation.
39
- */
40
- export interface InboundRealTimePaymentsTransferSimulationResult {
41
- /**
42
- * If the Real-Time Payments Transfer attempt fails, this will contain the
43
- * resulting [Declined Transaction](#declined-transactions) object. The Declined
44
- * Transaction's `source` will be of
45
- * `category: inbound_real_time_payments_transfer_decline`.
46
- */
47
- declined_transaction: InboundRealTimePaymentsTransferSimulationResult.DeclinedTransaction | null;
48
-
49
- /**
50
- * If the Real-Time Payments Transfer attempt succeeds, this will contain the
51
- * resulting [Transaction](#transactions) object. The Transaction's `source` will
52
- * be of `category: inbound_real_time_payments_transfer_confirmation`.
53
- */
54
- transaction: InboundRealTimePaymentsTransferSimulationResult.Transaction | null;
55
-
56
- /**
57
- * A constant representing the object's type. For this resource it will always be
58
- * `inbound_real_time_payments_transfer_simulation_result`.
59
- */
60
- type: 'inbound_real_time_payments_transfer_simulation_result';
61
- }
62
-
63
- export namespace InboundRealTimePaymentsTransferSimulationResult {
64
- /**
65
- * If the Real-Time Payments Transfer attempt fails, this will contain the
66
- * resulting [Declined Transaction](#declined-transactions) object. The Declined
67
- * Transaction's `source` will be of
68
- * `category: inbound_real_time_payments_transfer_decline`.
69
- */
70
- export interface DeclinedTransaction {
71
- /**
72
- * The Declined Transaction identifier.
73
- */
74
- id: string;
75
-
76
- /**
77
- * The identifier for the Account the Declined Transaction belongs to.
78
- */
79
- account_id: string;
80
-
81
- /**
82
- * The Declined Transaction amount in the minor unit of its currency. For dollars,
83
- * for example, this is cents.
84
- */
85
- amount: number;
86
-
87
- /**
88
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
89
- * Transaction occurred.
90
- */
91
- created_at: string;
92
-
93
- /**
94
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
95
- * Transaction's currency. This will match the currency on the Declined
96
- * Transaction's Account.
97
- *
98
- * - `CAD` - Canadian Dollar (CAD)
99
- * - `CHF` - Swiss Franc (CHF)
100
- * - `EUR` - Euro (EUR)
101
- * - `GBP` - British Pound (GBP)
102
- * - `JPY` - Japanese Yen (JPY)
103
- * - `USD` - US Dollar (USD)
104
- */
105
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
106
-
107
- /**
108
- * This is the description the vendor provides.
109
- */
110
- description: string;
111
-
112
- /**
113
- * The identifier for the route this Declined Transaction came through. Routes are
114
- * things like cards and ACH details.
115
- */
116
- route_id: string | null;
117
-
118
- /**
119
- * The type of the route this Declined Transaction came through.
120
- *
121
- * - `account_number` - An Account Number.
122
- * - `card` - A Card.
123
- * - `lockbox` - A Lockbox.
124
- */
125
- route_type: 'account_number' | 'card' | 'lockbox' | null;
126
-
127
- /**
128
- * This is an object giving more details on the network-level event that caused the
129
- * Declined Transaction. For example, for a card transaction this lists the
130
- * merchant's industry and location. Note that for backwards compatibility reasons,
131
- * additional undocumented keys may appear in this object. These should be treated
132
- * as deprecated and will be removed in the future.
133
- */
134
- source: DeclinedTransaction.Source;
135
-
136
- /**
137
- * A constant representing the object's type. For this resource it will always be
138
- * `declined_transaction`.
139
- */
140
- type: 'declined_transaction';
141
- }
142
-
143
- export namespace DeclinedTransaction {
144
- /**
145
- * This is an object giving more details on the network-level event that caused the
146
- * Declined Transaction. For example, for a card transaction this lists the
147
- * merchant's industry and location. Note that for backwards compatibility reasons,
148
- * additional undocumented keys may appear in this object. These should be treated
149
- * as deprecated and will be removed in the future.
150
- */
151
- export interface Source {
152
- /**
153
- * An ACH Decline object. This field will be present in the JSON response if and
154
- * only if `category` is equal to `ach_decline`.
155
- */
156
- ach_decline: Source.ACHDecline | null;
157
-
158
- /**
159
- * A Card Decline object. This field will be present in the JSON response if and
160
- * only if `category` is equal to `card_decline`.
161
- */
162
- card_decline: Source.CardDecline | null;
163
-
164
- /**
165
- * The type of the resource. We may add additional possible values for this enum
166
- * over time; your application should be able to handle such additions gracefully.
167
- *
168
- * - `ach_decline` - ACH Decline: details will be under the `ach_decline` object.
169
- * - `card_decline` - Card Decline: details will be under the `card_decline`
170
- * object.
171
- * - `check_decline` - Check Decline: details will be under the `check_decline`
172
- * object.
173
- * - `inbound_real_time_payments_transfer_decline` - Inbound Real-Time Payments
174
- * Transfer Decline: details will be under the
175
- * `inbound_real_time_payments_transfer_decline` object.
176
- * - `international_ach_decline` - International ACH Decline: details will be under
177
- * the `international_ach_decline` object.
178
- * - `wire_decline` - Wire Decline: details will be under the `wire_decline`
179
- * object.
180
- * - `check_deposit_rejection` - Check Deposit Rejection: details will be under the
181
- * `check_deposit_rejection` object.
182
- * - `other` - The Declined Transaction was made for an undocumented or deprecated
183
- * reason.
184
- */
185
- category:
186
- | 'ach_decline'
187
- | 'card_decline'
188
- | 'check_decline'
189
- | 'inbound_real_time_payments_transfer_decline'
190
- | 'international_ach_decline'
191
- | 'wire_decline'
192
- | 'check_deposit_rejection'
193
- | 'other';
194
-
195
- /**
196
- * A Check Decline object. This field will be present in the JSON response if and
197
- * only if `category` is equal to `check_decline`.
198
- */
199
- check_decline: Source.CheckDecline | null;
200
-
201
- /**
202
- * A Check Deposit Rejection object. This field will be present in the JSON
203
- * response if and only if `category` is equal to `check_deposit_rejection`.
204
- */
205
- check_deposit_rejection: Source.CheckDepositRejection | null;
206
-
207
- /**
208
- * An Inbound Real-Time Payments Transfer Decline object. This field will be
209
- * present in the JSON response if and only if `category` is equal to
210
- * `inbound_real_time_payments_transfer_decline`.
211
- */
212
- inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
213
-
214
- /**
215
- * An International ACH Decline object. This field will be present in the JSON
216
- * response if and only if `category` is equal to `international_ach_decline`.
217
- */
218
- international_ach_decline: Source.InternationalACHDecline | null;
219
-
220
- /**
221
- * A Wire Decline object. This field will be present in the JSON response if and
222
- * only if `category` is equal to `wire_decline`.
223
- */
224
- wire_decline: Source.WireDecline | null;
225
- }
226
-
227
- export namespace Source {
228
- /**
229
- * An ACH Decline object. This field will be present in the JSON response if and
230
- * only if `category` is equal to `ach_decline`.
231
- */
232
- export interface ACHDecline {
233
- /**
234
- * The ACH Decline's identifier.
235
- */
236
- id: string;
237
-
238
- /**
239
- * The declined amount in the minor unit of the destination account currency. For
240
- * dollars, for example, this is cents.
241
- */
242
- amount: number;
243
-
244
- /**
245
- * The identifier of the Inbound ACH Transfer object associated with this decline.
246
- */
247
- inbound_ach_transfer_id: string;
248
-
249
- /**
250
- * The descriptive date of the transfer.
251
- */
252
- originator_company_descriptive_date: string | null;
253
-
254
- /**
255
- * The additional information included with the transfer.
256
- */
257
- originator_company_discretionary_data: string | null;
258
-
259
- /**
260
- * The identifier of the company that initiated the transfer.
261
- */
262
- originator_company_id: string;
263
-
264
- /**
265
- * The name of the company that initiated the transfer.
266
- */
267
- originator_company_name: string;
268
-
269
- /**
270
- * Why the ACH transfer was declined.
271
- *
272
- * - `ach_route_canceled` - The account number is canceled.
273
- * - `ach_route_disabled` - The account number is disabled.
274
- * - `breaches_limit` - The transaction would cause an Increase limit to be
275
- * exceeded.
276
- * - `credit_entry_refused_by_receiver` - A credit was refused. This is a
277
- * reasonable default reason for decline of credits.
278
- * - `duplicate_return` - A rare return reason. The return this message refers to
279
- * was a duplicate.
280
- * - `entity_not_active` - The account's entity is not active.
281
- * - `field_error` - There was an error with one of the required fields.
282
- * - `group_locked` - Your account is inactive.
283
- * - `insufficient_funds` - Your account contains insufficient funds.
284
- * - `misrouted_return` - A rare return reason. The return this message refers to
285
- * was misrouted.
286
- * - `return_of_erroneous_or_reversing_debit` - The originating financial
287
- * institution made a mistake and this return corrects it.
288
- * - `no_ach_route` - The account number that was debited does not exist.
289
- * - `originator_request` - The originating financial institution asked for this
290
- * transfer to be returned.
291
- * - `transaction_not_allowed` - The transaction is not allowed per Increase's
292
- * terms.
293
- * - `user_initiated` - Your integration declined this transfer via the API.
294
- */
295
- reason:
296
- | 'ach_route_canceled'
297
- | 'ach_route_disabled'
298
- | 'breaches_limit'
299
- | 'credit_entry_refused_by_receiver'
300
- | 'duplicate_return'
301
- | 'entity_not_active'
302
- | 'field_error'
303
- | 'group_locked'
304
- | 'insufficient_funds'
305
- | 'misrouted_return'
306
- | 'return_of_erroneous_or_reversing_debit'
307
- | 'no_ach_route'
308
- | 'originator_request'
309
- | 'transaction_not_allowed'
310
- | 'user_initiated';
311
-
312
- /**
313
- * The id of the receiver of the transfer.
314
- */
315
- receiver_id_number: string | null;
316
-
317
- /**
318
- * The name of the receiver of the transfer.
319
- */
320
- receiver_name: string | null;
321
-
322
- /**
323
- * The trace number of the transfer.
324
- */
325
- trace_number: string;
326
-
327
- /**
328
- * A constant representing the object's type. For this resource it will always be
329
- * `ach_decline`.
330
- */
331
- type: 'ach_decline';
332
- }
333
-
334
- /**
335
- * A Card Decline object. This field will be present in the JSON response if and
336
- * only if `category` is equal to `card_decline`.
337
- */
338
- export interface CardDecline {
339
- /**
340
- * The Card Decline identifier.
341
- */
342
- id: string;
343
-
344
- /**
345
- * Whether this authorization was approved by Increase, the card network through
346
- * stand-in processing, or the user through a real-time decision.
347
- *
348
- * - `user` - This object was actioned by the user through a real-time decision.
349
- * - `increase` - This object was actioned by Increase without user intervention.
350
- * - `network` - This object was actioned by the network, through stand-in
351
- * processing.
352
- */
353
- actioner: 'user' | 'increase' | 'network';
354
-
355
- /**
356
- * The declined amount in the minor unit of the destination account currency. For
357
- * dollars, for example, this is cents.
358
- */
359
- amount: number;
360
-
361
- /**
362
- * The ID of the Card Payment this transaction belongs to.
363
- */
364
- card_payment_id: string;
365
-
366
- /**
367
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
368
- * account currency.
369
- *
370
- * - `CAD` - Canadian Dollar (CAD)
371
- * - `CHF` - Swiss Franc (CHF)
372
- * - `EUR` - Euro (EUR)
373
- * - `GBP` - British Pound (GBP)
374
- * - `JPY` - Japanese Yen (JPY)
375
- * - `USD` - US Dollar (USD)
376
- */
377
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
378
-
379
- /**
380
- * The identifier of the declined transaction created for this Card Decline.
381
- */
382
- declined_transaction_id: string;
383
-
384
- /**
385
- * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
386
- * purchase), the identifier of the token that was used.
387
- */
388
- digital_wallet_token_id: string | null;
389
-
390
- /**
391
- * The merchant identifier (commonly abbreviated as MID) of the merchant the card
392
- * is transacting with.
393
- */
394
- merchant_acceptor_id: string;
395
-
396
- /**
397
- * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
398
- * card is transacting with.
399
- */
400
- merchant_category_code: string | null;
401
-
402
- /**
403
- * The city the merchant resides in.
404
- */
405
- merchant_city: string | null;
406
-
407
- /**
408
- * The country the merchant resides in.
409
- */
410
- merchant_country: string | null;
411
-
412
- /**
413
- * The merchant descriptor of the merchant the card is transacting with.
414
- */
415
- merchant_descriptor: string;
416
-
417
- /**
418
- * The state the merchant resides in.
419
- */
420
- merchant_state: string | null;
421
-
422
- /**
423
- * Fields specific to the `network`.
424
- */
425
- network_details: CardDecline.NetworkDetails;
426
-
427
- /**
428
- * Network-specific identifiers for a specific request or transaction.
429
- */
430
- network_identifiers: CardDecline.NetworkIdentifiers;
431
-
432
- /**
433
- * The risk score generated by the card network. For Visa this is the Visa Advanced
434
- * Authorization risk score, from 0 to 99, where 99 is the riskiest.
435
- */
436
- network_risk_score: number | null;
437
-
438
- /**
439
- * If the authorization was made in-person with a physical card, the Physical Card
440
- * that was used.
441
- */
442
- physical_card_id: string | null;
443
-
444
- /**
445
- * The declined amount in the minor unit of the transaction's presentment currency.
446
- */
447
- presentment_amount: number;
448
-
449
- /**
450
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
451
- * transaction's presentment currency.
452
- */
453
- presentment_currency: string;
454
-
455
- /**
456
- * The processing category describes the intent behind the authorization, such as
457
- * whether it was used for bill payments or an automatic fuel dispenser.
458
- *
459
- * - `account_funding` - Account funding transactions are transactions used to
460
- * e.g., fund an account or transfer funds between accounts.
461
- * - `automatic_fuel_dispenser` - Automatic fuel dispenser authorizations occur
462
- * when a card is used at a gas pump, prior to the actual transaction amount
463
- * being known. They are followed by an advice message that updates the amount of
464
- * the pending transaction.
465
- * - `bill_payment` - A transaction used to pay a bill.
466
- * - `purchase` - A regular purchase.
467
- * - `quasi_cash` - Quasi-cash transactions represent purchases of items which may
468
- * be convertible to cash.
469
- * - `refund` - A refund card authorization, sometimes referred to as a credit
470
- * voucher authorization, where funds are credited to the cardholder.
471
- */
472
- processing_category:
473
- | 'account_funding'
474
- | 'automatic_fuel_dispenser'
475
- | 'bill_payment'
476
- | 'purchase'
477
- | 'quasi_cash'
478
- | 'refund';
479
-
480
- /**
481
- * The identifier of the Real-Time Decision sent to approve or decline this
482
- * transaction.
483
- */
484
- real_time_decision_id: string | null;
485
-
486
- /**
487
- * Why the transaction was declined.
488
- *
489
- * - `card_not_active` - The Card was not active.
490
- * - `physical_card_not_active` - The Physical Card was not active.
491
- * - `entity_not_active` - The account's entity was not active.
492
- * - `group_locked` - The account was inactive.
493
- * - `insufficient_funds` - The Card's Account did not have a sufficient available
494
- * balance.
495
- * - `cvv2_mismatch` - The given CVV2 did not match the card's value.
496
- * - `card_expiration_mismatch` - The given expiration date did not match the
497
- * card's value. Only applies when a CVV2 is present.
498
- * - `transaction_not_allowed` - The attempted card transaction is not allowed per
499
- * Increase's terms.
500
- * - `breaches_limit` - The transaction was blocked by a Limit.
501
- * - `webhook_declined` - Your application declined the transaction via webhook.
502
- * - `webhook_timed_out` - Your application webhook did not respond without the
503
- * required timeout.
504
- * - `declined_by_stand_in_processing` - Declined by stand-in processing.
505
- * - `invalid_physical_card` - The card read had an invalid CVV, dCVV, or
506
- * authorization request cryptogram.
507
- * - `missing_original_authorization` - The original card authorization for this
508
- * incremental authorization does not exist.
509
- * - `suspected_fraud` - The transaction was suspected to be fraudulent. Please
510
- * reach out to support@increase.com for more information.
511
- */
512
- reason:
513
- | 'card_not_active'
514
- | 'physical_card_not_active'
515
- | 'entity_not_active'
516
- | 'group_locked'
517
- | 'insufficient_funds'
518
- | 'cvv2_mismatch'
519
- | 'card_expiration_mismatch'
520
- | 'transaction_not_allowed'
521
- | 'breaches_limit'
522
- | 'webhook_declined'
523
- | 'webhook_timed_out'
524
- | 'declined_by_stand_in_processing'
525
- | 'invalid_physical_card'
526
- | 'missing_original_authorization'
527
- | 'suspected_fraud';
528
-
529
- /**
530
- * Fields related to verification of cardholder-provided values.
531
- */
532
- verification: CardDecline.Verification;
533
- }
534
-
535
- export namespace CardDecline {
536
- /**
537
- * Fields specific to the `network`.
538
- */
539
- export interface NetworkDetails {
540
- /**
541
- * The payment network used to process this card authorization.
542
- *
543
- * - `visa` - Visa
544
- */
545
- category: 'visa';
546
-
547
- /**
548
- * Fields specific to the `visa` network.
549
- */
550
- visa: NetworkDetails.Visa | null;
551
- }
552
-
553
- export namespace NetworkDetails {
554
- /**
555
- * Fields specific to the `visa` network.
556
- */
557
- export interface Visa {
558
- /**
559
- * For electronic commerce transactions, this identifies the level of security used
560
- * in obtaining the customer's payment credential. For mail or telephone order
561
- * transactions, identifies the type of mail or telephone order.
562
- *
563
- * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
564
- * that the transaction is a mail/phone order purchase, not a recurring
565
- * transaction or installment payment. For domestic transactions in the US
566
- * region, this value may also indicate one bill payment transaction in the
567
- * card-present or card-absent environments.
568
- * - `recurring` - Recurring transaction: Payment indicator used to indicate a
569
- * recurring transaction that originates from an acquirer in the US region.
570
- * - `installment` - Installment payment: Payment indicator used to indicate one
571
- * purchase of goods or services that is billed to the account in multiple
572
- * charges over a period of time agreed upon by the cardholder and merchant from
573
- * transactions that originate from an acquirer in the US region.
574
- * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
575
- * indicate that the type of mail/telephone order is unknown.
576
- * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
577
- * indicate that the electronic commerce transaction has been authenticated using
578
- * e.g., 3-D Secure
579
- * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
580
- * Non-authenticated security transaction at a 3-D Secure-capable merchant, and
581
- * merchant attempted to authenticate the cardholder using 3-D Secure: Use to
582
- * identify an electronic commerce transaction where the merchant attempted to
583
- * authenticate the cardholder using 3-D Secure, but was unable to complete the
584
- * authentication because the issuer or cardholder does not participate in the
585
- * 3-D Secure program.
586
- * - `non_authenticated_security_transaction` - Non-authenticated security
587
- * transaction: Use to identify an electronic commerce transaction that uses data
588
- * encryption for security however , cardholder authentication is not performed
589
- * using 3-D Secure.
590
- * - `non_secure_transaction` - Non-secure transaction: Use to identify an
591
- * electronic commerce transaction that has no data protection.
592
- */
593
- electronic_commerce_indicator:
594
- | 'mail_phone_order'
595
- | 'recurring'
596
- | 'installment'
597
- | 'unknown_mail_phone_order'
598
- | 'secure_electronic_commerce'
599
- | 'non_authenticated_security_transaction_at_3ds_capable_merchant'
600
- | 'non_authenticated_security_transaction'
601
- | 'non_secure_transaction'
602
- | null;
603
-
604
- /**
605
- * The method used to enter the cardholder's primary account number and card
606
- * expiration date.
607
- *
608
- * - `unknown` - Unknown
609
- * - `manual` - Manual key entry
610
- * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
611
- * value
612
- * - `optical_code` - Optical code
613
- * - `integrated_circuit_card` - Contact chip card
614
- * - `contactless` - Contactless read of chip card
615
- * - `credential_on_file` - Transaction initiated using a credential that has
616
- * previously been stored on file
617
- * - `magnetic_stripe` - Magnetic stripe read
618
- * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
619
- * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
620
- * verification value
621
- */
622
- point_of_service_entry_mode:
623
- | 'unknown'
624
- | 'manual'
625
- | 'magnetic_stripe_no_cvv'
626
- | 'optical_code'
627
- | 'integrated_circuit_card'
628
- | 'contactless'
629
- | 'credential_on_file'
630
- | 'magnetic_stripe'
631
- | 'contactless_magnetic_stripe'
632
- | 'integrated_circuit_card_no_cvv'
633
- | null;
634
- }
635
- }
636
-
637
- /**
638
- * Network-specific identifiers for a specific request or transaction.
639
- */
640
- export interface NetworkIdentifiers {
641
- /**
642
- * A life-cycle identifier used across e.g., an authorization and a reversal.
643
- * Expected to be unique per acquirer within a window of time. For some card
644
- * networks the retrieval reference number includes the trace counter.
645
- */
646
- retrieval_reference_number: string | null;
647
-
648
- /**
649
- * A counter used to verify an individual authorization. Expected to be unique per
650
- * acquirer within a window of time.
651
- */
652
- trace_number: string | null;
653
-
654
- /**
655
- * A globally unique transaction identifier provided by the card network, used
656
- * across multiple life-cycle requests.
657
- */
658
- transaction_id: string | null;
659
- }
660
-
661
- /**
662
- * Fields related to verification of cardholder-provided values.
663
- */
664
- export interface Verification {
665
- /**
666
- * Fields related to verification of the Card Verification Code, a 3-digit code on
667
- * the back of the card.
668
- */
669
- card_verification_code: Verification.CardVerificationCode;
670
-
671
- /**
672
- * Cardholder address provided in the authorization request and the address on file
673
- * we verified it against.
674
- */
675
- cardholder_address: Verification.CardholderAddress;
676
- }
677
-
678
- export namespace Verification {
679
- /**
680
- * Fields related to verification of the Card Verification Code, a 3-digit code on
681
- * the back of the card.
682
- */
683
- export interface CardVerificationCode {
684
- /**
685
- * The result of verifying the Card Verification Code.
686
- *
687
- * - `not_checked` - No card verification code was provided in the authorization
688
- * request.
689
- * - `match` - The card verification code matched the one on file.
690
- * - `no_match` - The card verification code did not match the one on file.
691
- */
692
- result: 'not_checked' | 'match' | 'no_match';
693
- }
694
-
695
- /**
696
- * Cardholder address provided in the authorization request and the address on file
697
- * we verified it against.
698
- */
699
- export interface CardholderAddress {
700
- /**
701
- * Line 1 of the address on file for the cardholder.
702
- */
703
- actual_line1: string | null;
704
-
705
- /**
706
- * The postal code of the address on file for the cardholder.
707
- */
708
- actual_postal_code: string | null;
709
-
710
- /**
711
- * The cardholder address line 1 provided for verification in the authorization
712
- * request.
713
- */
714
- provided_line1: string | null;
715
-
716
- /**
717
- * The postal code provided for verification in the authorization request.
718
- */
719
- provided_postal_code: string | null;
720
-
721
- /**
722
- * The address verification result returned to the card network.
723
- *
724
- * - `not_checked` - No adress was provided in the authorization request.
725
- * - `postal_code_match_address_not_checked` - Postal code matches, but the street
726
- * address was not verified.
727
- * - `postal_code_match_address_no_match` - Postal code matches, but the street
728
- * address does not match.
729
- * - `postal_code_no_match_address_match` - Postal code does not match, but the
730
- * street address matches.
731
- * - `match` - Postal code and street address match.
732
- * - `no_match` - Postal code and street address do not match.
733
- */
734
- result:
735
- | 'not_checked'
736
- | 'postal_code_match_address_not_checked'
737
- | 'postal_code_match_address_no_match'
738
- | 'postal_code_no_match_address_match'
739
- | 'match'
740
- | 'no_match';
741
- }
742
- }
743
- }
744
-
745
- /**
746
- * A Check Decline object. This field will be present in the JSON response if and
747
- * only if `category` is equal to `check_decline`.
748
- */
749
- export interface CheckDecline {
750
- /**
751
- * The declined amount in the minor unit of the destination account currency. For
752
- * dollars, for example, this is cents.
753
- */
754
- amount: number;
755
-
756
- /**
757
- * A computer-readable number printed on the MICR line of business checks, usually
758
- * the check number. This is useful for positive pay checks, but can be unreliably
759
- * transmitted by the bank of first deposit.
760
- */
761
- auxiliary_on_us: string | null;
762
-
763
- /**
764
- * The identifier of the API File object containing an image of the back of the
765
- * declined check.
766
- */
767
- back_image_file_id: string | null;
768
-
769
- /**
770
- * The identifier of the Check Transfer object associated with this decline.
771
- */
772
- check_transfer_id: string | null;
773
-
774
- /**
775
- * The identifier of the API File object containing an image of the front of the
776
- * declined check.
777
- */
778
- front_image_file_id: string | null;
779
-
780
- /**
781
- * The identifier of the Inbound Check Deposit object associated with this decline.
782
- */
783
- inbound_check_deposit_id: string | null;
784
-
785
- /**
786
- * Why the check was declined.
787
- *
788
- * - `ach_route_disabled` - The account number is disabled.
789
- * - `ach_route_canceled` - The account number is canceled.
790
- * - `altered_or_fictitious` - The deposited check was altered or fictitious.
791
- * - `breaches_limit` - The transaction would cause a limit to be exceeded.
792
- * - `entity_not_active` - The account's entity is not active.
793
- * - `group_locked` - Your account is inactive.
794
- * - `insufficient_funds` - Your account contains insufficient funds.
795
- * - `stop_payment_requested` - Stop payment requested for this check.
796
- * - `duplicate_presentment` - The check was a duplicate deposit.
797
- * - `not_authorized` - The check was not authorized.
798
- * - `amount_mismatch` - The amount the receiving bank is attempting to deposit
799
- * does not match the amount on the check.
800
- * - `not_our_item` - The check attempting to be deposited does not belong to
801
- * Increase.
802
- * - `no_account_number_found` - The account number on the check does not exist at
803
- * Increase.
804
- * - `refer_to_image` - The check is not readable. Please refer to the image.
805
- * - `unable_to_process` - The check cannot be processed. This is rare: please
806
- * contact support.
807
- * - `user_initiated` - Your integration declined this check via the API.
808
- */
809
- reason:
810
- | 'ach_route_disabled'
811
- | 'ach_route_canceled'
812
- | 'altered_or_fictitious'
813
- | 'breaches_limit'
814
- | 'entity_not_active'
815
- | 'group_locked'
816
- | 'insufficient_funds'
817
- | 'stop_payment_requested'
818
- | 'duplicate_presentment'
819
- | 'not_authorized'
820
- | 'amount_mismatch'
821
- | 'not_our_item'
822
- | 'no_account_number_found'
823
- | 'refer_to_image'
824
- | 'unable_to_process'
825
- | 'user_initiated';
826
- }
827
-
828
- /**
829
- * A Check Deposit Rejection object. This field will be present in the JSON
830
- * response if and only if `category` is equal to `check_deposit_rejection`.
831
- */
832
- export interface CheckDepositRejection {
833
- /**
834
- * The rejected amount in the minor unit of check's currency. For dollars, for
835
- * example, this is cents.
836
- */
837
- amount: number;
838
-
839
- /**
840
- * The identifier of the Check Deposit that was rejected.
841
- */
842
- check_deposit_id: string;
843
-
844
- /**
845
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
846
- * currency.
847
- *
848
- * - `CAD` - Canadian Dollar (CAD)
849
- * - `CHF` - Swiss Franc (CHF)
850
- * - `EUR` - Euro (EUR)
851
- * - `GBP` - British Pound (GBP)
852
- * - `JPY` - Japanese Yen (JPY)
853
- * - `USD` - US Dollar (USD)
854
- */
855
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
856
-
857
- /**
858
- * Why the check deposit was rejected.
859
- *
860
- * - `incomplete_image` - The check's image is incomplete.
861
- * - `duplicate` - This is a duplicate check submission.
862
- * - `poor_image_quality` - This check has poor image quality.
863
- * - `incorrect_amount` - The check was deposited with the incorrect amount.
864
- * - `incorrect_recipient` - The check is made out to someone other than the
865
- * account holder.
866
- * - `not_eligible_for_mobile_deposit` - This check was not eligible for mobile
867
- * deposit.
868
- * - `missing_required_data_elements` - This check is missing at least one required
869
- * field.
870
- * - `suspected_fraud` - This check is suspected to be fraudulent.
871
- * - `deposit_window_expired` - This check's deposit window has expired.
872
- * - `unknown` - The check was rejected for an unknown reason.
873
- */
874
- reason:
875
- | 'incomplete_image'
876
- | 'duplicate'
877
- | 'poor_image_quality'
878
- | 'incorrect_amount'
879
- | 'incorrect_recipient'
880
- | 'not_eligible_for_mobile_deposit'
881
- | 'missing_required_data_elements'
882
- | 'suspected_fraud'
883
- | 'deposit_window_expired'
884
- | 'unknown';
885
-
886
- /**
887
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
888
- * the check deposit was rejected.
889
- */
890
- rejected_at: string;
891
- }
892
-
893
- /**
894
- * An Inbound Real-Time Payments Transfer Decline object. This field will be
895
- * present in the JSON response if and only if `category` is equal to
896
- * `inbound_real_time_payments_transfer_decline`.
897
- */
898
- export interface InboundRealTimePaymentsTransferDecline {
899
- /**
900
- * The declined amount in the minor unit of the destination account currency. For
901
- * dollars, for example, this is cents.
902
- */
903
- amount: number;
904
-
905
- /**
906
- * The name the sender of the transfer specified as the recipient of the transfer.
907
- */
908
- creditor_name: string;
909
-
910
- /**
911
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
912
- * transfer's currency. This will always be "USD" for a Real-Time Payments
913
- * transfer.
914
- *
915
- * - `CAD` - Canadian Dollar (CAD)
916
- * - `CHF` - Swiss Franc (CHF)
917
- * - `EUR` - Euro (EUR)
918
- * - `GBP` - British Pound (GBP)
919
- * - `JPY` - Japanese Yen (JPY)
920
- * - `USD` - US Dollar (USD)
921
- */
922
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
923
-
924
- /**
925
- * The account number of the account that sent the transfer.
926
- */
927
- debtor_account_number: string;
928
-
929
- /**
930
- * The name provided by the sender of the transfer.
931
- */
932
- debtor_name: string;
933
-
934
- /**
935
- * The routing number of the account that sent the transfer.
936
- */
937
- debtor_routing_number: string;
938
-
939
- /**
940
- * Why the transfer was declined.
941
- *
942
- * - `account_number_canceled` - The account number is canceled.
943
- * - `account_number_disabled` - The account number is disabled.
944
- * - `account_restricted` - Your account is restricted.
945
- * - `group_locked` - Your account is inactive.
946
- * - `entity_not_active` - The account's entity is not active.
947
- * - `real_time_payments_not_enabled` - Your account is not enabled to receive
948
- * Real-Time Payments transfers.
949
- */
950
- reason:
951
- | 'account_number_canceled'
952
- | 'account_number_disabled'
953
- | 'account_restricted'
954
- | 'group_locked'
955
- | 'entity_not_active'
956
- | 'real_time_payments_not_enabled';
957
-
958
- /**
959
- * Additional information included with the transfer.
960
- */
961
- remittance_information: string | null;
962
-
963
- /**
964
- * The Real-Time Payments network identification of the declined transfer.
965
- */
966
- transaction_identification: string;
967
- }
968
-
969
- /**
970
- * An International ACH Decline object. This field will be present in the JSON
971
- * response if and only if `category` is equal to `international_ach_decline`.
972
- */
973
- export interface InternationalACHDecline {
974
- /**
975
- * The declined amount in the minor unit of the destination account currency. For
976
- * dollars, for example, this is cents.
977
- */
978
- amount: number;
979
-
980
- /**
981
- * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
982
- * country code of the destination country.
983
- */
984
- destination_country_code: string;
985
-
986
- /**
987
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
988
- * destination bank account.
989
- */
990
- destination_currency_code: string;
991
-
992
- /**
993
- * A description of how the foreign exchange rate was calculated.
994
- *
995
- * - `fixed_to_variable` - The originator chose an amount in their own currency.
996
- * The settled amount in USD was converted using the exchange rate.
997
- * - `variable_to_fixed` - The originator chose an amount to settle in USD. The
998
- * originator's amount was variable; known only after the foreign exchange
999
- * conversion.
1000
- * - `fixed_to_fixed` - The amount was originated and settled as a fixed amount in
1001
- * USD. There is no foreign exchange conversion.
1002
- */
1003
- foreign_exchange_indicator: 'fixed_to_variable' | 'variable_to_fixed' | 'fixed_to_fixed';
1004
-
1005
- /**
1006
- * Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a
1007
- * reference to a well-known rate.
1008
- */
1009
- foreign_exchange_reference: string | null;
1010
-
1011
- /**
1012
- * An instruction of how to interpret the `foreign_exchange_reference` field for
1013
- * this Transaction.
1014
- *
1015
- * - `foreign_exchange_rate` - The ACH file contains a foreign exchange rate.
1016
- * - `foreign_exchange_reference_number` - The ACH file contains a reference to a
1017
- * well-known foreign exchange rate.
1018
- * - `blank` - There is no foreign exchange for this transfer, so the
1019
- * `foreign_exchange_reference` field is blank.
1020
- */
1021
- foreign_exchange_reference_indicator:
1022
- | 'foreign_exchange_rate'
1023
- | 'foreign_exchange_reference_number'
1024
- | 'blank';
1025
-
1026
- /**
1027
- * The amount in the minor unit of the foreign payment currency. For dollars, for
1028
- * example, this is cents.
1029
- */
1030
- foreign_payment_amount: number;
1031
-
1032
- /**
1033
- * A reference number in the foreign banking infrastructure.
1034
- */
1035
- foreign_trace_number: string | null;
1036
-
1037
- /**
1038
- * The type of transfer. Set by the originator.
1039
- *
1040
- * - `annuity` - Sent as `ANN` in the Nacha file.
1041
- * - `business_or_commercial` - Sent as `BUS` in the Nacha file.
1042
- * - `deposit` - Sent as `DEP` in the Nacha file.
1043
- * - `loan` - Sent as `LOA` in the Nacha file.
1044
- * - `miscellaneous` - Sent as `MIS` in the Nacha file.
1045
- * - `mortgage` - Sent as `MOR` in the Nacha file.
1046
- * - `pension` - Sent as `PEN` in the Nacha file.
1047
- * - `remittance` - Sent as `REM` in the Nacha file.
1048
- * - `rent_or_lease` - Sent as `RLS` in the Nacha file.
1049
- * - `salary_or_payroll` - Sent as `SAL` in the Nacha file.
1050
- * - `tax` - Sent as `TAX` in the Nacha file.
1051
- * - `accounts_receivable` - Sent as `ARC` in the Nacha file.
1052
- * - `back_office_conversion` - Sent as `BOC` in the Nacha file.
1053
- * - `machine_transfer` - Sent as `MTE` in the Nacha file.
1054
- * - `point_of_purchase` - Sent as `POP` in the Nacha file.
1055
- * - `point_of_sale` - Sent as `POS` in the Nacha file.
1056
- * - `represented_check` - Sent as `RCK` in the Nacha file.
1057
- * - `shared_network_transaction` - Sent as `SHR` in the Nacha file.
1058
- * - `telphone_initiated` - Sent as `TEL` in the Nacha file.
1059
- * - `internet_initiated` - Sent as `WEB` in the Nacha file.
1060
- */
1061
- international_transaction_type_code:
1062
- | 'annuity'
1063
- | 'business_or_commercial'
1064
- | 'deposit'
1065
- | 'loan'
1066
- | 'miscellaneous'
1067
- | 'mortgage'
1068
- | 'pension'
1069
- | 'remittance'
1070
- | 'rent_or_lease'
1071
- | 'salary_or_payroll'
1072
- | 'tax'
1073
- | 'accounts_receivable'
1074
- | 'back_office_conversion'
1075
- | 'machine_transfer'
1076
- | 'point_of_purchase'
1077
- | 'point_of_sale'
1078
- | 'represented_check'
1079
- | 'shared_network_transaction'
1080
- | 'telphone_initiated'
1081
- | 'internet_initiated';
1082
-
1083
- /**
1084
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
1085
- * originating bank account.
1086
- */
1087
- originating_currency_code: string;
1088
-
1089
- /**
1090
- * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
1091
- * country code of the originating branch country.
1092
- */
1093
- originating_depository_financial_institution_branch_country: string;
1094
-
1095
- /**
1096
- * An identifier for the originating bank. One of an International Bank Account
1097
- * Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
1098
- * domestic identifier like a US Routing Number.
1099
- */
1100
- originating_depository_financial_institution_id: string;
1101
-
1102
- /**
1103
- * An instruction of how to interpret the
1104
- * `originating_depository_financial_institution_id` field for this Transaction.
1105
- *
1106
- * - `national_clearing_system_number` - A domestic clearing system number. In the
1107
- * US, for example, this is the American Banking Association (ABA) routing
1108
- * number.
1109
- * - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
1110
- * - `iban` - An International Bank Account Number.
1111
- */
1112
- originating_depository_financial_institution_id_qualifier:
1113
- | 'national_clearing_system_number'
1114
- | 'bic_code'
1115
- | 'iban';
1116
-
1117
- /**
1118
- * The name of the originating bank. Sometimes this will refer to an American bank
1119
- * and obscure the correspondent foreign bank.
1120
- */
1121
- originating_depository_financial_institution_name: string;
1122
-
1123
- /**
1124
- * A portion of the originator address. This may be incomplete.
1125
- */
1126
- originator_city: string;
1127
-
1128
- /**
1129
- * A description field set by the originator.
1130
- */
1131
- originator_company_entry_description: string;
1132
-
1133
- /**
1134
- * A portion of the originator address. The
1135
- * [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
1136
- * code of the originator country.
1137
- */
1138
- originator_country: string;
1139
-
1140
- /**
1141
- * An identifier for the originating company. This is generally stable across
1142
- * multiple ACH transfers.
1143
- */
1144
- originator_identification: string;
1145
-
1146
- /**
1147
- * Either the name of the originator or an intermediary money transmitter.
1148
- */
1149
- originator_name: string;
1150
-
1151
- /**
1152
- * A portion of the originator address. This may be incomplete.
1153
- */
1154
- originator_postal_code: string | null;
1155
-
1156
- /**
1157
- * A portion of the originator address. This may be incomplete.
1158
- */
1159
- originator_state_or_province: string | null;
1160
-
1161
- /**
1162
- * A portion of the originator address. This may be incomplete.
1163
- */
1164
- originator_street_address: string;
1165
-
1166
- /**
1167
- * A description field set by the originator.
1168
- */
1169
- payment_related_information: string | null;
1170
-
1171
- /**
1172
- * A description field set by the originator.
1173
- */
1174
- payment_related_information2: string | null;
1175
-
1176
- /**
1177
- * A portion of the receiver address. This may be incomplete.
1178
- */
1179
- receiver_city: string;
1180
-
1181
- /**
1182
- * A portion of the receiver address. The
1183
- * [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
1184
- * code of the receiver country.
1185
- */
1186
- receiver_country: string;
1187
-
1188
- /**
1189
- * An identification number the originator uses for the receiver.
1190
- */
1191
- receiver_identification_number: string | null;
1192
-
1193
- /**
1194
- * A portion of the receiver address. This may be incomplete.
1195
- */
1196
- receiver_postal_code: string | null;
1197
-
1198
- /**
1199
- * A portion of the receiver address. This may be incomplete.
1200
- */
1201
- receiver_state_or_province: string | null;
1202
-
1203
- /**
1204
- * A portion of the receiver address. This may be incomplete.
1205
- */
1206
- receiver_street_address: string;
1207
-
1208
- /**
1209
- * The name of the receiver of the transfer. This is not verified by Increase.
1210
- */
1211
- receiving_company_or_individual_name: string;
1212
-
1213
- /**
1214
- * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
1215
- * country code of the receiving bank country.
1216
- */
1217
- receiving_depository_financial_institution_country: string;
1218
-
1219
- /**
1220
- * An identifier for the receiving bank. One of an International Bank Account
1221
- * Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
1222
- * domestic identifier like a US Routing Number.
1223
- */
1224
- receiving_depository_financial_institution_id: string;
1225
-
1226
- /**
1227
- * An instruction of how to interpret the
1228
- * `receiving_depository_financial_institution_id` field for this Transaction.
1229
- *
1230
- * - `national_clearing_system_number` - A domestic clearing system number. In the
1231
- * US, for example, this is the American Banking Association (ABA) routing
1232
- * number.
1233
- * - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
1234
- * - `iban` - An International Bank Account Number.
1235
- */
1236
- receiving_depository_financial_institution_id_qualifier:
1237
- | 'national_clearing_system_number'
1238
- | 'bic_code'
1239
- | 'iban';
1240
-
1241
- /**
1242
- * The name of the receiving bank, as set by the sending financial institution.
1243
- */
1244
- receiving_depository_financial_institution_name: string;
1245
-
1246
- /**
1247
- * A 15 digit number recorded in the Nacha file and available to both the
1248
- * originating and receiving bank. Along with the amount, date, and originating
1249
- * routing number, this can be used to identify the ACH transfer at either bank.
1250
- * ACH trace numbers are not unique, but are
1251
- * [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).
1252
- */
1253
- trace_number: string;
1254
- }
1255
-
1256
- /**
1257
- * A Wire Decline object. This field will be present in the JSON response if and
1258
- * only if `category` is equal to `wire_decline`.
1259
- */
1260
- export interface WireDecline {
1261
- /**
1262
- * The identifier of the Inbound Wire Transfer that was declined.
1263
- */
1264
- inbound_wire_transfer_id: string;
1265
-
1266
- /**
1267
- * Why the wire transfer was declined.
1268
- *
1269
- * - `account_number_canceled` - The account number is canceled.
1270
- * - `account_number_disabled` - The account number is disabled.
1271
- * - `entity_not_active` - The account's entity is not active.
1272
- * - `group_locked` - Your account is inactive.
1273
- * - `no_account_number` - The beneficiary account number does not exist.
1274
- * - `transaction_not_allowed` - The transaction is not allowed per Increase's
1275
- * terms.
1276
- */
1277
- reason:
1278
- | 'account_number_canceled'
1279
- | 'account_number_disabled'
1280
- | 'entity_not_active'
1281
- | 'group_locked'
1282
- | 'no_account_number'
1283
- | 'transaction_not_allowed';
1284
- }
1285
- }
1286
- }
1287
-
1288
- /**
1289
- * If the Real-Time Payments Transfer attempt succeeds, this will contain the
1290
- * resulting [Transaction](#transactions) object. The Transaction's `source` will
1291
- * be of `category: inbound_real_time_payments_transfer_confirmation`.
1292
- */
1293
- export interface Transaction {
1294
- /**
1295
- * The Transaction identifier.
1296
- */
1297
- id: string;
1298
-
1299
- /**
1300
- * The identifier for the Account the Transaction belongs to.
1301
- */
1302
- account_id: string;
1303
-
1304
- /**
1305
- * The Transaction amount in the minor unit of its currency. For dollars, for
1306
- * example, this is cents.
1307
- */
1308
- amount: number;
1309
-
1310
- /**
1311
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
1312
- * Transaction occurred.
1313
- */
1314
- created_at: string;
1315
-
1316
- /**
1317
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1318
- * Transaction's currency. This will match the currency on the Transaction's
1319
- * Account.
1320
- *
1321
- * - `CAD` - Canadian Dollar (CAD)
1322
- * - `CHF` - Swiss Franc (CHF)
1323
- * - `EUR` - Euro (EUR)
1324
- * - `GBP` - British Pound (GBP)
1325
- * - `JPY` - Japanese Yen (JPY)
1326
- * - `USD` - US Dollar (USD)
1327
- */
1328
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1329
-
1330
- /**
1331
- * An informational message describing this transaction. Use the fields in `source`
1332
- * to get more detailed information. This field appears as the line-item on the
1333
- * statement.
1334
- */
1335
- description: string;
1336
-
1337
- /**
1338
- * The identifier for the route this Transaction came through. Routes are things
1339
- * like cards and ACH details.
1340
- */
1341
- route_id: string | null;
1342
-
1343
- /**
1344
- * The type of the route this Transaction came through.
1345
- *
1346
- * - `account_number` - An Account Number.
1347
- * - `card` - A Card.
1348
- * - `lockbox` - A Lockbox.
1349
- */
1350
- route_type: 'account_number' | 'card' | 'lockbox' | null;
1351
-
1352
- /**
1353
- * This is an object giving more details on the network-level event that caused the
1354
- * Transaction. Note that for backwards compatibility reasons, additional
1355
- * undocumented keys may appear in this object. These should be treated as
1356
- * deprecated and will be removed in the future.
1357
- */
1358
- source: Transaction.Source;
1359
-
1360
- /**
1361
- * A constant representing the object's type. For this resource it will always be
1362
- * `transaction`.
1363
- */
1364
- type: 'transaction';
1365
- }
1366
-
1367
- export namespace Transaction {
1368
- /**
1369
- * This is an object giving more details on the network-level event that caused the
1370
- * Transaction. Note that for backwards compatibility reasons, additional
1371
- * undocumented keys may appear in this object. These should be treated as
1372
- * deprecated and will be removed in the future.
1373
- */
1374
- export interface Source {
1375
- /**
1376
- * An Account Transfer Intention object. This field will be present in the JSON
1377
- * response if and only if `category` is equal to `account_transfer_intention`.
1378
- */
1379
- account_transfer_intention: Source.AccountTransferIntention | null;
1380
-
1381
- /**
1382
- * An ACH Transfer Intention object. This field will be present in the JSON
1383
- * response if and only if `category` is equal to `ach_transfer_intention`.
1384
- */
1385
- ach_transfer_intention: Source.ACHTransferIntention | null;
1386
-
1387
- /**
1388
- * An ACH Transfer Rejection object. This field will be present in the JSON
1389
- * response if and only if `category` is equal to `ach_transfer_rejection`.
1390
- */
1391
- ach_transfer_rejection: Source.ACHTransferRejection | null;
1392
-
1393
- /**
1394
- * An ACH Transfer Return object. This field will be present in the JSON response
1395
- * if and only if `category` is equal to `ach_transfer_return`.
1396
- */
1397
- ach_transfer_return: Source.ACHTransferReturn | null;
1398
-
1399
- /**
1400
- * A Card Dispute Acceptance object. This field will be present in the JSON
1401
- * response if and only if `category` is equal to `card_dispute_acceptance`.
1402
- */
1403
- card_dispute_acceptance: Source.CardDisputeAcceptance | null;
1404
-
1405
- /**
1406
- * A Card Dispute Loss object. This field will be present in the JSON response if
1407
- * and only if `category` is equal to `card_dispute_loss`.
1408
- */
1409
- card_dispute_loss: Source.CardDisputeLoss | null;
1410
-
1411
- /**
1412
- * A Card Refund object. This field will be present in the JSON response if and
1413
- * only if `category` is equal to `card_refund`.
1414
- */
1415
- card_refund: Source.CardRefund | null;
1416
-
1417
- /**
1418
- * A Card Revenue Payment object. This field will be present in the JSON response
1419
- * if and only if `category` is equal to `card_revenue_payment`.
1420
- */
1421
- card_revenue_payment: Source.CardRevenuePayment | null;
1422
-
1423
- /**
1424
- * A Card Settlement object. This field will be present in the JSON response if and
1425
- * only if `category` is equal to `card_settlement`.
1426
- */
1427
- card_settlement: Source.CardSettlement | null;
1428
-
1429
- /**
1430
- * A Cashback Payment object. This field will be present in the JSON response if
1431
- * and only if `category` is equal to `cashback_payment`.
1432
- */
1433
- cashback_payment: Source.CashbackPayment | null;
1434
-
1435
- /**
1436
- * The type of the resource. We may add additional possible values for this enum
1437
- * over time; your application should be able to handle such additions gracefully.
1438
- *
1439
- * - `account_transfer_intention` - Account Transfer Intention: details will be
1440
- * under the `account_transfer_intention` object.
1441
- * - `ach_transfer_intention` - ACH Transfer Intention: details will be under the
1442
- * `ach_transfer_intention` object.
1443
- * - `ach_transfer_rejection` - ACH Transfer Rejection: details will be under the
1444
- * `ach_transfer_rejection` object.
1445
- * - `ach_transfer_return` - ACH Transfer Return: details will be under the
1446
- * `ach_transfer_return` object.
1447
- * - `cashback_payment` - Cashback Payment: details will be under the
1448
- * `cashback_payment` object.
1449
- * - `card_dispute_acceptance` - Card Dispute Acceptance: details will be under the
1450
- * `card_dispute_acceptance` object.
1451
- * - `card_dispute_loss` - Card Dispute Loss: details will be under the
1452
- * `card_dispute_loss` object.
1453
- * - `card_refund` - Card Refund: details will be under the `card_refund` object.
1454
- * - `card_settlement` - Card Settlement: details will be under the
1455
- * `card_settlement` object.
1456
- * - `card_revenue_payment` - Card Revenue Payment: details will be under the
1457
- * `card_revenue_payment` object.
1458
- * - `check_deposit_acceptance` - Check Deposit Acceptance: details will be under
1459
- * the `check_deposit_acceptance` object.
1460
- * - `check_deposit_return` - Check Deposit Return: details will be under the
1461
- * `check_deposit_return` object.
1462
- * - `check_transfer_deposit` - Check Transfer Deposit: details will be under the
1463
- * `check_transfer_deposit` object.
1464
- * - `check_transfer_stop_payment_request` - Check Transfer Stop Payment Request:
1465
- * details will be under the `check_transfer_stop_payment_request` object.
1466
- * - `fee_payment` - Fee Payment: details will be under the `fee_payment` object.
1467
- * - `inbound_ach_transfer` - Inbound ACH Transfer Intention: details will be under
1468
- * the `inbound_ach_transfer` object.
1469
- * - `inbound_ach_transfer_return_intention` - Inbound ACH Transfer Return
1470
- * Intention: details will be under the `inbound_ach_transfer_return_intention`
1471
- * object.
1472
- * - `inbound_check_deposit_return_intention` - Inbound Check Deposit Return
1473
- * Intention: details will be under the `inbound_check_deposit_return_intention`
1474
- * object.
1475
- * - `inbound_international_ach_transfer` - Inbound International ACH Transfer:
1476
- * details will be under the `inbound_international_ach_transfer` object.
1477
- * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real-Time
1478
- * Payments Transfer Confirmation: details will be under the
1479
- * `inbound_real_time_payments_transfer_confirmation` object.
1480
- * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
1481
- * be under the `inbound_wire_drawdown_payment` object.
1482
- * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
1483
- * `inbound_wire_reversal` object.
1484
- * - `inbound_wire_transfer` - Inbound Wire Transfer Intention: details will be
1485
- * under the `inbound_wire_transfer` object.
1486
- * - `inbound_wire_transfer_reversal` - Inbound Wire Transfer Reversal Intention:
1487
- * details will be under the `inbound_wire_transfer_reversal` object.
1488
- * - `interest_payment` - Interest Payment: details will be under the
1489
- * `interest_payment` object.
1490
- * - `internal_source` - Internal Source: details will be under the
1491
- * `internal_source` object.
1492
- * - `real_time_payments_transfer_acknowledgement` - Real-Time Payments Transfer
1493
- * Acknowledgement: details will be under the
1494
- * `real_time_payments_transfer_acknowledgement` object.
1495
- * - `sample_funds` - Sample Funds: details will be under the `sample_funds`
1496
- * object.
1497
- * - `wire_transfer_intention` - Wire Transfer Intention: details will be under the
1498
- * `wire_transfer_intention` object.
1499
- * - `wire_transfer_rejection` - Wire Transfer Rejection: details will be under the
1500
- * `wire_transfer_rejection` object.
1501
- * - `other` - The Transaction was made for an undocumented or deprecated reason.
1502
- */
1503
- category:
1504
- | 'account_transfer_intention'
1505
- | 'ach_transfer_intention'
1506
- | 'ach_transfer_rejection'
1507
- | 'ach_transfer_return'
1508
- | 'cashback_payment'
1509
- | 'card_dispute_acceptance'
1510
- | 'card_dispute_loss'
1511
- | 'card_refund'
1512
- | 'card_settlement'
1513
- | 'card_revenue_payment'
1514
- | 'check_deposit_acceptance'
1515
- | 'check_deposit_return'
1516
- | 'check_transfer_deposit'
1517
- | 'check_transfer_stop_payment_request'
1518
- | 'fee_payment'
1519
- | 'inbound_ach_transfer'
1520
- | 'inbound_ach_transfer_return_intention'
1521
- | 'inbound_check_deposit_return_intention'
1522
- | 'inbound_international_ach_transfer'
1523
- | 'inbound_real_time_payments_transfer_confirmation'
1524
- | 'inbound_wire_drawdown_payment'
1525
- | 'inbound_wire_reversal'
1526
- | 'inbound_wire_transfer'
1527
- | 'inbound_wire_transfer_reversal'
1528
- | 'interest_payment'
1529
- | 'internal_source'
1530
- | 'real_time_payments_transfer_acknowledgement'
1531
- | 'sample_funds'
1532
- | 'wire_transfer_intention'
1533
- | 'wire_transfer_rejection'
1534
- | 'other';
1535
-
1536
- /**
1537
- * A Check Deposit Acceptance object. This field will be present in the JSON
1538
- * response if and only if `category` is equal to `check_deposit_acceptance`.
1539
- */
1540
- check_deposit_acceptance: Source.CheckDepositAcceptance | null;
1541
-
1542
- /**
1543
- * A Check Deposit Return object. This field will be present in the JSON response
1544
- * if and only if `category` is equal to `check_deposit_return`.
1545
- */
1546
- check_deposit_return: Source.CheckDepositReturn | null;
1547
-
1548
- /**
1549
- * A Check Transfer Deposit object. This field will be present in the JSON response
1550
- * if and only if `category` is equal to `check_transfer_deposit`.
1551
- */
1552
- check_transfer_deposit: Source.CheckTransferDeposit | null;
1553
-
1554
- /**
1555
- * A Check Transfer Stop Payment Request object. This field will be present in the
1556
- * JSON response if and only if `category` is equal to
1557
- * `check_transfer_stop_payment_request`.
1558
- */
1559
- check_transfer_stop_payment_request: Source.CheckTransferStopPaymentRequest | null;
1560
-
1561
- /**
1562
- * A Fee Payment object. This field will be present in the JSON response if and
1563
- * only if `category` is equal to `fee_payment`.
1564
- */
1565
- fee_payment: Source.FeePayment | null;
1566
-
1567
- /**
1568
- * An Inbound ACH Transfer Intention object. This field will be present in the JSON
1569
- * response if and only if `category` is equal to `inbound_ach_transfer`.
1570
- */
1571
- inbound_ach_transfer: Source.InboundACHTransfer | null;
1572
-
1573
- /**
1574
- * An Inbound International ACH Transfer object. This field will be present in the
1575
- * JSON response if and only if `category` is equal to
1576
- * `inbound_international_ach_transfer`.
1577
- */
1578
- inbound_international_ach_transfer: Source.InboundInternationalACHTransfer | null;
1579
-
1580
- /**
1581
- * An Inbound Real-Time Payments Transfer Confirmation object. This field will be
1582
- * present in the JSON response if and only if `category` is equal to
1583
- * `inbound_real_time_payments_transfer_confirmation`.
1584
- */
1585
- inbound_real_time_payments_transfer_confirmation: Source.InboundRealTimePaymentsTransferConfirmation | null;
1586
-
1587
- /**
1588
- * An Inbound Wire Drawdown Payment object. This field will be present in the JSON
1589
- * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
1590
- */
1591
- inbound_wire_drawdown_payment: Source.InboundWireDrawdownPayment | null;
1592
-
1593
- /**
1594
- * An Inbound Wire Reversal object. This field will be present in the JSON response
1595
- * if and only if `category` is equal to `inbound_wire_reversal`.
1596
- */
1597
- inbound_wire_reversal: Source.InboundWireReversal | null;
1598
-
1599
- /**
1600
- * An Inbound Wire Transfer Intention object. This field will be present in the
1601
- * JSON response if and only if `category` is equal to `inbound_wire_transfer`.
1602
- */
1603
- inbound_wire_transfer: Source.InboundWireTransfer | null;
1604
-
1605
- /**
1606
- * An Interest Payment object. This field will be present in the JSON response if
1607
- * and only if `category` is equal to `interest_payment`.
1608
- */
1609
- interest_payment: Source.InterestPayment | null;
1610
-
1611
- /**
1612
- * An Internal Source object. This field will be present in the JSON response if
1613
- * and only if `category` is equal to `internal_source`.
1614
- */
1615
- internal_source: Source.InternalSource | null;
1616
-
1617
- /**
1618
- * A Real-Time Payments Transfer Acknowledgement object. This field will be present
1619
- * in the JSON response if and only if `category` is equal to
1620
- * `real_time_payments_transfer_acknowledgement`.
1621
- */
1622
- real_time_payments_transfer_acknowledgement: Source.RealTimePaymentsTransferAcknowledgement | null;
1623
-
1624
- /**
1625
- * A Sample Funds object. This field will be present in the JSON response if and
1626
- * only if `category` is equal to `sample_funds`.
1627
- */
1628
- sample_funds: Source.SampleFunds | null;
1629
-
1630
- /**
1631
- * A Wire Transfer Intention object. This field will be present in the JSON
1632
- * response if and only if `category` is equal to `wire_transfer_intention`.
1633
- */
1634
- wire_transfer_intention: Source.WireTransferIntention | null;
1635
-
1636
- /**
1637
- * A Wire Transfer Rejection object. This field will be present in the JSON
1638
- * response if and only if `category` is equal to `wire_transfer_rejection`.
1639
- */
1640
- wire_transfer_rejection: Source.WireTransferRejection | null;
1641
- }
1642
-
1643
- export namespace Source {
1644
- /**
1645
- * An Account Transfer Intention object. This field will be present in the JSON
1646
- * response if and only if `category` is equal to `account_transfer_intention`.
1647
- */
1648
- export interface AccountTransferIntention {
1649
- /**
1650
- * The pending amount in the minor unit of the transaction's currency. For dollars,
1651
- * for example, this is cents.
1652
- */
1653
- amount: number;
1654
-
1655
- /**
1656
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
1657
- * account currency.
1658
- *
1659
- * - `CAD` - Canadian Dollar (CAD)
1660
- * - `CHF` - Swiss Franc (CHF)
1661
- * - `EUR` - Euro (EUR)
1662
- * - `GBP` - British Pound (GBP)
1663
- * - `JPY` - Japanese Yen (JPY)
1664
- * - `USD` - US Dollar (USD)
1665
- */
1666
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
1667
-
1668
- /**
1669
- * The description you chose to give the transfer.
1670
- */
1671
- description: string;
1672
-
1673
- /**
1674
- * The identifier of the Account to where the Account Transfer was sent.
1675
- */
1676
- destination_account_id: string;
1677
-
1678
- /**
1679
- * The identifier of the Account from where the Account Transfer was sent.
1680
- */
1681
- source_account_id: string;
1682
-
1683
- /**
1684
- * The identifier of the Account Transfer that led to this Pending Transaction.
1685
- */
1686
- transfer_id: string;
1687
- }
1688
-
1689
- /**
1690
- * An ACH Transfer Intention object. This field will be present in the JSON
1691
- * response if and only if `category` is equal to `ach_transfer_intention`.
1692
- */
1693
- export interface ACHTransferIntention {
1694
- /**
1695
- * The account number for the destination account.
1696
- */
1697
- account_number: string;
1698
-
1699
- /**
1700
- * The amount in the minor unit of the transaction's currency. For dollars, for
1701
- * example, this is cents.
1702
- */
1703
- amount: number;
1704
-
1705
- /**
1706
- * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
1707
- * destination account.
1708
- */
1709
- routing_number: string;
1710
-
1711
- /**
1712
- * A description set when the ACH Transfer was created.
1713
- */
1714
- statement_descriptor: string;
1715
-
1716
- /**
1717
- * The identifier of the ACH Transfer that led to this Transaction.
1718
- */
1719
- transfer_id: string;
1720
- }
1721
-
1722
- /**
1723
- * An ACH Transfer Rejection object. This field will be present in the JSON
1724
- * response if and only if `category` is equal to `ach_transfer_rejection`.
1725
- */
1726
- export interface ACHTransferRejection {
1727
- /**
1728
- * The identifier of the ACH Transfer that led to this Transaction.
1729
- */
1730
- transfer_id: string;
1731
- }
1732
-
1733
- /**
1734
- * An ACH Transfer Return object. This field will be present in the JSON response
1735
- * if and only if `category` is equal to `ach_transfer_return`.
1736
- */
1737
- export interface ACHTransferReturn {
1738
- /**
1739
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1740
- * the transfer was created.
1741
- */
1742
- created_at: string;
1743
-
1744
- /**
1745
- * The three character ACH return code, in the range R01 to R85.
1746
- */
1747
- raw_return_reason_code: string;
1748
-
1749
- /**
1750
- * Why the ACH Transfer was returned. This reason code is sent by the receiving
1751
- * bank back to Increase.
1752
- *
1753
- * - `insufficient_fund` - Code R01. Insufficient funds in the receiving account.
1754
- * Sometimes abbreviated to NSF.
1755
- * - `no_account` - Code R03. The account does not exist or the receiving bank was
1756
- * unable to locate it.
1757
- * - `account_closed` - Code R02. The account is closed at the receiving bank.
1758
- * - `invalid_account_number_structure` - Code R04. The account number is invalid
1759
- * at the receiving bank.
1760
- * - `account_frozen_entry_returned_per_ofac_instruction` - Code R16. The account
1761
- * at the receiving bank was frozen per the Office of Foreign Assets Control.
1762
- * - `credit_entry_refused_by_receiver` - Code R23. The receiving bank account
1763
- * refused a credit transfer.
1764
- * - `unauthorized_debit_to_consumer_account_using_corporate_sec_code` - Code R05.
1765
- * The receiving bank rejected because of an incorrect Standard Entry Class code.
1766
- * - `corporate_customer_advised_not_authorized` - Code R29. The corporate customer
1767
- * at the receiving bank reversed the transfer.
1768
- * - `payment_stopped` - Code R08. The receiving bank stopped payment on this
1769
- * transfer.
1770
- * - `non_transaction_account` - Code R20. The receiving bank account does not
1771
- * perform transfers.
1772
- * - `uncollected_funds` - Code R09. The receiving bank account does not have
1773
- * enough available balance for the transfer.
1774
- * - `routing_number_check_digit_error` - Code R28. The routing number is
1775
- * incorrect.
1776
- * - `customer_advised_unauthorized_improper_ineligible_or_incomplete` - Code R10.
1777
- * The customer at the receiving bank reversed the transfer.
1778
- * - `amount_field_error` - Code R19. The amount field is incorrect or too large.
1779
- * - `authorization_revoked_by_customer` - Code R07. The customer at the receiving
1780
- * institution informed their bank that they have revoked authorization for a
1781
- * previously authorized transfer.
1782
- * - `invalid_ach_routing_number` - Code R13. The routing number is invalid.
1783
- * - `file_record_edit_criteria` - Code R17. The receiving bank is unable to
1784
- * process a field in the transfer.
1785
- * - `enr_invalid_individual_name` - Code R45. The individual name field was
1786
- * invalid.
1787
- * - `returned_per_odfi_request` - Code R06. The originating financial institution
1788
- * asked for this transfer to be returned. The receiving bank is complying with
1789
- * the request.
1790
- * - `limited_participation_dfi` - Code R34. The receiving bank's regulatory
1791
- * supervisor has limited their participation in the ACH network.
1792
- * - `incorrectly_coded_outbound_international_payment` - Code R85. The outbound
1793
- * international ACH transfer was incorrect.
1794
- * - `account_sold_to_another_dfi` - Code R12. A rare return reason. The account
1795
- * was sold to another bank.
1796
- * - `addenda_error` - Code R25. The addenda record is incorrect or missing.
1797
- * - `beneficiary_or_account_holder_deceased` - Code R15. A rare return reason. The
1798
- * account holder is deceased.
1799
- * - `customer_advised_not_within_authorization_terms` - Code R11. A rare return
1800
- * reason. The customer authorized some payment to the sender, but this payment
1801
- * was not in error.
1802
- * - `corrected_return` - Code R74. A rare return reason. Sent in response to a
1803
- * return that was returned with code `field_error`. The latest return should
1804
- * include the corrected field(s).
1805
- * - `duplicate_entry` - Code R24. A rare return reason. The receiving bank
1806
- * received an exact duplicate entry with the same trace number and amount.
1807
- * - `duplicate_return` - Code R67. A rare return reason. The return this message
1808
- * refers to was a duplicate.
1809
- * - `enr_duplicate_enrollment` - Code R47. A rare return reason. Only used for US
1810
- * Government agency non-monetary automatic enrollment messages.
1811
- * - `enr_invalid_dfi_account_number` - Code R43. A rare return reason. Only used
1812
- * for US Government agency non-monetary automatic enrollment messages.
1813
- * - `enr_invalid_individual_id_number` - Code R44. A rare return reason. Only used
1814
- * for US Government agency non-monetary automatic enrollment messages.
1815
- * - `enr_invalid_representative_payee_indicator` - Code R46. A rare return reason.
1816
- * Only used for US Government agency non-monetary automatic enrollment messages.
1817
- * - `enr_invalid_transaction_code` - Code R41. A rare return reason. Only used for
1818
- * US Government agency non-monetary automatic enrollment messages.
1819
- * - `enr_return_of_enr_entry` - Code R40. A rare return reason. Only used for US
1820
- * Government agency non-monetary automatic enrollment messages.
1821
- * - `enr_routing_number_check_digit_error` - Code R42. A rare return reason. Only
1822
- * used for US Government agency non-monetary automatic enrollment messages.
1823
- * - `entry_not_processed_by_gateway` - Code R84. A rare return reason. The
1824
- * International ACH Transfer cannot be processed by the gateway.
1825
- * - `field_error` - Code R69. A rare return reason. One or more of the fields in
1826
- * the ACH were malformed.
1827
- * - `foreign_receiving_dfi_unable_to_settle` - Code R83. A rare return reason. The
1828
- * Foreign receiving bank was unable to settle this ACH transfer.
1829
- * - `iat_entry_coding_error` - Code R80. A rare return reason. The International
1830
- * ACH Transfer is malformed.
1831
- * - `improper_effective_entry_date` - Code R18. A rare return reason. The ACH has
1832
- * an improper effective entry date field.
1833
- * - `improper_source_document_source_document_presented` - Code R39. A rare return
1834
- * reason. The source document related to this ACH, usually an ACH check
1835
- * conversion, was presented to the bank.
1836
- * - `invalid_company_id` - Code R21. A rare return reason. The Company ID field of
1837
- * the ACH was invalid.
1838
- * - `invalid_foreign_receiving_dfi_identification` - Code R82. A rare return
1839
- * reason. The foreign receiving bank identifier for an International ACH
1840
- * Transfer was invalid.
1841
- * - `invalid_individual_id_number` - Code R22. A rare return reason. The
1842
- * Individual ID number field of the ACH was invalid.
1843
- * - `item_and_rck_entry_presented_for_payment` - Code R53. A rare return reason.
1844
- * Both the Represented Check ("RCK") entry and the original check were presented
1845
- * to the bank.
1846
- * - `item_related_to_rck_entry_is_ineligible` - Code R51. A rare return reason.
1847
- * The Represented Check ("RCK") entry is ineligible.
1848
- * - `mandatory_field_error` - Code R26. A rare return reason. The ACH is missing a
1849
- * required field.
1850
- * - `misrouted_dishonored_return` - Code R71. A rare return reason. The receiving
1851
- * bank does not recognize the routing number in a dishonored return entry.
1852
- * - `misrouted_return` - Code R61. A rare return reason. The receiving bank does
1853
- * not recognize the routing number in a return entry.
1854
- * - `no_errors_found` - Code R76. A rare return reason. Sent in response to a
1855
- * return, the bank does not find the errors alleged by the returning bank.
1856
- * - `non_acceptance_of_r62_dishonored_return` - Code R77. A rare return reason.
1857
- * The receiving bank does not accept the return of the erroneous debit. The
1858
- * funds are not available at the receiving bank.
1859
- * - `non_participant_in_iat_program` - Code R81. A rare return reason. The
1860
- * receiving bank does not accept International ACH Transfers.
1861
- * - `permissible_return_entry` - Code R31. A rare return reason. A return that has
1862
- * been agreed to be accepted by the receiving bank, despite falling outside of
1863
- * the usual return timeframe.
1864
- * - `permissible_return_entry_not_accepted` - Code R70. A rare return reason. The
1865
- * receiving bank had not approved this return.
1866
- * - `rdfi_non_settlement` - Code R32. A rare return reason. The receiving bank
1867
- * could not settle this transaction.
1868
- * - `rdfi_participant_in_check_truncation_program` - Code R30. A rare return
1869
- * reason. The receiving bank does not accept Check Truncation ACH transfers.
1870
- * - `representative_payee_deceased_or_unable_to_continue_in_that_capacity` - Code
1871
- * R14. A rare return reason. The payee is deceased.
1872
- * - `return_not_a_duplicate` - Code R75. A rare return reason. The originating
1873
- * bank disputes that an earlier `duplicate_entry` return was actually a
1874
- * duplicate.
1875
- * - `return_of_erroneous_or_reversing_debit` - Code R62. A rare return reason. The
1876
- * originating financial institution made a mistake and this return corrects it.
1877
- * - `return_of_improper_credit_entry` - Code R36. A rare return reason. Return of
1878
- * a malformed credit entry.
1879
- * - `return_of_improper_debit_entry` - Code R35. A rare return reason. Return of a
1880
- * malformed debit entry.
1881
- * - `return_of_xck_entry` - Code R33. A rare return reason. Return of a Destroyed
1882
- * Check ("XKC") entry.
1883
- * - `source_document_presented_for_payment` - Code R37. A rare return reason. The
1884
- * source document related to this ACH, usually an ACH check conversion, was
1885
- * presented to the bank.
1886
- * - `state_law_affecting_rck_acceptance` - Code R50. A rare return reason. State
1887
- * law prevents the bank from accepting the Represented Check ("RCK") entry.
1888
- * - `stop_payment_on_item_related_to_rck_entry` - Code R52. A rare return reason.
1889
- * A stop payment was issued on a Represented Check ("RCK") entry.
1890
- * - `stop_payment_on_source_document` - Code R38. A rare return reason. The source
1891
- * attached to the ACH, usually an ACH check conversion, includes a stop payment.
1892
- * - `timely_original_return` - Code R73. A rare return reason. The bank receiving
1893
- * an `untimely_return` believes it was on time.
1894
- * - `trace_number_error` - Code R27. A rare return reason. An ACH return's trace
1895
- * number does not match an originated ACH.
1896
- * - `untimely_dishonored_return` - Code R72. A rare return reason. The dishonored
1897
- * return was sent too late.
1898
- * - `untimely_return` - Code R68. A rare return reason. The return was sent too
1899
- * late.
1900
- */
1901
- return_reason_code:
1902
- | 'insufficient_fund'
1903
- | 'no_account'
1904
- | 'account_closed'
1905
- | 'invalid_account_number_structure'
1906
- | 'account_frozen_entry_returned_per_ofac_instruction'
1907
- | 'credit_entry_refused_by_receiver'
1908
- | 'unauthorized_debit_to_consumer_account_using_corporate_sec_code'
1909
- | 'corporate_customer_advised_not_authorized'
1910
- | 'payment_stopped'
1911
- | 'non_transaction_account'
1912
- | 'uncollected_funds'
1913
- | 'routing_number_check_digit_error'
1914
- | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
1915
- | 'amount_field_error'
1916
- | 'authorization_revoked_by_customer'
1917
- | 'invalid_ach_routing_number'
1918
- | 'file_record_edit_criteria'
1919
- | 'enr_invalid_individual_name'
1920
- | 'returned_per_odfi_request'
1921
- | 'limited_participation_dfi'
1922
- | 'incorrectly_coded_outbound_international_payment'
1923
- | 'account_sold_to_another_dfi'
1924
- | 'addenda_error'
1925
- | 'beneficiary_or_account_holder_deceased'
1926
- | 'customer_advised_not_within_authorization_terms'
1927
- | 'corrected_return'
1928
- | 'duplicate_entry'
1929
- | 'duplicate_return'
1930
- | 'enr_duplicate_enrollment'
1931
- | 'enr_invalid_dfi_account_number'
1932
- | 'enr_invalid_individual_id_number'
1933
- | 'enr_invalid_representative_payee_indicator'
1934
- | 'enr_invalid_transaction_code'
1935
- | 'enr_return_of_enr_entry'
1936
- | 'enr_routing_number_check_digit_error'
1937
- | 'entry_not_processed_by_gateway'
1938
- | 'field_error'
1939
- | 'foreign_receiving_dfi_unable_to_settle'
1940
- | 'iat_entry_coding_error'
1941
- | 'improper_effective_entry_date'
1942
- | 'improper_source_document_source_document_presented'
1943
- | 'invalid_company_id'
1944
- | 'invalid_foreign_receiving_dfi_identification'
1945
- | 'invalid_individual_id_number'
1946
- | 'item_and_rck_entry_presented_for_payment'
1947
- | 'item_related_to_rck_entry_is_ineligible'
1948
- | 'mandatory_field_error'
1949
- | 'misrouted_dishonored_return'
1950
- | 'misrouted_return'
1951
- | 'no_errors_found'
1952
- | 'non_acceptance_of_r62_dishonored_return'
1953
- | 'non_participant_in_iat_program'
1954
- | 'permissible_return_entry'
1955
- | 'permissible_return_entry_not_accepted'
1956
- | 'rdfi_non_settlement'
1957
- | 'rdfi_participant_in_check_truncation_program'
1958
- | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
1959
- | 'return_not_a_duplicate'
1960
- | 'return_of_erroneous_or_reversing_debit'
1961
- | 'return_of_improper_credit_entry'
1962
- | 'return_of_improper_debit_entry'
1963
- | 'return_of_xck_entry'
1964
- | 'source_document_presented_for_payment'
1965
- | 'state_law_affecting_rck_acceptance'
1966
- | 'stop_payment_on_item_related_to_rck_entry'
1967
- | 'stop_payment_on_source_document'
1968
- | 'timely_original_return'
1969
- | 'trace_number_error'
1970
- | 'untimely_dishonored_return'
1971
- | 'untimely_return';
1972
-
1973
- /**
1974
- * A 15 digit number that was generated by the bank that initiated the return. The
1975
- * trace number of the return is different than that of the original transfer. ACH
1976
- * trace numbers are not unique, but along with the amount and date this number can
1977
- * be used to identify the ACH return at the bank that initiated it.
1978
- */
1979
- trace_number: string;
1980
-
1981
- /**
1982
- * The identifier of the Transaction associated with this return.
1983
- */
1984
- transaction_id: string;
1985
-
1986
- /**
1987
- * The identifier of the ACH Transfer associated with this return.
1988
- */
1989
- transfer_id: string;
1990
- }
1991
-
1992
- /**
1993
- * A Card Dispute Acceptance object. This field will be present in the JSON
1994
- * response if and only if `category` is equal to `card_dispute_acceptance`.
1995
- */
1996
- export interface CardDisputeAcceptance {
1997
- /**
1998
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1999
- * the Card Dispute was accepted.
2000
- */
2001
- accepted_at: string;
2002
-
2003
- /**
2004
- * The identifier of the Card Dispute that was accepted.
2005
- */
2006
- card_dispute_id: string;
2007
-
2008
- /**
2009
- * The identifier of the Transaction that was created to return the disputed funds
2010
- * to your account.
2011
- */
2012
- transaction_id: string;
2013
- }
2014
-
2015
- /**
2016
- * A Card Dispute Loss object. This field will be present in the JSON response if
2017
- * and only if `category` is equal to `card_dispute_loss`.
2018
- */
2019
- export interface CardDisputeLoss {
2020
- /**
2021
- * The identifier of the Card Dispute that was lost.
2022
- */
2023
- card_dispute_id: string;
2024
-
2025
- /**
2026
- * Why the Card Dispute was lost.
2027
- */
2028
- explanation: string;
2029
-
2030
- /**
2031
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
2032
- * the Card Dispute was lost.
2033
- */
2034
- lost_at: string;
2035
-
2036
- /**
2037
- * The identifier of the Transaction that was created to debit the disputed funds
2038
- * from your account.
2039
- */
2040
- transaction_id: string;
2041
- }
2042
-
2043
- /**
2044
- * A Card Refund object. This field will be present in the JSON response if and
2045
- * only if `category` is equal to `card_refund`.
2046
- */
2047
- export interface CardRefund {
2048
- /**
2049
- * The Card Refund identifier.
2050
- */
2051
- id: string;
2052
-
2053
- /**
2054
- * The amount in the minor unit of the transaction's settlement currency. For
2055
- * dollars, for example, this is cents.
2056
- */
2057
- amount: number;
2058
-
2059
- /**
2060
- * The ID of the Card Payment this transaction belongs to.
2061
- */
2062
- card_payment_id: string;
2063
-
2064
- /**
2065
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
2066
- * transaction's settlement currency.
2067
- *
2068
- * - `CAD` - Canadian Dollar (CAD)
2069
- * - `CHF` - Swiss Franc (CHF)
2070
- * - `EUR` - Euro (EUR)
2071
- * - `GBP` - British Pound (GBP)
2072
- * - `JPY` - Japanese Yen (JPY)
2073
- * - `USD` - US Dollar (USD)
2074
- */
2075
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
2076
-
2077
- /**
2078
- * The merchant identifier (commonly abbreviated as MID) of the merchant the card
2079
- * is transacting with.
2080
- */
2081
- merchant_acceptor_id: string | null;
2082
-
2083
- /**
2084
- * The 4-digit MCC describing the merchant's business.
2085
- */
2086
- merchant_category_code: string;
2087
-
2088
- /**
2089
- * The city the merchant resides in.
2090
- */
2091
- merchant_city: string | null;
2092
-
2093
- /**
2094
- * The country the merchant resides in.
2095
- */
2096
- merchant_country: string;
2097
-
2098
- /**
2099
- * The name of the merchant.
2100
- */
2101
- merchant_name: string | null;
2102
-
2103
- /**
2104
- * The state the merchant resides in.
2105
- */
2106
- merchant_state: string | null;
2107
-
2108
- /**
2109
- * Network-specific identifiers for this refund.
2110
- */
2111
- network_identifiers: CardRefund.NetworkIdentifiers;
2112
-
2113
- /**
2114
- * The amount in the minor unit of the transaction's presentment currency.
2115
- */
2116
- presentment_amount: number;
2117
-
2118
- /**
2119
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
2120
- * transaction's presentment currency.
2121
- */
2122
- presentment_currency: string;
2123
-
2124
- /**
2125
- * Additional details about the card purchase, such as tax and industry-specific
2126
- * fields.
2127
- */
2128
- purchase_details: CardRefund.PurchaseDetails | null;
2129
-
2130
- /**
2131
- * The identifier of the Transaction associated with this Transaction.
2132
- */
2133
- transaction_id: string;
2134
-
2135
- /**
2136
- * A constant representing the object's type. For this resource it will always be
2137
- * `card_refund`.
2138
- */
2139
- type: 'card_refund';
2140
- }
2141
-
2142
- export namespace CardRefund {
2143
- /**
2144
- * Network-specific identifiers for this refund.
2145
- */
2146
- export interface NetworkIdentifiers {
2147
- /**
2148
- * A network assigned business ID that identifies the acquirer that processed this
2149
- * transaction.
2150
- */
2151
- acquirer_business_id: string;
2152
-
2153
- /**
2154
- * A globally unique identifier for this settlement.
2155
- */
2156
- acquirer_reference_number: string;
2157
-
2158
- /**
2159
- * A globally unique transaction identifier provided by the card network, used
2160
- * across multiple life-cycle requests.
2161
- */
2162
- transaction_id: string | null;
2163
- }
2164
-
2165
- /**
2166
- * Additional details about the card purchase, such as tax and industry-specific
2167
- * fields.
2168
- */
2169
- export interface PurchaseDetails {
2170
- /**
2171
- * Fields specific to car rentals.
2172
- */
2173
- car_rental: PurchaseDetails.CarRental | null;
2174
-
2175
- /**
2176
- * An identifier from the merchant for the customer or consumer.
2177
- */
2178
- customer_reference_identifier: string | null;
2179
-
2180
- /**
2181
- * The state or provincial tax amount in minor units.
2182
- */
2183
- local_tax_amount: number | null;
2184
-
2185
- /**
2186
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
2187
- * assessed.
2188
- */
2189
- local_tax_currency: string | null;
2190
-
2191
- /**
2192
- * Fields specific to lodging.
2193
- */
2194
- lodging: PurchaseDetails.Lodging | null;
2195
-
2196
- /**
2197
- * The national tax amount in minor units.
2198
- */
2199
- national_tax_amount: number | null;
2200
-
2201
- /**
2202
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
2203
- * assessed.
2204
- */
2205
- national_tax_currency: string | null;
2206
-
2207
- /**
2208
- * An identifier from the merchant for the purchase to the issuer and cardholder.
2209
- */
2210
- purchase_identifier: string | null;
2211
-
2212
- /**
2213
- * The format of the purchase identifier.
2214
- *
2215
- * - `free_text` - Free text
2216
- * - `order_number` - Order number
2217
- * - `rental_agreement_number` - Rental agreement number
2218
- * - `hotel_folio_number` - Hotel folio number
2219
- * - `invoice_number` - Invoice number
2220
- */
2221
- purchase_identifier_format:
2222
- | 'free_text'
2223
- | 'order_number'
2224
- | 'rental_agreement_number'
2225
- | 'hotel_folio_number'
2226
- | 'invoice_number'
2227
- | null;
2228
-
2229
- /**
2230
- * Fields specific to travel.
2231
- */
2232
- travel: PurchaseDetails.Travel | null;
2233
- }
2234
-
2235
- export namespace PurchaseDetails {
2236
- /**
2237
- * Fields specific to car rentals.
2238
- */
2239
- export interface CarRental {
2240
- /**
2241
- * Code indicating the vehicle's class.
2242
- */
2243
- car_class_code: string | null;
2244
-
2245
- /**
2246
- * Date the customer picked up the car or, in the case of a no-show or pre-pay
2247
- * transaction, the scheduled pick up date.
2248
- */
2249
- checkout_date: string | null;
2250
-
2251
- /**
2252
- * Daily rate being charged for the vehicle.
2253
- */
2254
- daily_rental_rate_amount: number | null;
2255
-
2256
- /**
2257
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
2258
- * rate.
2259
- */
2260
- daily_rental_rate_currency: string | null;
2261
-
2262
- /**
2263
- * Number of days the vehicle was rented.
2264
- */
2265
- days_rented: number | null;
2266
-
2267
- /**
2268
- * Additional charges (gas, late fee, etc.) being billed.
2269
- *
2270
- * - `no_extra_charge` - No extra charge
2271
- * - `gas` - Gas
2272
- * - `extra_mileage` - Extra mileage
2273
- * - `late_return` - Late return
2274
- * - `one_way_service_fee` - One way service fee
2275
- * - `parking_violation` - Parking violation
2276
- */
2277
- extra_charges:
2278
- | 'no_extra_charge'
2279
- | 'gas'
2280
- | 'extra_mileage'
2281
- | 'late_return'
2282
- | 'one_way_service_fee'
2283
- | 'parking_violation'
2284
- | null;
2285
-
2286
- /**
2287
- * Fuel charges for the vehicle.
2288
- */
2289
- fuel_charges_amount: number | null;
2290
-
2291
- /**
2292
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
2293
- * assessed.
2294
- */
2295
- fuel_charges_currency: string | null;
2296
-
2297
- /**
2298
- * Any insurance being charged for the vehicle.
2299
- */
2300
- insurance_charges_amount: number | null;
2301
-
2302
- /**
2303
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
2304
- * charges assessed.
2305
- */
2306
- insurance_charges_currency: string | null;
2307
-
2308
- /**
2309
- * An indicator that the cardholder is being billed for a reserved vehicle that was
2310
- * not actually rented (that is, a "no-show" charge).
2311
- *
2312
- * - `not_applicable` - Not applicable
2313
- * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
2314
- */
2315
- no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
2316
-
2317
- /**
2318
- * Charges for returning the vehicle at a different location than where it was
2319
- * picked up.
2320
- */
2321
- one_way_drop_off_charges_amount: number | null;
2322
-
2323
- /**
2324
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
2325
- * drop-off charges assessed.
2326
- */
2327
- one_way_drop_off_charges_currency: string | null;
2328
-
2329
- /**
2330
- * Name of the person renting the vehicle.
2331
- */
2332
- renter_name: string | null;
2333
-
2334
- /**
2335
- * Weekly rate being charged for the vehicle.
2336
- */
2337
- weekly_rental_rate_amount: number | null;
2338
-
2339
- /**
2340
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
2341
- * rental rate.
2342
- */
2343
- weekly_rental_rate_currency: string | null;
2344
- }
2345
-
2346
- /**
2347
- * Fields specific to lodging.
2348
- */
2349
- export interface Lodging {
2350
- /**
2351
- * Date the customer checked in.
2352
- */
2353
- check_in_date: string | null;
2354
-
2355
- /**
2356
- * Daily rate being charged for the room.
2357
- */
2358
- daily_room_rate_amount: number | null;
2359
-
2360
- /**
2361
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
2362
- * rate.
2363
- */
2364
- daily_room_rate_currency: string | null;
2365
-
2366
- /**
2367
- * Additional charges (phone, late check-out, etc.) being billed.
2368
- *
2369
- * - `no_extra_charge` - No extra charge
2370
- * - `restaurant` - Restaurant
2371
- * - `gift_shop` - Gift shop
2372
- * - `mini_bar` - Mini bar
2373
- * - `telephone` - Telephone
2374
- * - `other` - Other
2375
- * - `laundry` - Laundry
2376
- */
2377
- extra_charges:
2378
- | 'no_extra_charge'
2379
- | 'restaurant'
2380
- | 'gift_shop'
2381
- | 'mini_bar'
2382
- | 'telephone'
2383
- | 'other'
2384
- | 'laundry'
2385
- | null;
2386
-
2387
- /**
2388
- * Folio cash advances for the room.
2389
- */
2390
- folio_cash_advances_amount: number | null;
2391
-
2392
- /**
2393
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
2394
- * advances.
2395
- */
2396
- folio_cash_advances_currency: string | null;
2397
-
2398
- /**
2399
- * Food and beverage charges for the room.
2400
- */
2401
- food_beverage_charges_amount: number | null;
2402
-
2403
- /**
2404
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
2405
- * beverage charges.
2406
- */
2407
- food_beverage_charges_currency: string | null;
2408
-
2409
- /**
2410
- * Indicator that the cardholder is being billed for a reserved room that was not
2411
- * actually used.
2412
- *
2413
- * - `not_applicable` - Not applicable
2414
- * - `no_show` - No show
2415
- */
2416
- no_show_indicator: 'not_applicable' | 'no_show' | null;
2417
-
2418
- /**
2419
- * Prepaid expenses being charged for the room.
2420
- */
2421
- prepaid_expenses_amount: number | null;
2422
-
2423
- /**
2424
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
2425
- * expenses.
2426
- */
2427
- prepaid_expenses_currency: string | null;
2428
-
2429
- /**
2430
- * Number of nights the room was rented.
2431
- */
2432
- room_nights: number | null;
2433
-
2434
- /**
2435
- * Total room tax being charged.
2436
- */
2437
- total_room_tax_amount: number | null;
2438
-
2439
- /**
2440
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
2441
- * tax.
2442
- */
2443
- total_room_tax_currency: string | null;
2444
-
2445
- /**
2446
- * Total tax being charged for the room.
2447
- */
2448
- total_tax_amount: number | null;
2449
-
2450
- /**
2451
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
2452
- * assessed.
2453
- */
2454
- total_tax_currency: string | null;
2455
- }
2456
-
2457
- /**
2458
- * Fields specific to travel.
2459
- */
2460
- export interface Travel {
2461
- /**
2462
- * Ancillary purchases in addition to the airfare.
2463
- */
2464
- ancillary: Travel.Ancillary | null;
2465
-
2466
- /**
2467
- * Indicates the computerized reservation system used to book the ticket.
2468
- */
2469
- computerized_reservation_system: string | null;
2470
-
2471
- /**
2472
- * Indicates the reason for a credit to the cardholder.
2473
- *
2474
- * - `no_credit` - No credit
2475
- * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
2476
- * ancillary purchase cancellation
2477
- * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
2478
- * Airline ticket and passenger transport ancillary purchase cancellation
2479
- * - `airline_ticket_cancellation` - Airline ticket cancellation
2480
- * - `other` - Other
2481
- * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
2482
- */
2483
- credit_reason_indicator:
2484
- | 'no_credit'
2485
- | 'passenger_transport_ancillary_purchase_cancellation'
2486
- | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
2487
- | 'airline_ticket_cancellation'
2488
- | 'other'
2489
- | 'partial_refund_of_airline_ticket'
2490
- | null;
2491
-
2492
- /**
2493
- * Date of departure.
2494
- */
2495
- departure_date: string | null;
2496
-
2497
- /**
2498
- * Code for the originating city or airport.
2499
- */
2500
- origination_city_airport_code: string | null;
2501
-
2502
- /**
2503
- * Name of the passenger.
2504
- */
2505
- passenger_name: string | null;
2506
-
2507
- /**
2508
- * Indicates whether this ticket is non-refundable.
2509
- *
2510
- * - `no_restrictions` - No restrictions
2511
- * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
2512
- */
2513
- restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
2514
-
2515
- /**
2516
- * Indicates why a ticket was changed.
2517
- *
2518
- * - `none` - None
2519
- * - `change_to_existing_ticket` - Change to existing ticket
2520
- * - `new_ticket` - New ticket
2521
- */
2522
- ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
2523
-
2524
- /**
2525
- * Ticket number.
2526
- */
2527
- ticket_number: string | null;
2528
-
2529
- /**
2530
- * Code for the travel agency if the ticket was issued by a travel agency.
2531
- */
2532
- travel_agency_code: string | null;
2533
-
2534
- /**
2535
- * Name of the travel agency if the ticket was issued by a travel agency.
2536
- */
2537
- travel_agency_name: string | null;
2538
-
2539
- /**
2540
- * Fields specific to each leg of the journey.
2541
- */
2542
- trip_legs: Array<Travel.TripLeg> | null;
2543
- }
2544
-
2545
- export namespace Travel {
2546
- /**
2547
- * Ancillary purchases in addition to the airfare.
2548
- */
2549
- export interface Ancillary {
2550
- /**
2551
- * If this purchase has a connection or relationship to another purchase, such as a
2552
- * baggage fee for a passenger transport ticket, this field should contain the
2553
- * ticket document number for the other purchase.
2554
- */
2555
- connected_ticket_document_number: string | null;
2556
-
2557
- /**
2558
- * Indicates the reason for a credit to the cardholder.
2559
- *
2560
- * - `no_credit` - No credit
2561
- * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
2562
- * ancillary purchase cancellation
2563
- * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
2564
- * Airline ticket and passenger transport ancillary purchase cancellation
2565
- * - `other` - Other
2566
- */
2567
- credit_reason_indicator:
2568
- | 'no_credit'
2569
- | 'passenger_transport_ancillary_purchase_cancellation'
2570
- | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
2571
- | 'other'
2572
- | null;
2573
-
2574
- /**
2575
- * Name of the passenger or description of the ancillary purchase.
2576
- */
2577
- passenger_name_or_description: string | null;
2578
-
2579
- /**
2580
- * Additional travel charges, such as baggage fees.
2581
- */
2582
- services: Array<Ancillary.Service>;
2583
-
2584
- /**
2585
- * Ticket document number.
2586
- */
2587
- ticket_document_number: string | null;
2588
- }
2589
-
2590
- export namespace Ancillary {
2591
- export interface Service {
2592
- /**
2593
- * Category of the ancillary service.
2594
- *
2595
- * - `none` - None
2596
- * - `bundled_service` - Bundled service
2597
- * - `baggage_fee` - Baggage fee
2598
- * - `change_fee` - Change fee
2599
- * - `cargo` - Cargo
2600
- * - `carbon_offset` - Carbon offset
2601
- * - `frequent_flyer` - Frequent flyer
2602
- * - `gift_card` - Gift card
2603
- * - `ground_transport` - Ground transport
2604
- * - `in_flight_entertainment` - In-flight entertainment
2605
- * - `lounge` - Lounge
2606
- * - `medical` - Medical
2607
- * - `meal_beverage` - Meal beverage
2608
- * - `other` - Other
2609
- * - `passenger_assist_fee` - Passenger assist fee
2610
- * - `pets` - Pets
2611
- * - `seat_fees` - Seat fees
2612
- * - `standby` - Standby
2613
- * - `service_fee` - Service fee
2614
- * - `store` - Store
2615
- * - `travel_service` - Travel service
2616
- * - `unaccompanied_travel` - Unaccompanied travel
2617
- * - `upgrades` - Upgrades
2618
- * - `wifi` - Wi-fi
2619
- */
2620
- category:
2621
- | 'none'
2622
- | 'bundled_service'
2623
- | 'baggage_fee'
2624
- | 'change_fee'
2625
- | 'cargo'
2626
- | 'carbon_offset'
2627
- | 'frequent_flyer'
2628
- | 'gift_card'
2629
- | 'ground_transport'
2630
- | 'in_flight_entertainment'
2631
- | 'lounge'
2632
- | 'medical'
2633
- | 'meal_beverage'
2634
- | 'other'
2635
- | 'passenger_assist_fee'
2636
- | 'pets'
2637
- | 'seat_fees'
2638
- | 'standby'
2639
- | 'service_fee'
2640
- | 'store'
2641
- | 'travel_service'
2642
- | 'unaccompanied_travel'
2643
- | 'upgrades'
2644
- | 'wifi'
2645
- | null;
2646
-
2647
- /**
2648
- * Sub-category of the ancillary service, free-form.
2649
- */
2650
- sub_category: string | null;
2651
- }
2652
- }
2653
-
2654
- export interface TripLeg {
2655
- /**
2656
- * Carrier code (e.g., United Airlines, Jet Blue, etc.).
2657
- */
2658
- carrier_code: string | null;
2659
-
2660
- /**
2661
- * Code for the destination city or airport.
2662
- */
2663
- destination_city_airport_code: string | null;
2664
-
2665
- /**
2666
- * Fare basis code.
2667
- */
2668
- fare_basis_code: string | null;
2669
-
2670
- /**
2671
- * Flight number.
2672
- */
2673
- flight_number: string | null;
2674
-
2675
- /**
2676
- * Service class (e.g., first class, business class, etc.).
2677
- */
2678
- service_class: string | null;
2679
-
2680
- /**
2681
- * Indicates whether a stopover is allowed on this ticket.
2682
- *
2683
- * - `none` - None
2684
- * - `stop_over_allowed` - Stop over allowed
2685
- * - `stop_over_not_allowed` - Stop over not allowed
2686
- */
2687
- stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
2688
- }
2689
- }
2690
- }
2691
- }
2692
-
2693
- /**
2694
- * A Card Revenue Payment object. This field will be present in the JSON response
2695
- * if and only if `category` is equal to `card_revenue_payment`.
2696
- */
2697
- export interface CardRevenuePayment {
2698
- /**
2699
- * The amount in the minor unit of the transaction's currency. For dollars, for
2700
- * example, this is cents.
2701
- */
2702
- amount: number;
2703
-
2704
- /**
2705
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
2706
- * currency.
2707
- *
2708
- * - `CAD` - Canadian Dollar (CAD)
2709
- * - `CHF` - Swiss Franc (CHF)
2710
- * - `EUR` - Euro (EUR)
2711
- * - `GBP` - British Pound (GBP)
2712
- * - `JPY` - Japanese Yen (JPY)
2713
- * - `USD` - US Dollar (USD)
2714
- */
2715
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
2716
-
2717
- /**
2718
- * The end of the period for which this transaction paid interest.
2719
- */
2720
- period_end: string;
2721
-
2722
- /**
2723
- * The start of the period for which this transaction paid interest.
2724
- */
2725
- period_start: string;
2726
-
2727
- /**
2728
- * The account the card belonged to.
2729
- */
2730
- transacted_on_account_id: string | null;
2731
- }
2732
-
2733
- /**
2734
- * A Card Settlement object. This field will be present in the JSON response if and
2735
- * only if `category` is equal to `card_settlement`.
2736
- */
2737
- export interface CardSettlement {
2738
- /**
2739
- * The Card Settlement identifier.
2740
- */
2741
- id: string;
2742
-
2743
- /**
2744
- * The amount in the minor unit of the transaction's settlement currency. For
2745
- * dollars, for example, this is cents.
2746
- */
2747
- amount: number;
2748
-
2749
- /**
2750
- * The Card Authorization that was created prior to this Card Settlement, if one
2751
- * exists.
2752
- */
2753
- card_authorization: string | null;
2754
-
2755
- /**
2756
- * The ID of the Card Payment this transaction belongs to.
2757
- */
2758
- card_payment_id: string;
2759
-
2760
- /**
2761
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
2762
- * transaction's settlement currency.
2763
- *
2764
- * - `CAD` - Canadian Dollar (CAD)
2765
- * - `CHF` - Swiss Franc (CHF)
2766
- * - `EUR` - Euro (EUR)
2767
- * - `GBP` - British Pound (GBP)
2768
- * - `JPY` - Japanese Yen (JPY)
2769
- * - `USD` - US Dollar (USD)
2770
- */
2771
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
2772
-
2773
- /**
2774
- * The merchant identifier (commonly abbreviated as MID) of the merchant the card
2775
- * is transacting with.
2776
- */
2777
- merchant_acceptor_id: string | null;
2778
-
2779
- /**
2780
- * The 4-digit MCC describing the merchant's business.
2781
- */
2782
- merchant_category_code: string;
2783
-
2784
- /**
2785
- * The city the merchant resides in.
2786
- */
2787
- merchant_city: string | null;
2788
-
2789
- /**
2790
- * The country the merchant resides in.
2791
- */
2792
- merchant_country: string;
2793
-
2794
- /**
2795
- * The name of the merchant.
2796
- */
2797
- merchant_name: string | null;
2798
-
2799
- /**
2800
- * The state the merchant resides in.
2801
- */
2802
- merchant_state: string | null;
2803
-
2804
- /**
2805
- * Network-specific identifiers for this refund.
2806
- */
2807
- network_identifiers: CardSettlement.NetworkIdentifiers;
2808
-
2809
- /**
2810
- * The identifier of the Pending Transaction associated with this Transaction.
2811
- */
2812
- pending_transaction_id: string | null;
2813
-
2814
- /**
2815
- * The amount in the minor unit of the transaction's presentment currency.
2816
- */
2817
- presentment_amount: number;
2818
-
2819
- /**
2820
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
2821
- * transaction's presentment currency.
2822
- */
2823
- presentment_currency: string;
2824
-
2825
- /**
2826
- * Additional details about the card purchase, such as tax and industry-specific
2827
- * fields.
2828
- */
2829
- purchase_details: CardSettlement.PurchaseDetails | null;
2830
-
2831
- /**
2832
- * The identifier of the Transaction associated with this Transaction.
2833
- */
2834
- transaction_id: string;
2835
-
2836
- /**
2837
- * A constant representing the object's type. For this resource it will always be
2838
- * `card_settlement`.
2839
- */
2840
- type: 'card_settlement';
2841
- }
2842
-
2843
- export namespace CardSettlement {
2844
- /**
2845
- * Network-specific identifiers for this refund.
2846
- */
2847
- export interface NetworkIdentifiers {
2848
- /**
2849
- * A network assigned business ID that identifies the acquirer that processed this
2850
- * transaction.
2851
- */
2852
- acquirer_business_id: string;
2853
-
2854
- /**
2855
- * A globally unique identifier for this settlement.
2856
- */
2857
- acquirer_reference_number: string;
2858
-
2859
- /**
2860
- * A globally unique transaction identifier provided by the card network, used
2861
- * across multiple life-cycle requests.
2862
- */
2863
- transaction_id: string | null;
2864
- }
2865
-
2866
- /**
2867
- * Additional details about the card purchase, such as tax and industry-specific
2868
- * fields.
2869
- */
2870
- export interface PurchaseDetails {
2871
- /**
2872
- * Fields specific to car rentals.
2873
- */
2874
- car_rental: PurchaseDetails.CarRental | null;
2875
-
2876
- /**
2877
- * An identifier from the merchant for the customer or consumer.
2878
- */
2879
- customer_reference_identifier: string | null;
2880
-
2881
- /**
2882
- * The state or provincial tax amount in minor units.
2883
- */
2884
- local_tax_amount: number | null;
2885
-
2886
- /**
2887
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
2888
- * assessed.
2889
- */
2890
- local_tax_currency: string | null;
2891
-
2892
- /**
2893
- * Fields specific to lodging.
2894
- */
2895
- lodging: PurchaseDetails.Lodging | null;
2896
-
2897
- /**
2898
- * The national tax amount in minor units.
2899
- */
2900
- national_tax_amount: number | null;
2901
-
2902
- /**
2903
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
2904
- * assessed.
2905
- */
2906
- national_tax_currency: string | null;
2907
-
2908
- /**
2909
- * An identifier from the merchant for the purchase to the issuer and cardholder.
2910
- */
2911
- purchase_identifier: string | null;
2912
-
2913
- /**
2914
- * The format of the purchase identifier.
2915
- *
2916
- * - `free_text` - Free text
2917
- * - `order_number` - Order number
2918
- * - `rental_agreement_number` - Rental agreement number
2919
- * - `hotel_folio_number` - Hotel folio number
2920
- * - `invoice_number` - Invoice number
2921
- */
2922
- purchase_identifier_format:
2923
- | 'free_text'
2924
- | 'order_number'
2925
- | 'rental_agreement_number'
2926
- | 'hotel_folio_number'
2927
- | 'invoice_number'
2928
- | null;
2929
-
2930
- /**
2931
- * Fields specific to travel.
2932
- */
2933
- travel: PurchaseDetails.Travel | null;
2934
- }
2935
-
2936
- export namespace PurchaseDetails {
2937
- /**
2938
- * Fields specific to car rentals.
2939
- */
2940
- export interface CarRental {
2941
- /**
2942
- * Code indicating the vehicle's class.
2943
- */
2944
- car_class_code: string | null;
2945
-
2946
- /**
2947
- * Date the customer picked up the car or, in the case of a no-show or pre-pay
2948
- * transaction, the scheduled pick up date.
2949
- */
2950
- checkout_date: string | null;
2951
-
2952
- /**
2953
- * Daily rate being charged for the vehicle.
2954
- */
2955
- daily_rental_rate_amount: number | null;
2956
-
2957
- /**
2958
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
2959
- * rate.
2960
- */
2961
- daily_rental_rate_currency: string | null;
2962
-
2963
- /**
2964
- * Number of days the vehicle was rented.
2965
- */
2966
- days_rented: number | null;
2967
-
2968
- /**
2969
- * Additional charges (gas, late fee, etc.) being billed.
2970
- *
2971
- * - `no_extra_charge` - No extra charge
2972
- * - `gas` - Gas
2973
- * - `extra_mileage` - Extra mileage
2974
- * - `late_return` - Late return
2975
- * - `one_way_service_fee` - One way service fee
2976
- * - `parking_violation` - Parking violation
2977
- */
2978
- extra_charges:
2979
- | 'no_extra_charge'
2980
- | 'gas'
2981
- | 'extra_mileage'
2982
- | 'late_return'
2983
- | 'one_way_service_fee'
2984
- | 'parking_violation'
2985
- | null;
2986
-
2987
- /**
2988
- * Fuel charges for the vehicle.
2989
- */
2990
- fuel_charges_amount: number | null;
2991
-
2992
- /**
2993
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
2994
- * assessed.
2995
- */
2996
- fuel_charges_currency: string | null;
2997
-
2998
- /**
2999
- * Any insurance being charged for the vehicle.
3000
- */
3001
- insurance_charges_amount: number | null;
3002
-
3003
- /**
3004
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
3005
- * charges assessed.
3006
- */
3007
- insurance_charges_currency: string | null;
3008
-
3009
- /**
3010
- * An indicator that the cardholder is being billed for a reserved vehicle that was
3011
- * not actually rented (that is, a "no-show" charge).
3012
- *
3013
- * - `not_applicable` - Not applicable
3014
- * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
3015
- */
3016
- no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
3017
-
3018
- /**
3019
- * Charges for returning the vehicle at a different location than where it was
3020
- * picked up.
3021
- */
3022
- one_way_drop_off_charges_amount: number | null;
3023
-
3024
- /**
3025
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
3026
- * drop-off charges assessed.
3027
- */
3028
- one_way_drop_off_charges_currency: string | null;
3029
-
3030
- /**
3031
- * Name of the person renting the vehicle.
3032
- */
3033
- renter_name: string | null;
3034
-
3035
- /**
3036
- * Weekly rate being charged for the vehicle.
3037
- */
3038
- weekly_rental_rate_amount: number | null;
3039
-
3040
- /**
3041
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
3042
- * rental rate.
3043
- */
3044
- weekly_rental_rate_currency: string | null;
3045
- }
3046
-
3047
- /**
3048
- * Fields specific to lodging.
3049
- */
3050
- export interface Lodging {
3051
- /**
3052
- * Date the customer checked in.
3053
- */
3054
- check_in_date: string | null;
3055
-
3056
- /**
3057
- * Daily rate being charged for the room.
3058
- */
3059
- daily_room_rate_amount: number | null;
3060
-
3061
- /**
3062
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
3063
- * rate.
3064
- */
3065
- daily_room_rate_currency: string | null;
3066
-
3067
- /**
3068
- * Additional charges (phone, late check-out, etc.) being billed.
3069
- *
3070
- * - `no_extra_charge` - No extra charge
3071
- * - `restaurant` - Restaurant
3072
- * - `gift_shop` - Gift shop
3073
- * - `mini_bar` - Mini bar
3074
- * - `telephone` - Telephone
3075
- * - `other` - Other
3076
- * - `laundry` - Laundry
3077
- */
3078
- extra_charges:
3079
- | 'no_extra_charge'
3080
- | 'restaurant'
3081
- | 'gift_shop'
3082
- | 'mini_bar'
3083
- | 'telephone'
3084
- | 'other'
3085
- | 'laundry'
3086
- | null;
3087
-
3088
- /**
3089
- * Folio cash advances for the room.
3090
- */
3091
- folio_cash_advances_amount: number | null;
3092
-
3093
- /**
3094
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
3095
- * advances.
3096
- */
3097
- folio_cash_advances_currency: string | null;
3098
-
3099
- /**
3100
- * Food and beverage charges for the room.
3101
- */
3102
- food_beverage_charges_amount: number | null;
3103
-
3104
- /**
3105
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
3106
- * beverage charges.
3107
- */
3108
- food_beverage_charges_currency: string | null;
3109
-
3110
- /**
3111
- * Indicator that the cardholder is being billed for a reserved room that was not
3112
- * actually used.
3113
- *
3114
- * - `not_applicable` - Not applicable
3115
- * - `no_show` - No show
3116
- */
3117
- no_show_indicator: 'not_applicable' | 'no_show' | null;
3118
-
3119
- /**
3120
- * Prepaid expenses being charged for the room.
3121
- */
3122
- prepaid_expenses_amount: number | null;
3123
-
3124
- /**
3125
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
3126
- * expenses.
3127
- */
3128
- prepaid_expenses_currency: string | null;
3129
-
3130
- /**
3131
- * Number of nights the room was rented.
3132
- */
3133
- room_nights: number | null;
3134
-
3135
- /**
3136
- * Total room tax being charged.
3137
- */
3138
- total_room_tax_amount: number | null;
3139
-
3140
- /**
3141
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
3142
- * tax.
3143
- */
3144
- total_room_tax_currency: string | null;
3145
-
3146
- /**
3147
- * Total tax being charged for the room.
3148
- */
3149
- total_tax_amount: number | null;
3150
-
3151
- /**
3152
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
3153
- * assessed.
3154
- */
3155
- total_tax_currency: string | null;
3156
- }
3157
-
3158
- /**
3159
- * Fields specific to travel.
3160
- */
3161
- export interface Travel {
3162
- /**
3163
- * Ancillary purchases in addition to the airfare.
3164
- */
3165
- ancillary: Travel.Ancillary | null;
3166
-
3167
- /**
3168
- * Indicates the computerized reservation system used to book the ticket.
3169
- */
3170
- computerized_reservation_system: string | null;
3171
-
3172
- /**
3173
- * Indicates the reason for a credit to the cardholder.
3174
- *
3175
- * - `no_credit` - No credit
3176
- * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
3177
- * ancillary purchase cancellation
3178
- * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
3179
- * Airline ticket and passenger transport ancillary purchase cancellation
3180
- * - `airline_ticket_cancellation` - Airline ticket cancellation
3181
- * - `other` - Other
3182
- * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
3183
- */
3184
- credit_reason_indicator:
3185
- | 'no_credit'
3186
- | 'passenger_transport_ancillary_purchase_cancellation'
3187
- | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
3188
- | 'airline_ticket_cancellation'
3189
- | 'other'
3190
- | 'partial_refund_of_airline_ticket'
3191
- | null;
3192
-
3193
- /**
3194
- * Date of departure.
3195
- */
3196
- departure_date: string | null;
3197
-
3198
- /**
3199
- * Code for the originating city or airport.
3200
- */
3201
- origination_city_airport_code: string | null;
3202
-
3203
- /**
3204
- * Name of the passenger.
3205
- */
3206
- passenger_name: string | null;
3207
-
3208
- /**
3209
- * Indicates whether this ticket is non-refundable.
3210
- *
3211
- * - `no_restrictions` - No restrictions
3212
- * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
3213
- */
3214
- restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
3215
-
3216
- /**
3217
- * Indicates why a ticket was changed.
3218
- *
3219
- * - `none` - None
3220
- * - `change_to_existing_ticket` - Change to existing ticket
3221
- * - `new_ticket` - New ticket
3222
- */
3223
- ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
3224
-
3225
- /**
3226
- * Ticket number.
3227
- */
3228
- ticket_number: string | null;
3229
-
3230
- /**
3231
- * Code for the travel agency if the ticket was issued by a travel agency.
3232
- */
3233
- travel_agency_code: string | null;
3234
-
3235
- /**
3236
- * Name of the travel agency if the ticket was issued by a travel agency.
3237
- */
3238
- travel_agency_name: string | null;
3239
-
3240
- /**
3241
- * Fields specific to each leg of the journey.
3242
- */
3243
- trip_legs: Array<Travel.TripLeg> | null;
3244
- }
3245
-
3246
- export namespace Travel {
3247
- /**
3248
- * Ancillary purchases in addition to the airfare.
3249
- */
3250
- export interface Ancillary {
3251
- /**
3252
- * If this purchase has a connection or relationship to another purchase, such as a
3253
- * baggage fee for a passenger transport ticket, this field should contain the
3254
- * ticket document number for the other purchase.
3255
- */
3256
- connected_ticket_document_number: string | null;
3257
-
3258
- /**
3259
- * Indicates the reason for a credit to the cardholder.
3260
- *
3261
- * - `no_credit` - No credit
3262
- * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
3263
- * ancillary purchase cancellation
3264
- * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
3265
- * Airline ticket and passenger transport ancillary purchase cancellation
3266
- * - `other` - Other
3267
- */
3268
- credit_reason_indicator:
3269
- | 'no_credit'
3270
- | 'passenger_transport_ancillary_purchase_cancellation'
3271
- | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
3272
- | 'other'
3273
- | null;
3274
-
3275
- /**
3276
- * Name of the passenger or description of the ancillary purchase.
3277
- */
3278
- passenger_name_or_description: string | null;
3279
-
3280
- /**
3281
- * Additional travel charges, such as baggage fees.
3282
- */
3283
- services: Array<Ancillary.Service>;
3284
-
3285
- /**
3286
- * Ticket document number.
3287
- */
3288
- ticket_document_number: string | null;
3289
- }
3290
-
3291
- export namespace Ancillary {
3292
- export interface Service {
3293
- /**
3294
- * Category of the ancillary service.
3295
- *
3296
- * - `none` - None
3297
- * - `bundled_service` - Bundled service
3298
- * - `baggage_fee` - Baggage fee
3299
- * - `change_fee` - Change fee
3300
- * - `cargo` - Cargo
3301
- * - `carbon_offset` - Carbon offset
3302
- * - `frequent_flyer` - Frequent flyer
3303
- * - `gift_card` - Gift card
3304
- * - `ground_transport` - Ground transport
3305
- * - `in_flight_entertainment` - In-flight entertainment
3306
- * - `lounge` - Lounge
3307
- * - `medical` - Medical
3308
- * - `meal_beverage` - Meal beverage
3309
- * - `other` - Other
3310
- * - `passenger_assist_fee` - Passenger assist fee
3311
- * - `pets` - Pets
3312
- * - `seat_fees` - Seat fees
3313
- * - `standby` - Standby
3314
- * - `service_fee` - Service fee
3315
- * - `store` - Store
3316
- * - `travel_service` - Travel service
3317
- * - `unaccompanied_travel` - Unaccompanied travel
3318
- * - `upgrades` - Upgrades
3319
- * - `wifi` - Wi-fi
3320
- */
3321
- category:
3322
- | 'none'
3323
- | 'bundled_service'
3324
- | 'baggage_fee'
3325
- | 'change_fee'
3326
- | 'cargo'
3327
- | 'carbon_offset'
3328
- | 'frequent_flyer'
3329
- | 'gift_card'
3330
- | 'ground_transport'
3331
- | 'in_flight_entertainment'
3332
- | 'lounge'
3333
- | 'medical'
3334
- | 'meal_beverage'
3335
- | 'other'
3336
- | 'passenger_assist_fee'
3337
- | 'pets'
3338
- | 'seat_fees'
3339
- | 'standby'
3340
- | 'service_fee'
3341
- | 'store'
3342
- | 'travel_service'
3343
- | 'unaccompanied_travel'
3344
- | 'upgrades'
3345
- | 'wifi'
3346
- | null;
3347
-
3348
- /**
3349
- * Sub-category of the ancillary service, free-form.
3350
- */
3351
- sub_category: string | null;
3352
- }
3353
- }
3354
-
3355
- export interface TripLeg {
3356
- /**
3357
- * Carrier code (e.g., United Airlines, Jet Blue, etc.).
3358
- */
3359
- carrier_code: string | null;
3360
-
3361
- /**
3362
- * Code for the destination city or airport.
3363
- */
3364
- destination_city_airport_code: string | null;
3365
-
3366
- /**
3367
- * Fare basis code.
3368
- */
3369
- fare_basis_code: string | null;
3370
-
3371
- /**
3372
- * Flight number.
3373
- */
3374
- flight_number: string | null;
3375
-
3376
- /**
3377
- * Service class (e.g., first class, business class, etc.).
3378
- */
3379
- service_class: string | null;
3380
-
3381
- /**
3382
- * Indicates whether a stopover is allowed on this ticket.
3383
- *
3384
- * - `none` - None
3385
- * - `stop_over_allowed` - Stop over allowed
3386
- * - `stop_over_not_allowed` - Stop over not allowed
3387
- */
3388
- stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
3389
- }
3390
- }
3391
- }
3392
- }
3393
-
3394
- /**
3395
- * A Cashback Payment object. This field will be present in the JSON response if
3396
- * and only if `category` is equal to `cashback_payment`.
3397
- */
3398
- export interface CashbackPayment {
3399
- /**
3400
- * The card on which the cashback was accrued.
3401
- */
3402
- accrued_on_card_id: string | null;
3403
-
3404
- /**
3405
- * The amount in the minor unit of the transaction's currency. For dollars, for
3406
- * example, this is cents.
3407
- */
3408
- amount: number;
3409
-
3410
- /**
3411
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
3412
- * currency.
3413
- *
3414
- * - `CAD` - Canadian Dollar (CAD)
3415
- * - `CHF` - Swiss Franc (CHF)
3416
- * - `EUR` - Euro (EUR)
3417
- * - `GBP` - British Pound (GBP)
3418
- * - `JPY` - Japanese Yen (JPY)
3419
- * - `USD` - US Dollar (USD)
3420
- */
3421
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
3422
-
3423
- /**
3424
- * The end of the period for which this transaction paid cashback.
3425
- */
3426
- period_end: string;
3427
-
3428
- /**
3429
- * The start of the period for which this transaction paid cashback.
3430
- */
3431
- period_start: string;
3432
- }
3433
-
3434
- /**
3435
- * A Check Deposit Acceptance object. This field will be present in the JSON
3436
- * response if and only if `category` is equal to `check_deposit_acceptance`.
3437
- */
3438
- export interface CheckDepositAcceptance {
3439
- /**
3440
- * The account number printed on the check.
3441
- */
3442
- account_number: string;
3443
-
3444
- /**
3445
- * The amount to be deposited in the minor unit of the transaction's currency. For
3446
- * dollars, for example, this is cents.
3447
- */
3448
- amount: number;
3449
-
3450
- /**
3451
- * An additional line of metadata printed on the check. This typically includes the
3452
- * check number for business checks.
3453
- */
3454
- auxiliary_on_us: string | null;
3455
-
3456
- /**
3457
- * The ID of the Check Deposit that was accepted.
3458
- */
3459
- check_deposit_id: string;
3460
-
3461
- /**
3462
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
3463
- * transaction's currency.
3464
- *
3465
- * - `CAD` - Canadian Dollar (CAD)
3466
- * - `CHF` - Swiss Franc (CHF)
3467
- * - `EUR` - Euro (EUR)
3468
- * - `GBP` - British Pound (GBP)
3469
- * - `JPY` - Japanese Yen (JPY)
3470
- * - `USD` - US Dollar (USD)
3471
- */
3472
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
3473
-
3474
- /**
3475
- * The routing number printed on the check.
3476
- */
3477
- routing_number: string;
3478
-
3479
- /**
3480
- * The check serial number, if present, for consumer checks. For business checks,
3481
- * the serial number is usually in the `auxiliary_on_us` field.
3482
- */
3483
- serial_number: string | null;
3484
- }
3485
-
3486
- /**
3487
- * A Check Deposit Return object. This field will be present in the JSON response
3488
- * if and only if `category` is equal to `check_deposit_return`.
3489
- */
3490
- export interface CheckDepositReturn {
3491
- /**
3492
- * The amount in the minor unit of the transaction's currency. For dollars, for
3493
- * example, this is cents.
3494
- */
3495
- amount: number;
3496
-
3497
- /**
3498
- * The identifier of the Check Deposit that was returned.
3499
- */
3500
- check_deposit_id: string;
3501
-
3502
- /**
3503
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
3504
- * transaction's currency.
3505
- *
3506
- * - `CAD` - Canadian Dollar (CAD)
3507
- * - `CHF` - Swiss Franc (CHF)
3508
- * - `EUR` - Euro (EUR)
3509
- * - `GBP` - British Pound (GBP)
3510
- * - `JPY` - Japanese Yen (JPY)
3511
- * - `USD` - US Dollar (USD)
3512
- */
3513
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
3514
-
3515
- /**
3516
- * Why this check was returned by the bank holding the account it was drawn
3517
- * against.
3518
- *
3519
- * - `ach_conversion_not_supported` - The check doesn't allow ACH conversion.
3520
- * - `closed_account` - The account is closed.
3521
- * - `duplicate_submission` - The check has already been deposited.
3522
- * - `insufficient_funds` - Insufficient funds
3523
- * - `no_account` - No account was found matching the check details.
3524
- * - `not_authorized` - The check was not authorized.
3525
- * - `stale_dated` - The check is too old.
3526
- * - `stop_payment` - The payment has been stopped by the account holder.
3527
- * - `unknown_reason` - The reason for the return is unknown.
3528
- * - `unmatched_details` - The image doesn't match the details submitted.
3529
- * - `unreadable_image` - The image could not be read.
3530
- * - `endorsement_irregular` - The check endorsement was irregular.
3531
- * - `altered_or_fictitious_item` - The check present was either altered or fake.
3532
- * - `frozen_or_blocked_account` - The account this check is drawn on is frozen.
3533
- * - `post_dated` - The check is post dated.
3534
- * - `endorsement_missing` - The endorsement was missing.
3535
- * - `signature_missing` - The check signature was missing.
3536
- * - `stop_payment_suspect` - The bank suspects a stop payment will be placed.
3537
- * - `unusable_image` - The bank cannot read the image.
3538
- * - `image_fails_security_check` - The check image fails the bank's security
3539
- * check.
3540
- * - `cannot_determine_amount` - The bank cannot determine the amount.
3541
- * - `signature_irregular` - The signature is inconsistent with prior signatures.
3542
- * - `non_cash_item` - The check is a non-cash item and cannot be drawn against the
3543
- * account.
3544
- * - `unable_to_process` - The bank is unable to process this check.
3545
- * - `item_exceeds_dollar_limit` - The check exceeds the bank or customer's limit.
3546
- * - `branch_or_account_sold` - The bank sold this account and no longer services
3547
- * this customer.
3548
- */
3549
- return_reason:
3550
- | 'ach_conversion_not_supported'
3551
- | 'closed_account'
3552
- | 'duplicate_submission'
3553
- | 'insufficient_funds'
3554
- | 'no_account'
3555
- | 'not_authorized'
3556
- | 'stale_dated'
3557
- | 'stop_payment'
3558
- | 'unknown_reason'
3559
- | 'unmatched_details'
3560
- | 'unreadable_image'
3561
- | 'endorsement_irregular'
3562
- | 'altered_or_fictitious_item'
3563
- | 'frozen_or_blocked_account'
3564
- | 'post_dated'
3565
- | 'endorsement_missing'
3566
- | 'signature_missing'
3567
- | 'stop_payment_suspect'
3568
- | 'unusable_image'
3569
- | 'image_fails_security_check'
3570
- | 'cannot_determine_amount'
3571
- | 'signature_irregular'
3572
- | 'non_cash_item'
3573
- | 'unable_to_process'
3574
- | 'item_exceeds_dollar_limit'
3575
- | 'branch_or_account_sold';
3576
-
3577
- /**
3578
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
3579
- * the check deposit was returned.
3580
- */
3581
- returned_at: string;
3582
-
3583
- /**
3584
- * The identifier of the transaction that reversed the original check deposit
3585
- * transaction.
3586
- */
3587
- transaction_id: string;
3588
- }
3589
-
3590
- /**
3591
- * A Check Transfer Deposit object. This field will be present in the JSON response
3592
- * if and only if `category` is equal to `check_transfer_deposit`.
3593
- */
3594
- export interface CheckTransferDeposit {
3595
- /**
3596
- * The identifier of the API File object containing an image of the back of the
3597
- * deposited check.
3598
- */
3599
- back_image_file_id: string | null;
3600
-
3601
- /**
3602
- * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
3603
- * bank depositing this check. In some rare cases, this is not transmitted via
3604
- * Check21 and the value will be null.
3605
- */
3606
- bank_of_first_deposit_routing_number: string | null;
3607
-
3608
- /**
3609
- * When the check was deposited.
3610
- */
3611
- deposited_at: string;
3612
-
3613
- /**
3614
- * The identifier of the API File object containing an image of the front of the
3615
- * deposited check.
3616
- */
3617
- front_image_file_id: string | null;
3618
-
3619
- /**
3620
- * The identifier of the Inbound Check Deposit object associated with this
3621
- * transaction.
3622
- */
3623
- inbound_check_deposit_id: string | null;
3624
-
3625
- /**
3626
- * The identifier of the Transaction object created when the check was deposited.
3627
- */
3628
- transaction_id: string | null;
3629
-
3630
- /**
3631
- * The identifier of the Check Transfer object that was deposited.
3632
- */
3633
- transfer_id: string | null;
3634
-
3635
- /**
3636
- * A constant representing the object's type. For this resource it will always be
3637
- * `check_transfer_deposit`.
3638
- */
3639
- type: 'check_transfer_deposit';
3640
- }
3641
-
3642
- /**
3643
- * A Check Transfer Stop Payment Request object. This field will be present in the
3644
- * JSON response if and only if `category` is equal to
3645
- * `check_transfer_stop_payment_request`.
3646
- */
3647
- export interface CheckTransferStopPaymentRequest {
3648
- /**
3649
- * The reason why this transfer was stopped.
3650
- *
3651
- * - `mail_delivery_failed` - The check could not be delivered.
3652
- * - `rejected_by_increase` - The check was canceled by an Increase operator who
3653
- * will provide details out-of-band.
3654
- * - `not_authorized` - The check was not authorized.
3655
- * - `unknown` - The check was stopped for another reason.
3656
- */
3657
- reason: 'mail_delivery_failed' | 'rejected_by_increase' | 'not_authorized' | 'unknown';
3658
-
3659
- /**
3660
- * The time the stop-payment was requested.
3661
- */
3662
- requested_at: string;
3663
-
3664
- /**
3665
- * The ID of the check transfer that was stopped.
3666
- */
3667
- transfer_id: string;
3668
-
3669
- /**
3670
- * A constant representing the object's type. For this resource it will always be
3671
- * `check_transfer_stop_payment_request`.
3672
- */
3673
- type: 'check_transfer_stop_payment_request';
3674
- }
3675
-
3676
- /**
3677
- * A Fee Payment object. This field will be present in the JSON response if and
3678
- * only if `category` is equal to `fee_payment`.
3679
- */
3680
- export interface FeePayment {
3681
- /**
3682
- * The amount in the minor unit of the transaction's currency. For dollars, for
3683
- * example, this is cents.
3684
- */
3685
- amount: number;
3686
-
3687
- /**
3688
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
3689
- * currency.
3690
- *
3691
- * - `CAD` - Canadian Dollar (CAD)
3692
- * - `CHF` - Swiss Franc (CHF)
3693
- * - `EUR` - Euro (EUR)
3694
- * - `GBP` - British Pound (GBP)
3695
- * - `JPY` - Japanese Yen (JPY)
3696
- * - `USD` - US Dollar (USD)
3697
- */
3698
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
3699
-
3700
- /**
3701
- * The start of this payment's fee period, usually the first day of a month.
3702
- */
3703
- fee_period_start: string;
3704
- }
3705
-
3706
- /**
3707
- * An Inbound ACH Transfer Intention object. This field will be present in the JSON
3708
- * response if and only if `category` is equal to `inbound_ach_transfer`.
3709
- */
3710
- export interface InboundACHTransfer {
3711
- /**
3712
- * Additional information sent from the originator.
3713
- */
3714
- addenda: InboundACHTransfer.Addenda | null;
3715
-
3716
- /**
3717
- * The amount in the minor unit of the destination account currency. For dollars,
3718
- * for example, this is cents.
3719
- */
3720
- amount: number;
3721
-
3722
- /**
3723
- * The description of the date of the transfer, usually in the format `YYMMDD`.
3724
- */
3725
- originator_company_descriptive_date: string | null;
3726
-
3727
- /**
3728
- * Data set by the originator.
3729
- */
3730
- originator_company_discretionary_data: string | null;
3731
-
3732
- /**
3733
- * An informational description of the transfer.
3734
- */
3735
- originator_company_entry_description: string;
3736
-
3737
- /**
3738
- * An identifier for the originating company. This is generally, but not always, a
3739
- * stable identifier across multiple transfers.
3740
- */
3741
- originator_company_id: string;
3742
-
3743
- /**
3744
- * A name set by the originator to identify themselves.
3745
- */
3746
- originator_company_name: string;
3747
-
3748
- /**
3749
- * The originator's identifier for the transfer receipient.
3750
- */
3751
- receiver_id_number: string | null;
3752
-
3753
- /**
3754
- * The name of the transfer recipient. This value is informational and not verified
3755
- * by Increase.
3756
- */
3757
- receiver_name: string | null;
3758
-
3759
- /**
3760
- * A 15 digit number recorded in the Nacha file and available to both the
3761
- * originating and receiving bank. Along with the amount, date, and originating
3762
- * routing number, this can be used to identify the ACH transfer at either bank.
3763
- * ACH trace numbers are not unique, but are
3764
- * [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).
3765
- */
3766
- trace_number: string;
3767
-
3768
- /**
3769
- * The Inbound ACH Transfer's identifier.
3770
- */
3771
- transfer_id: string;
3772
- }
3773
-
3774
- export namespace InboundACHTransfer {
3775
- /**
3776
- * Additional information sent from the originator.
3777
- */
3778
- export interface Addenda {
3779
- /**
3780
- * The type of addendum.
3781
- *
3782
- * - `freeform` - Unstructured addendum.
3783
- */
3784
- category: 'freeform';
3785
-
3786
- /**
3787
- * Unstructured `payment_related_information` passed through by the originator.
3788
- */
3789
- freeform: Addenda.Freeform | null;
3790
- }
3791
-
3792
- export namespace Addenda {
3793
- /**
3794
- * Unstructured `payment_related_information` passed through by the originator.
3795
- */
3796
- export interface Freeform {
3797
- /**
3798
- * Each entry represents an addendum received from the originator.
3799
- */
3800
- entries: Array<Freeform.Entry>;
3801
- }
3802
-
3803
- export namespace Freeform {
3804
- export interface Entry {
3805
- /**
3806
- * The payment related information passed in the addendum.
3807
- */
3808
- payment_related_information: string;
3809
- }
3810
- }
3811
- }
3812
- }
3813
-
3814
- /**
3815
- * An Inbound International ACH Transfer object. This field will be present in the
3816
- * JSON response if and only if `category` is equal to
3817
- * `inbound_international_ach_transfer`.
3818
- */
3819
- export interface InboundInternationalACHTransfer {
3820
- /**
3821
- * The amount in the minor unit of the destination account currency. For dollars,
3822
- * for example, this is cents.
3823
- */
3824
- amount: number;
3825
-
3826
- /**
3827
- * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
3828
- * country code of the destination country.
3829
- */
3830
- destination_country_code: string;
3831
-
3832
- /**
3833
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
3834
- * destination bank account.
3835
- */
3836
- destination_currency_code: string;
3837
-
3838
- /**
3839
- * A description of how the foreign exchange rate was calculated.
3840
- *
3841
- * - `fixed_to_variable` - The originator chose an amount in their own currency.
3842
- * The settled amount in USD was converted using the exchange rate.
3843
- * - `variable_to_fixed` - The originator chose an amount to settle in USD. The
3844
- * originator's amount was variable; known only after the foreign exchange
3845
- * conversion.
3846
- * - `fixed_to_fixed` - The amount was originated and settled as a fixed amount in
3847
- * USD. There is no foreign exchange conversion.
3848
- */
3849
- foreign_exchange_indicator: 'fixed_to_variable' | 'variable_to_fixed' | 'fixed_to_fixed';
3850
-
3851
- /**
3852
- * Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a
3853
- * reference to a well-known rate.
3854
- */
3855
- foreign_exchange_reference: string | null;
3856
-
3857
- /**
3858
- * An instruction of how to interpret the `foreign_exchange_reference` field for
3859
- * this Transaction.
3860
- *
3861
- * - `foreign_exchange_rate` - The ACH file contains a foreign exchange rate.
3862
- * - `foreign_exchange_reference_number` - The ACH file contains a reference to a
3863
- * well-known foreign exchange rate.
3864
- * - `blank` - There is no foreign exchange for this transfer, so the
3865
- * `foreign_exchange_reference` field is blank.
3866
- */
3867
- foreign_exchange_reference_indicator:
3868
- | 'foreign_exchange_rate'
3869
- | 'foreign_exchange_reference_number'
3870
- | 'blank';
3871
-
3872
- /**
3873
- * The amount in the minor unit of the foreign payment currency. For dollars, for
3874
- * example, this is cents.
3875
- */
3876
- foreign_payment_amount: number;
3877
-
3878
- /**
3879
- * A reference number in the foreign banking infrastructure.
3880
- */
3881
- foreign_trace_number: string | null;
3882
-
3883
- /**
3884
- * The type of transfer. Set by the originator.
3885
- *
3886
- * - `annuity` - Sent as `ANN` in the Nacha file.
3887
- * - `business_or_commercial` - Sent as `BUS` in the Nacha file.
3888
- * - `deposit` - Sent as `DEP` in the Nacha file.
3889
- * - `loan` - Sent as `LOA` in the Nacha file.
3890
- * - `miscellaneous` - Sent as `MIS` in the Nacha file.
3891
- * - `mortgage` - Sent as `MOR` in the Nacha file.
3892
- * - `pension` - Sent as `PEN` in the Nacha file.
3893
- * - `remittance` - Sent as `REM` in the Nacha file.
3894
- * - `rent_or_lease` - Sent as `RLS` in the Nacha file.
3895
- * - `salary_or_payroll` - Sent as `SAL` in the Nacha file.
3896
- * - `tax` - Sent as `TAX` in the Nacha file.
3897
- * - `accounts_receivable` - Sent as `ARC` in the Nacha file.
3898
- * - `back_office_conversion` - Sent as `BOC` in the Nacha file.
3899
- * - `machine_transfer` - Sent as `MTE` in the Nacha file.
3900
- * - `point_of_purchase` - Sent as `POP` in the Nacha file.
3901
- * - `point_of_sale` - Sent as `POS` in the Nacha file.
3902
- * - `represented_check` - Sent as `RCK` in the Nacha file.
3903
- * - `shared_network_transaction` - Sent as `SHR` in the Nacha file.
3904
- * - `telphone_initiated` - Sent as `TEL` in the Nacha file.
3905
- * - `internet_initiated` - Sent as `WEB` in the Nacha file.
3906
- */
3907
- international_transaction_type_code:
3908
- | 'annuity'
3909
- | 'business_or_commercial'
3910
- | 'deposit'
3911
- | 'loan'
3912
- | 'miscellaneous'
3913
- | 'mortgage'
3914
- | 'pension'
3915
- | 'remittance'
3916
- | 'rent_or_lease'
3917
- | 'salary_or_payroll'
3918
- | 'tax'
3919
- | 'accounts_receivable'
3920
- | 'back_office_conversion'
3921
- | 'machine_transfer'
3922
- | 'point_of_purchase'
3923
- | 'point_of_sale'
3924
- | 'represented_check'
3925
- | 'shared_network_transaction'
3926
- | 'telphone_initiated'
3927
- | 'internet_initiated';
3928
-
3929
- /**
3930
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
3931
- * originating bank account.
3932
- */
3933
- originating_currency_code: string;
3934
-
3935
- /**
3936
- * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
3937
- * country code of the originating branch country.
3938
- */
3939
- originating_depository_financial_institution_branch_country: string;
3940
-
3941
- /**
3942
- * An identifier for the originating bank. One of an International Bank Account
3943
- * Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
3944
- * domestic identifier like a US Routing Number.
3945
- */
3946
- originating_depository_financial_institution_id: string;
3947
-
3948
- /**
3949
- * An instruction of how to interpret the
3950
- * `originating_depository_financial_institution_id` field for this Transaction.
3951
- *
3952
- * - `national_clearing_system_number` - A domestic clearing system number. In the
3953
- * US, for example, this is the American Banking Association (ABA) routing
3954
- * number.
3955
- * - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
3956
- * - `iban` - An International Bank Account Number.
3957
- */
3958
- originating_depository_financial_institution_id_qualifier:
3959
- | 'national_clearing_system_number'
3960
- | 'bic_code'
3961
- | 'iban';
3962
-
3963
- /**
3964
- * The name of the originating bank. Sometimes this will refer to an American bank
3965
- * and obscure the correspondent foreign bank.
3966
- */
3967
- originating_depository_financial_institution_name: string;
3968
-
3969
- /**
3970
- * A portion of the originator address. This may be incomplete.
3971
- */
3972
- originator_city: string;
3973
-
3974
- /**
3975
- * A description field set by the originator.
3976
- */
3977
- originator_company_entry_description: string;
3978
-
3979
- /**
3980
- * A portion of the originator address. The
3981
- * [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
3982
- * code of the originator country.
3983
- */
3984
- originator_country: string;
3985
-
3986
- /**
3987
- * An identifier for the originating company. This is generally stable across
3988
- * multiple ACH transfers.
3989
- */
3990
- originator_identification: string;
3991
-
3992
- /**
3993
- * Either the name of the originator or an intermediary money transmitter.
3994
- */
3995
- originator_name: string;
3996
-
3997
- /**
3998
- * A portion of the originator address. This may be incomplete.
3999
- */
4000
- originator_postal_code: string | null;
4001
-
4002
- /**
4003
- * A portion of the originator address. This may be incomplete.
4004
- */
4005
- originator_state_or_province: string | null;
4006
-
4007
- /**
4008
- * A portion of the originator address. This may be incomplete.
4009
- */
4010
- originator_street_address: string;
4011
-
4012
- /**
4013
- * A description field set by the originator.
4014
- */
4015
- payment_related_information: string | null;
4016
-
4017
- /**
4018
- * A description field set by the originator.
4019
- */
4020
- payment_related_information2: string | null;
4021
-
4022
- /**
4023
- * A portion of the receiver address. This may be incomplete.
4024
- */
4025
- receiver_city: string;
4026
-
4027
- /**
4028
- * A portion of the receiver address. The
4029
- * [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
4030
- * code of the receiver country.
4031
- */
4032
- receiver_country: string;
4033
-
4034
- /**
4035
- * An identification number the originator uses for the receiver.
4036
- */
4037
- receiver_identification_number: string | null;
4038
-
4039
- /**
4040
- * A portion of the receiver address. This may be incomplete.
4041
- */
4042
- receiver_postal_code: string | null;
4043
-
4044
- /**
4045
- * A portion of the receiver address. This may be incomplete.
4046
- */
4047
- receiver_state_or_province: string | null;
4048
-
4049
- /**
4050
- * A portion of the receiver address. This may be incomplete.
4051
- */
4052
- receiver_street_address: string;
4053
-
4054
- /**
4055
- * The name of the receiver of the transfer. This is not verified by Increase.
4056
- */
4057
- receiving_company_or_individual_name: string;
4058
-
4059
- /**
4060
- * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
4061
- * country code of the receiving bank country.
4062
- */
4063
- receiving_depository_financial_institution_country: string;
4064
-
4065
- /**
4066
- * An identifier for the receiving bank. One of an International Bank Account
4067
- * Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
4068
- * domestic identifier like a US Routing Number.
4069
- */
4070
- receiving_depository_financial_institution_id: string;
4071
-
4072
- /**
4073
- * An instruction of how to interpret the
4074
- * `receiving_depository_financial_institution_id` field for this Transaction.
4075
- *
4076
- * - `national_clearing_system_number` - A domestic clearing system number. In the
4077
- * US, for example, this is the American Banking Association (ABA) routing
4078
- * number.
4079
- * - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
4080
- * - `iban` - An International Bank Account Number.
4081
- */
4082
- receiving_depository_financial_institution_id_qualifier:
4083
- | 'national_clearing_system_number'
4084
- | 'bic_code'
4085
- | 'iban';
4086
-
4087
- /**
4088
- * The name of the receiving bank, as set by the sending financial institution.
4089
- */
4090
- receiving_depository_financial_institution_name: string;
4091
-
4092
- /**
4093
- * A 15 digit number recorded in the Nacha file and available to both the
4094
- * originating and receiving bank. Along with the amount, date, and originating
4095
- * routing number, this can be used to identify the ACH transfer at either bank.
4096
- * ACH trace numbers are not unique, but are
4097
- * [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).
4098
- */
4099
- trace_number: string;
4100
-
4101
- /**
4102
- * A constant representing the object's type. For this resource it will always be
4103
- * `inbound_international_ach_transfer`.
4104
- */
4105
- type: 'inbound_international_ach_transfer';
4106
- }
4107
-
4108
- /**
4109
- * An Inbound Real-Time Payments Transfer Confirmation object. This field will be
4110
- * present in the JSON response if and only if `category` is equal to
4111
- * `inbound_real_time_payments_transfer_confirmation`.
4112
- */
4113
- export interface InboundRealTimePaymentsTransferConfirmation {
4114
- /**
4115
- * The amount in the minor unit of the transfer's currency. For dollars, for
4116
- * example, this is cents.
4117
- */
4118
- amount: number;
4119
-
4120
- /**
4121
- * The name the sender of the transfer specified as the recipient of the transfer.
4122
- */
4123
- creditor_name: string;
4124
-
4125
- /**
4126
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
4127
- * currency. This will always be "USD" for a Real-Time Payments transfer.
4128
- *
4129
- * - `CAD` - Canadian Dollar (CAD)
4130
- * - `CHF` - Swiss Franc (CHF)
4131
- * - `EUR` - Euro (EUR)
4132
- * - `GBP` - British Pound (GBP)
4133
- * - `JPY` - Japanese Yen (JPY)
4134
- * - `USD` - US Dollar (USD)
4135
- */
4136
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
4137
-
4138
- /**
4139
- * The account number of the account that sent the transfer.
4140
- */
4141
- debtor_account_number: string;
4142
-
4143
- /**
4144
- * The name provided by the sender of the transfer.
4145
- */
4146
- debtor_name: string;
4147
-
4148
- /**
4149
- * The routing number of the account that sent the transfer.
4150
- */
4151
- debtor_routing_number: string;
4152
-
4153
- /**
4154
- * Additional information included with the transfer.
4155
- */
4156
- remittance_information: string | null;
4157
-
4158
- /**
4159
- * The Real-Time Payments network identification of the transfer.
4160
- */
4161
- transaction_identification: string;
4162
- }
4163
-
4164
- /**
4165
- * An Inbound Wire Drawdown Payment object. This field will be present in the JSON
4166
- * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
4167
- */
4168
- export interface InboundWireDrawdownPayment {
4169
- /**
4170
- * The amount in the minor unit of the transaction's currency. For dollars, for
4171
- * example, this is cents.
4172
- */
4173
- amount: number;
4174
-
4175
- /**
4176
- * A free-form address field set by the sender.
4177
- */
4178
- beneficiary_address_line1: string | null;
4179
-
4180
- /**
4181
- * A free-form address field set by the sender.
4182
- */
4183
- beneficiary_address_line2: string | null;
4184
-
4185
- /**
4186
- * A free-form address field set by the sender.
4187
- */
4188
- beneficiary_address_line3: string | null;
4189
-
4190
- /**
4191
- * A name set by the sender.
4192
- */
4193
- beneficiary_name: string | null;
4194
-
4195
- /**
4196
- * A free-form reference string set by the sender, to help identify the transfer.
4197
- */
4198
- beneficiary_reference: string | null;
4199
-
4200
- /**
4201
- * An Increase-constructed description of the transfer.
4202
- */
4203
- description: string;
4204
-
4205
- /**
4206
- * A unique identifier available to the originating and receiving banks, commonly
4207
- * abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
4208
- * service and is helpful when debugging wires with the receiving bank.
4209
- */
4210
- input_message_accountability_data: string | null;
4211
-
4212
- /**
4213
- * The address of the wire originator, set by the sending bank.
4214
- */
4215
- originator_address_line1: string | null;
4216
-
4217
- /**
4218
- * The address of the wire originator, set by the sending bank.
4219
- */
4220
- originator_address_line2: string | null;
4221
-
4222
- /**
4223
- * The address of the wire originator, set by the sending bank.
4224
- */
4225
- originator_address_line3: string | null;
4226
-
4227
- /**
4228
- * The originator of the wire, set by the sending bank.
4229
- */
4230
- originator_name: string | null;
4231
-
4232
- /**
4233
- * The American Banking Association (ABA) routing number of the bank originating
4234
- * the transfer.
4235
- */
4236
- originator_routing_number: string | null;
4237
-
4238
- /**
4239
- * An Increase-created concatenation of the Originator-to-Beneficiary lines.
4240
- */
4241
- originator_to_beneficiary_information: string | null;
4242
-
4243
- /**
4244
- * A free-form message set by the wire originator.
4245
- */
4246
- originator_to_beneficiary_information_line1: string | null;
4247
-
4248
- /**
4249
- * A free-form message set by the wire originator.
4250
- */
4251
- originator_to_beneficiary_information_line2: string | null;
4252
-
4253
- /**
4254
- * A free-form message set by the wire originator.
4255
- */
4256
- originator_to_beneficiary_information_line3: string | null;
4257
-
4258
- /**
4259
- * A free-form message set by the wire originator.
4260
- */
4261
- originator_to_beneficiary_information_line4: string | null;
4262
- }
4263
-
4264
- /**
4265
- * An Inbound Wire Reversal object. This field will be present in the JSON response
4266
- * if and only if `category` is equal to `inbound_wire_reversal`.
4267
- */
4268
- export interface InboundWireReversal {
4269
- /**
4270
- * The amount that was reversed in USD cents.
4271
- */
4272
- amount: number;
4273
-
4274
- /**
4275
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
4276
- * the reversal was created.
4277
- */
4278
- created_at: string;
4279
-
4280
- /**
4281
- * The description on the reversal message from Fedwire, set by the reversing bank.
4282
- */
4283
- description: string;
4284
-
4285
- /**
4286
- * Additional financial institution information included in the wire reversal.
4287
- */
4288
- financial_institution_to_financial_institution_information: string | null;
4289
-
4290
- /**
4291
- * The Fedwire cycle date for the wire reversal. The "Fedwire day" begins at 9:00
4292
- * PM Eastern Time on the evening before the `cycle date`.
4293
- */
4294
- input_cycle_date: string;
4295
-
4296
- /**
4297
- * The Fedwire transaction identifier.
4298
- */
4299
- input_message_accountability_data: string;
4300
-
4301
- /**
4302
- * The Fedwire sequence number.
4303
- */
4304
- input_sequence_number: string;
4305
-
4306
- /**
4307
- * The Fedwire input source identifier.
4308
- */
4309
- input_source: string;
4310
-
4311
- /**
4312
- * The American Banking Association (ABA) routing number of the bank originating
4313
- * the transfer.
4314
- */
4315
- originator_routing_number: string | null;
4316
-
4317
- /**
4318
- * The Fedwire cycle date for the wire transfer that is being reversed by this
4319
- * message.
4320
- */
4321
- previous_message_input_cycle_date: string;
4322
-
4323
- /**
4324
- * The Fedwire transaction identifier for the wire transfer that was reversed.
4325
- */
4326
- previous_message_input_message_accountability_data: string;
4327
-
4328
- /**
4329
- * The Fedwire sequence number for the wire transfer that was reversed.
4330
- */
4331
- previous_message_input_sequence_number: string;
4332
-
4333
- /**
4334
- * The Fedwire input source identifier for the wire transfer that was reversed.
4335
- */
4336
- previous_message_input_source: string;
4337
-
4338
- /**
4339
- * Information included in the wire reversal for the receiving financial
4340
- * institution.
4341
- */
4342
- receiver_financial_institution_information: string | null;
4343
-
4344
- /**
4345
- * The ID for the Transaction associated with the transfer reversal.
4346
- */
4347
- transaction_id: string;
4348
-
4349
- /**
4350
- * The ID for the Wire Transfer that is being reversed.
4351
- */
4352
- wire_transfer_id: string;
4353
- }
4354
-
4355
- /**
4356
- * An Inbound Wire Transfer Intention object. This field will be present in the
4357
- * JSON response if and only if `category` is equal to `inbound_wire_transfer`.
4358
- */
4359
- export interface InboundWireTransfer {
4360
- /**
4361
- * The amount in USD cents.
4362
- */
4363
- amount: number;
4364
-
4365
- /**
4366
- * A free-form address field set by the sender.
4367
- */
4368
- beneficiary_address_line1: string | null;
4369
-
4370
- /**
4371
- * A free-form address field set by the sender.
4372
- */
4373
- beneficiary_address_line2: string | null;
4374
-
4375
- /**
4376
- * A free-form address field set by the sender.
4377
- */
4378
- beneficiary_address_line3: string | null;
4379
-
4380
- /**
4381
- * A name set by the sender.
4382
- */
4383
- beneficiary_name: string | null;
4384
-
4385
- /**
4386
- * A free-form reference string set by the sender, to help identify the transfer.
4387
- */
4388
- beneficiary_reference: string | null;
4389
-
4390
- /**
4391
- * An Increase-constructed description of the transfer.
4392
- */
4393
- description: string;
4394
-
4395
- /**
4396
- * A unique identifier available to the originating and receiving banks, commonly
4397
- * abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
4398
- * service and is helpful when debugging wires with the originating bank.
4399
- */
4400
- input_message_accountability_data: string | null;
4401
-
4402
- /**
4403
- * The address of the wire originator, set by the sending bank.
4404
- */
4405
- originator_address_line1: string | null;
4406
-
4407
- /**
4408
- * The address of the wire originator, set by the sending bank.
4409
- */
4410
- originator_address_line2: string | null;
4411
-
4412
- /**
4413
- * The address of the wire originator, set by the sending bank.
4414
- */
4415
- originator_address_line3: string | null;
4416
-
4417
- /**
4418
- * The originator of the wire, set by the sending bank.
4419
- */
4420
- originator_name: string | null;
4421
-
4422
- /**
4423
- * The American Banking Association (ABA) routing number of the bank originating
4424
- * the transfer.
4425
- */
4426
- originator_routing_number: string | null;
4427
-
4428
- /**
4429
- * An Increase-created concatenation of the Originator-to-Beneficiary lines.
4430
- */
4431
- originator_to_beneficiary_information: string | null;
4432
-
4433
- /**
4434
- * A free-form message set by the wire originator.
4435
- */
4436
- originator_to_beneficiary_information_line1: string | null;
4437
-
4438
- /**
4439
- * A free-form message set by the wire originator.
4440
- */
4441
- originator_to_beneficiary_information_line2: string | null;
4442
-
4443
- /**
4444
- * A free-form message set by the wire originator.
4445
- */
4446
- originator_to_beneficiary_information_line3: string | null;
4447
-
4448
- /**
4449
- * A free-form message set by the wire originator.
4450
- */
4451
- originator_to_beneficiary_information_line4: string | null;
4452
-
4453
- /**
4454
- * The ID of the Inbound Wire Transfer object that resulted in this Transaction.
4455
- */
4456
- transfer_id: string;
4457
- }
4458
-
4459
- /**
4460
- * An Interest Payment object. This field will be present in the JSON response if
4461
- * and only if `category` is equal to `interest_payment`.
4462
- */
4463
- export interface InterestPayment {
4464
- /**
4465
- * The account on which the interest was accrued.
4466
- */
4467
- accrued_on_account_id: string | null;
4468
-
4469
- /**
4470
- * The amount in the minor unit of the transaction's currency. For dollars, for
4471
- * example, this is cents.
4472
- */
4473
- amount: number;
4474
-
4475
- /**
4476
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
4477
- * currency.
4478
- *
4479
- * - `CAD` - Canadian Dollar (CAD)
4480
- * - `CHF` - Swiss Franc (CHF)
4481
- * - `EUR` - Euro (EUR)
4482
- * - `GBP` - British Pound (GBP)
4483
- * - `JPY` - Japanese Yen (JPY)
4484
- * - `USD` - US Dollar (USD)
4485
- */
4486
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
4487
-
4488
- /**
4489
- * The end of the period for which this transaction paid interest.
4490
- */
4491
- period_end: string;
4492
-
4493
- /**
4494
- * The start of the period for which this transaction paid interest.
4495
- */
4496
- period_start: string;
4497
- }
4498
-
4499
- /**
4500
- * An Internal Source object. This field will be present in the JSON response if
4501
- * and only if `category` is equal to `internal_source`.
4502
- */
4503
- export interface InternalSource {
4504
- /**
4505
- * The amount in the minor unit of the transaction's currency. For dollars, for
4506
- * example, this is cents.
4507
- */
4508
- amount: number;
4509
-
4510
- /**
4511
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
4512
- * currency.
4513
- *
4514
- * - `CAD` - Canadian Dollar (CAD)
4515
- * - `CHF` - Swiss Franc (CHF)
4516
- * - `EUR` - Euro (EUR)
4517
- * - `GBP` - British Pound (GBP)
4518
- * - `JPY` - Japanese Yen (JPY)
4519
- * - `USD` - US Dollar (USD)
4520
- */
4521
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
4522
-
4523
- /**
4524
- * An Internal Source is a transaction between you and Increase. This describes the
4525
- * reason for the transaction.
4526
- *
4527
- * - `account_closure` - Account closure
4528
- * - `bank_migration` - Bank migration
4529
- * - `check_adjustment` - Check adjustment
4530
- * - `collection_payment` - Collection payment
4531
- * - `collection_receivable` - Collection receivable
4532
- * - `empyreal_adjustment` - Empyreal adjustment
4533
- * - `error` - Error
4534
- * - `error_correction` - Error correction
4535
- * - `fees` - Fees
4536
- * - `interest` - Interest
4537
- * - `negative_balance_forgiveness` - Negative balance forgiveness
4538
- * - `sample_funds` - Sample funds
4539
- * - `sample_funds_return` - Sample funds return
4540
- */
4541
- reason:
4542
- | 'account_closure'
4543
- | 'bank_migration'
4544
- | 'check_adjustment'
4545
- | 'collection_payment'
4546
- | 'collection_receivable'
4547
- | 'empyreal_adjustment'
4548
- | 'error'
4549
- | 'error_correction'
4550
- | 'fees'
4551
- | 'interest'
4552
- | 'negative_balance_forgiveness'
4553
- | 'sample_funds'
4554
- | 'sample_funds_return';
4555
- }
4556
-
4557
- /**
4558
- * A Real-Time Payments Transfer Acknowledgement object. This field will be present
4559
- * in the JSON response if and only if `category` is equal to
4560
- * `real_time_payments_transfer_acknowledgement`.
4561
- */
4562
- export interface RealTimePaymentsTransferAcknowledgement {
4563
- /**
4564
- * The transfer amount in USD cents.
4565
- */
4566
- amount: number;
4567
-
4568
- /**
4569
- * The destination account number.
4570
- */
4571
- destination_account_number: string;
4572
-
4573
- /**
4574
- * The American Bankers' Association (ABA) Routing Transit Number (RTN).
4575
- */
4576
- destination_routing_number: string;
4577
-
4578
- /**
4579
- * Unstructured information that will show on the recipient's bank statement.
4580
- */
4581
- remittance_information: string;
4582
-
4583
- /**
4584
- * The identifier of the Real-Time Payments Transfer that led to this Transaction.
4585
- */
4586
- transfer_id: string;
4587
- }
4588
-
4589
- /**
4590
- * A Sample Funds object. This field will be present in the JSON response if and
4591
- * only if `category` is equal to `sample_funds`.
4592
- */
4593
- export interface SampleFunds {
4594
- /**
4595
- * Where the sample funds came from.
4596
- */
4597
- originator: string;
4598
- }
4599
-
4600
- /**
4601
- * A Wire Transfer Intention object. This field will be present in the JSON
4602
- * response if and only if `category` is equal to `wire_transfer_intention`.
4603
- */
4604
- export interface WireTransferIntention {
4605
- /**
4606
- * The destination account number.
4607
- */
4608
- account_number: string;
4609
-
4610
- /**
4611
- * The transfer amount in USD cents.
4612
- */
4613
- amount: number;
4614
-
4615
- /**
4616
- * The message that will show on the recipient's bank statement.
4617
- */
4618
- message_to_recipient: string;
4619
-
4620
- /**
4621
- * The American Bankers' Association (ABA) Routing Transit Number (RTN).
4622
- */
4623
- routing_number: string;
4624
-
4625
- /**
4626
- * The identifier of the Wire Transfer that led to this Transaction.
4627
- */
4628
- transfer_id: string;
4629
- }
4630
-
4631
- /**
4632
- * A Wire Transfer Rejection object. This field will be present in the JSON
4633
- * response if and only if `category` is equal to `wire_transfer_rejection`.
4634
- */
4635
- export interface WireTransferRejection {
4636
- /**
4637
- * The identifier of the Wire Transfer that led to this Transaction.
4638
- */
4639
- transfer_id: string;
4640
- }
4641
- }
4642
- }
4643
24
  }
4644
25
 
4645
26
  export interface RealTimePaymentsTransferCompleteParams {
@@ -4731,46 +112,6 @@ export namespace RealTimePaymentsTransferCompleteParams {
4731
112
  }
4732
113
  }
4733
114
 
4734
- export interface RealTimePaymentsTransferCreateInboundParams {
4735
- /**
4736
- * The identifier of the Account Number the inbound Real-Time Payments Transfer is
4737
- * for.
4738
- */
4739
- account_number_id: string;
4740
-
4741
- /**
4742
- * The transfer amount in USD cents. Must be positive.
4743
- */
4744
- amount: number;
4745
-
4746
- /**
4747
- * The account number of the account that sent the transfer.
4748
- */
4749
- debtor_account_number?: string;
4750
-
4751
- /**
4752
- * The name provided by the sender of the transfer.
4753
- */
4754
- debtor_name?: string;
4755
-
4756
- /**
4757
- * The routing number of the account that sent the transfer.
4758
- */
4759
- debtor_routing_number?: string;
4760
-
4761
- /**
4762
- * Additional information included with the transfer.
4763
- */
4764
- remittance_information?: string;
4765
-
4766
- /**
4767
- * The identifier of a pending Request for Payment that this transfer will fulfill.
4768
- */
4769
- request_for_payment_id?: string;
4770
- }
4771
-
4772
115
  export namespace RealTimePaymentsTransfers {
4773
- export import InboundRealTimePaymentsTransferSimulationResult = SimulationsRealTimePaymentsTransfersAPI.InboundRealTimePaymentsTransferSimulationResult;
4774
116
  export import RealTimePaymentsTransferCompleteParams = SimulationsRealTimePaymentsTransfersAPI.RealTimePaymentsTransferCompleteParams;
4775
- export import RealTimePaymentsTransferCreateInboundParams = SimulationsRealTimePaymentsTransfersAPI.RealTimePaymentsTransferCreateInboundParams;
4776
117
  }