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