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