increase 0.26.0 → 0.28.0

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