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