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