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