increase 0.10.1 → 0.10.2
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 +13 -0
- package/core.d.ts +6 -3
- package/core.d.ts.map +1 -1
- package/core.js +13 -6
- package/core.js.map +1 -1
- package/core.mjs +13 -6
- package/core.mjs.map +1 -1
- package/index.d.mts +8 -4
- package/index.d.ts +8 -4
- package/index.d.ts.map +1 -1
- package/index.js +6 -3
- package/index.js.map +1 -1
- package/index.mjs +6 -3
- package/index.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/account-transfers.d.ts +8 -1
- package/resources/account-transfers.d.ts.map +1 -1
- package/resources/account-transfers.js.map +1 -1
- package/resources/account-transfers.mjs.map +1 -1
- package/resources/ach-prenotifications.d.ts +2 -2
- package/resources/ach-transfers.d.ts +11 -4
- package/resources/ach-transfers.d.ts.map +1 -1
- package/resources/ach-transfers.js.map +1 -1
- package/resources/ach-transfers.mjs.map +1 -1
- package/resources/card-purchase-supplements.d.ts +1 -1
- package/resources/check-transfers.d.ts +6 -3
- package/resources/check-transfers.d.ts.map +1 -1
- package/resources/check-transfers.js.map +1 -1
- package/resources/check-transfers.mjs.map +1 -1
- package/resources/declined-transactions.d.ts +90 -16
- package/resources/declined-transactions.d.ts.map +1 -1
- package/resources/declined-transactions.js.map +1 -1
- package/resources/declined-transactions.mjs.map +1 -1
- package/resources/digital-wallet-tokens.d.ts +1 -1
- package/resources/entities/beneficial-owners.d.ts +24 -5
- package/resources/entities/beneficial-owners.d.ts.map +1 -1
- package/resources/entities/beneficial-owners.js +8 -2
- package/resources/entities/beneficial-owners.js.map +1 -1
- package/resources/entities/beneficial-owners.mjs +8 -2
- package/resources/entities/beneficial-owners.mjs.map +1 -1
- package/resources/entities/entities.d.ts +19 -14
- package/resources/entities/entities.d.ts.map +1 -1
- package/resources/entities/entities.js.map +1 -1
- package/resources/entities/entities.mjs.map +1 -1
- package/resources/entities/index.d.ts +5 -1
- package/resources/entities/index.d.ts.map +1 -1
- package/resources/entities/index.js.map +1 -1
- package/resources/entities/index.mjs.map +1 -1
- package/resources/entities/supplemental-documents.d.ts +1 -1
- package/resources/entities/supplemental-documents.js +1 -1
- package/resources/entities/supplemental-documents.mjs +1 -1
- package/resources/event-subscriptions.d.ts +22 -10
- 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 +13 -5
- package/resources/events.d.ts.map +1 -1
- package/resources/events.js.map +1 -1
- package/resources/events.mjs.map +1 -1
- package/resources/external-accounts.d.ts +2 -2
- package/resources/inbound-ach-transfer-returns.d.ts +1 -47
- package/resources/inbound-ach-transfer-returns.d.ts.map +1 -1
- package/resources/inbound-ach-transfer-returns.js +0 -6
- package/resources/inbound-ach-transfer-returns.js.map +1 -1
- package/resources/inbound-ach-transfer-returns.mjs +0 -6
- package/resources/inbound-ach-transfer-returns.mjs.map +1 -1
- package/resources/inbound-ach-transfers.d.ts +303 -0
- package/resources/inbound-ach-transfers.d.ts.map +1 -0
- package/resources/inbound-ach-transfers.js +40 -0
- package/resources/inbound-ach-transfers.js.map +1 -0
- package/resources/inbound-ach-transfers.mjs +33 -0
- package/resources/inbound-ach-transfers.mjs.map +1 -0
- package/resources/index.d.ts +7 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +16 -29
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/pending-transactions.d.ts +50 -8
- package/resources/pending-transactions.d.ts.map +1 -1
- package/resources/pending-transactions.js.map +1 -1
- package/resources/pending-transactions.mjs.map +1 -1
- package/resources/real-time-decisions.d.ts +28 -4
- 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 +49 -42
- package/resources/real-time-payments-transfers.d.ts.map +1 -1
- package/resources/real-time-payments-transfers.js +2 -2
- package/resources/real-time-payments-transfers.js.map +1 -1
- package/resources/real-time-payments-transfers.mjs +2 -2
- package/resources/real-time-payments-transfers.mjs.map +1 -1
- package/resources/routing-numbers.d.ts +1 -1
- package/resources/simulations/ach-transfers.d.ts +91 -33
- 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/cards.d.ts +106 -23
- package/resources/simulations/cards.d.ts.map +1 -1
- package/resources/simulations/cards.js.map +1 -1
- package/resources/simulations/cards.mjs.map +1 -1
- package/resources/simulations/inbound-wire-drawdown-requests.d.ts +1 -1
- package/resources/simulations/inbound-wire-drawdown-requests.js +1 -1
- package/resources/simulations/inbound-wire-drawdown-requests.mjs +1 -1
- package/resources/simulations/interest-payments.d.ts +16 -16
- package/resources/simulations/interest-payments.d.ts.map +1 -1
- package/resources/simulations/real-time-payments-transfers.d.ts +122 -64
- package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
- package/resources/simulations/real-time-payments-transfers.js +2 -2
- package/resources/simulations/real-time-payments-transfers.js.map +1 -1
- package/resources/simulations/real-time-payments-transfers.mjs +2 -2
- package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
- package/resources/simulations/wire-transfers.d.ts +16 -16
- package/resources/simulations/wire-transfers.d.ts.map +1 -1
- package/resources/transactions.d.ts +16 -16
- package/resources/transactions.d.ts.map +1 -1
- package/resources/wire-transfers.d.ts +9 -2
- package/resources/wire-transfers.d.ts.map +1 -1
- package/resources/wire-transfers.js.map +1 -1
- package/resources/wire-transfers.mjs.map +1 -1
- package/src/core.ts +18 -6
- package/src/index.ts +10 -6
- package/src/resources/account-transfers.ts +9 -1
- package/src/resources/ach-prenotifications.ts +2 -2
- package/src/resources/ach-transfers.ts +12 -4
- package/src/resources/card-purchase-supplements.ts +1 -1
- package/src/resources/check-transfers.ts +6 -3
- package/src/resources/declined-transactions.ts +94 -16
- package/src/resources/digital-wallet-tokens.ts +1 -1
- package/src/resources/entities/beneficial-owners.ts +31 -6
- package/src/resources/entities/entities.ts +20 -14
- package/src/resources/entities/index.ts +5 -1
- package/src/resources/entities/supplemental-documents.ts +1 -1
- package/src/resources/event-subscriptions.ts +22 -10
- package/src/resources/events.ts +13 -5
- package/src/resources/external-accounts.ts +2 -2
- package/src/resources/inbound-ach-transfer-returns.ts +1 -52
- package/src/resources/inbound-ach-transfers.ts +359 -0
- package/src/resources/index.ts +7 -2
- package/src/resources/pending-transactions.ts +52 -8
- package/src/resources/real-time-decisions.ts +28 -4
- package/src/resources/real-time-payments-transfers.ts +50 -42
- package/src/resources/routing-numbers.ts +1 -1
- package/src/resources/simulations/ach-transfers.ts +93 -33
- package/src/resources/simulations/cards.ts +108 -23
- package/src/resources/simulations/inbound-wire-drawdown-requests.ts +1 -1
- package/src/resources/simulations/interest-payments.ts +16 -16
- package/src/resources/simulations/real-time-payments-transfers.ts +124 -64
- package/src/resources/simulations/wire-transfers.ts +16 -16
- package/src/resources/transactions.ts +16 -16
- package/src/resources/wire-transfers.ts +10 -2
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/shared.d.ts +0 -31
- package/resources/shared.d.ts.map +0 -1
- package/resources/shared.js +0 -4
- package/resources/shared.js.map +0 -1
- package/resources/shared.mjs +0 -3
- package/resources/shared.mjs.map +0 -1
- package/src/resources/shared.ts +0 -32
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
import * as Core from '../core';
|
|
4
4
|
import { APIResource } from '../resource';
|
|
5
5
|
import { isRequestOptions } from '../core';
|
|
6
|
-
import * as Shared from './shared';
|
|
7
6
|
import * as API from './index';
|
|
8
7
|
import { Page, PageParams } from '../pagination';
|
|
9
8
|
|
|
@@ -65,14 +64,14 @@ export interface DeclinedTransaction {
|
|
|
65
64
|
|
|
66
65
|
/**
|
|
67
66
|
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
|
|
68
|
-
* Transaction
|
|
67
|
+
* Transaction occurred.
|
|
69
68
|
*/
|
|
70
69
|
created_at: string;
|
|
71
70
|
|
|
72
71
|
/**
|
|
73
72
|
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
|
|
74
73
|
* Transaction's currency. This will match the currency on the Declined
|
|
75
|
-
*
|
|
74
|
+
* Transaction's Account.
|
|
76
75
|
*
|
|
77
76
|
* - `CAD` - Canadian Dollar (CAD)
|
|
78
77
|
* - `CHF` - Swiss Franc (CHF)
|
|
@@ -148,7 +147,7 @@ export namespace DeclinedTransaction {
|
|
|
148
147
|
* object.
|
|
149
148
|
* - `check_decline` - Check Decline: details will be under the `check_decline`
|
|
150
149
|
* object.
|
|
151
|
-
* - `inbound_real_time_payments_transfer_decline` - Inbound Real
|
|
150
|
+
* - `inbound_real_time_payments_transfer_decline` - Inbound Real-Time Payments
|
|
152
151
|
* Transfer Decline: details will be under the
|
|
153
152
|
* `inbound_real_time_payments_transfer_decline` object.
|
|
154
153
|
* - `international_ach_decline` - International ACH Decline: details will be under
|
|
@@ -174,7 +173,7 @@ export namespace DeclinedTransaction {
|
|
|
174
173
|
check_decline: Source.CheckDecline | null;
|
|
175
174
|
|
|
176
175
|
/**
|
|
177
|
-
* An Inbound Real
|
|
176
|
+
* An Inbound Real-Time Payments Transfer Decline object. This field will be
|
|
178
177
|
* present in the JSON response if and only if `category` is equal to
|
|
179
178
|
* `inbound_real_time_payments_transfer_decline`.
|
|
180
179
|
*/
|
|
@@ -199,18 +198,35 @@ export namespace DeclinedTransaction {
|
|
|
199
198
|
* only if `category` is equal to `ach_decline`.
|
|
200
199
|
*/
|
|
201
200
|
export interface ACHDecline {
|
|
201
|
+
/**
|
|
202
|
+
* The ACH Decline's identifier.
|
|
203
|
+
*/
|
|
204
|
+
id: string;
|
|
205
|
+
|
|
202
206
|
/**
|
|
203
207
|
* The declined amount in the minor unit of the destination account currency. For
|
|
204
208
|
* dollars, for example, this is cents.
|
|
205
209
|
*/
|
|
206
210
|
amount: number;
|
|
207
211
|
|
|
212
|
+
/**
|
|
213
|
+
* The descriptive date of the transfer.
|
|
214
|
+
*/
|
|
208
215
|
originator_company_descriptive_date: string | null;
|
|
209
216
|
|
|
217
|
+
/**
|
|
218
|
+
* The additional information included with the transfer.
|
|
219
|
+
*/
|
|
210
220
|
originator_company_discretionary_data: string | null;
|
|
211
221
|
|
|
222
|
+
/**
|
|
223
|
+
* The identifier of the company that initiated the transfer.
|
|
224
|
+
*/
|
|
212
225
|
originator_company_id: string;
|
|
213
226
|
|
|
227
|
+
/**
|
|
228
|
+
* The name of the company that initiated the transfer.
|
|
229
|
+
*/
|
|
214
230
|
originator_company_name: string;
|
|
215
231
|
|
|
216
232
|
/**
|
|
@@ -230,6 +246,7 @@ export namespace DeclinedTransaction {
|
|
|
230
246
|
* - `originator_request` - Other.
|
|
231
247
|
* - `transaction_not_allowed` - The transaction is not allowed per Increase's
|
|
232
248
|
* terms.
|
|
249
|
+
* - `user_initiated` - The user initiated the decline.
|
|
233
250
|
*/
|
|
234
251
|
reason:
|
|
235
252
|
| 'ach_route_canceled'
|
|
@@ -244,13 +261,29 @@ export namespace DeclinedTransaction {
|
|
|
244
261
|
| 'return_of_erroneous_or_reversing_debit'
|
|
245
262
|
| 'no_ach_route'
|
|
246
263
|
| 'originator_request'
|
|
247
|
-
| 'transaction_not_allowed'
|
|
264
|
+
| 'transaction_not_allowed'
|
|
265
|
+
| 'user_initiated';
|
|
248
266
|
|
|
267
|
+
/**
|
|
268
|
+
* The id of the receiver of the transfer.
|
|
269
|
+
*/
|
|
249
270
|
receiver_id_number: string | null;
|
|
250
271
|
|
|
272
|
+
/**
|
|
273
|
+
* The name of the receiver of the transfer.
|
|
274
|
+
*/
|
|
251
275
|
receiver_name: string | null;
|
|
252
276
|
|
|
277
|
+
/**
|
|
278
|
+
* The trace number of the transfer.
|
|
279
|
+
*/
|
|
253
280
|
trace_number: string;
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* A constant representing the object's type. For this resource it will always be
|
|
284
|
+
* `ach_decline`.
|
|
285
|
+
*/
|
|
286
|
+
type: 'ach_decline';
|
|
254
287
|
}
|
|
255
288
|
|
|
256
289
|
/**
|
|
@@ -336,6 +369,7 @@ export namespace DeclinedTransaction {
|
|
|
336
369
|
* Why the transaction was declined.
|
|
337
370
|
*
|
|
338
371
|
* - `card_not_active` - The Card was not active.
|
|
372
|
+
* - `physical_card_not_active` - The Physical Card was not active.
|
|
339
373
|
* - `entity_not_active` - The account's entity was not active.
|
|
340
374
|
* - `group_locked` - The account was inactive.
|
|
341
375
|
* - `insufficient_funds` - The Card's Account did not have a sufficient available
|
|
@@ -343,8 +377,6 @@ export namespace DeclinedTransaction {
|
|
|
343
377
|
* - `cvv2_mismatch` - The given CVV2 did not match the card's value.
|
|
344
378
|
* - `transaction_not_allowed` - The attempted card transaction is not allowed per
|
|
345
379
|
* Increase's terms.
|
|
346
|
-
* - `breaches_internal_limit` - The transaction was blocked by an internal limit
|
|
347
|
-
* for new Increase accounts.
|
|
348
380
|
* - `breaches_limit` - The transaction was blocked by a Limit.
|
|
349
381
|
* - `webhook_declined` - Your application declined the transaction via webhook.
|
|
350
382
|
* - `webhook_timed_out` - Your application webhook did not respond without the
|
|
@@ -354,21 +386,24 @@ export namespace DeclinedTransaction {
|
|
|
354
386
|
* authorization request cryptogram.
|
|
355
387
|
* - `missing_original_authorization` - The original card authorization for this
|
|
356
388
|
* incremental authorization does not exist.
|
|
389
|
+
* - `suspected_fraud` - The transaction was suspected to be fraudulent. Please
|
|
390
|
+
* reach out to support@increase.com for more information.
|
|
357
391
|
*/
|
|
358
392
|
reason:
|
|
359
393
|
| 'card_not_active'
|
|
394
|
+
| 'physical_card_not_active'
|
|
360
395
|
| 'entity_not_active'
|
|
361
396
|
| 'group_locked'
|
|
362
397
|
| 'insufficient_funds'
|
|
363
398
|
| 'cvv2_mismatch'
|
|
364
399
|
| 'transaction_not_allowed'
|
|
365
|
-
| 'breaches_internal_limit'
|
|
366
400
|
| 'breaches_limit'
|
|
367
401
|
| 'webhook_declined'
|
|
368
402
|
| 'webhook_timed_out'
|
|
369
403
|
| 'declined_by_stand_in_processing'
|
|
370
404
|
| 'invalid_physical_card'
|
|
371
|
-
| 'missing_original_authorization'
|
|
405
|
+
| 'missing_original_authorization'
|
|
406
|
+
| 'suspected_fraud';
|
|
372
407
|
}
|
|
373
408
|
|
|
374
409
|
export namespace CardDecline {
|
|
@@ -443,8 +478,33 @@ export namespace DeclinedTransaction {
|
|
|
443
478
|
/**
|
|
444
479
|
* The method used to enter the cardholder's primary account number and card
|
|
445
480
|
* expiration date
|
|
481
|
+
*
|
|
482
|
+
* - `unknown` - Unknown
|
|
483
|
+
* - `manual` - Manual key entry
|
|
484
|
+
* - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
|
|
485
|
+
* value
|
|
486
|
+
* - `optical_code` - Optical code
|
|
487
|
+
* - `integrated_circuit_card` - Contact chip card
|
|
488
|
+
* - `contactless` - Contactless read of chip card
|
|
489
|
+
* - `credential_on_file` - Transaction initiated using a credential that has
|
|
490
|
+
* previously been stored on file
|
|
491
|
+
* - `magnetic_stripe` - Magnetic stripe read
|
|
492
|
+
* - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
|
|
493
|
+
* - `integrated_circuit_card_no_cvv` - Contact chip card, without card
|
|
494
|
+
* verification value
|
|
446
495
|
*/
|
|
447
|
-
point_of_service_entry_mode:
|
|
496
|
+
point_of_service_entry_mode:
|
|
497
|
+
| 'unknown'
|
|
498
|
+
| 'manual'
|
|
499
|
+
| 'magnetic_stripe_no_cvv'
|
|
500
|
+
| 'optical_code'
|
|
501
|
+
| 'integrated_circuit_card'
|
|
502
|
+
| 'contactless'
|
|
503
|
+
| 'credential_on_file'
|
|
504
|
+
| 'magnetic_stripe'
|
|
505
|
+
| 'contactless_magnetic_stripe'
|
|
506
|
+
| 'integrated_circuit_card_no_cvv'
|
|
507
|
+
| null;
|
|
448
508
|
}
|
|
449
509
|
}
|
|
450
510
|
}
|
|
@@ -500,7 +560,7 @@ export namespace DeclinedTransaction {
|
|
|
500
560
|
}
|
|
501
561
|
|
|
502
562
|
/**
|
|
503
|
-
* An Inbound Real
|
|
563
|
+
* An Inbound Real-Time Payments Transfer Decline object. This field will be
|
|
504
564
|
* present in the JSON response if and only if `category` is equal to
|
|
505
565
|
* `inbound_real_time_payments_transfer_decline`.
|
|
506
566
|
*/
|
|
@@ -518,7 +578,7 @@ export namespace DeclinedTransaction {
|
|
|
518
578
|
|
|
519
579
|
/**
|
|
520
580
|
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
|
|
521
|
-
* transfer's currency. This will always be "USD" for a Real
|
|
581
|
+
* transfer's currency. This will always be "USD" for a Real-Time Payments
|
|
522
582
|
* transfer.
|
|
523
583
|
*
|
|
524
584
|
* - `CAD` - Canadian Dollar (CAD)
|
|
@@ -553,8 +613,8 @@ export namespace DeclinedTransaction {
|
|
|
553
613
|
* - `account_restricted` - Your account is restricted.
|
|
554
614
|
* - `group_locked` - Your account is inactive.
|
|
555
615
|
* - `entity_not_active` - The account's entity is not active.
|
|
556
|
-
* - `real_time_payments_not_enabled` - Your account is not enabled to receive
|
|
557
|
-
* Time Payments transfers.
|
|
616
|
+
* - `real_time_payments_not_enabled` - Your account is not enabled to receive
|
|
617
|
+
* Real-Time Payments transfers.
|
|
558
618
|
*/
|
|
559
619
|
reason:
|
|
560
620
|
| 'account_number_canceled'
|
|
@@ -570,7 +630,7 @@ export namespace DeclinedTransaction {
|
|
|
570
630
|
remittance_information: string | null;
|
|
571
631
|
|
|
572
632
|
/**
|
|
573
|
-
* The Real
|
|
633
|
+
* The Real-Time Payments network identification of the declined transfer.
|
|
574
634
|
*/
|
|
575
635
|
transaction_identification: string;
|
|
576
636
|
}
|
|
@@ -726,6 +786,8 @@ export interface DeclinedTransactionListParams extends PageParams {
|
|
|
726
786
|
*/
|
|
727
787
|
account_id?: string;
|
|
728
788
|
|
|
789
|
+
category?: DeclinedTransactionListParams.Category;
|
|
790
|
+
|
|
729
791
|
created_at?: DeclinedTransactionListParams.CreatedAt;
|
|
730
792
|
|
|
731
793
|
/**
|
|
@@ -735,6 +797,22 @@ export interface DeclinedTransactionListParams extends PageParams {
|
|
|
735
797
|
}
|
|
736
798
|
|
|
737
799
|
export namespace DeclinedTransactionListParams {
|
|
800
|
+
export interface Category {
|
|
801
|
+
/**
|
|
802
|
+
* Return results whose value is in the provided list. For GET requests, this
|
|
803
|
+
* should be encoded as a comma-delimited string, such as `?in=one,two,three`.
|
|
804
|
+
*/
|
|
805
|
+
in?: Array<
|
|
806
|
+
| 'ach_decline'
|
|
807
|
+
| 'card_decline'
|
|
808
|
+
| 'check_decline'
|
|
809
|
+
| 'inbound_real_time_payments_transfer_decline'
|
|
810
|
+
| 'international_ach_decline'
|
|
811
|
+
| 'wire_decline'
|
|
812
|
+
| 'other'
|
|
813
|
+
>;
|
|
814
|
+
}
|
|
815
|
+
|
|
738
816
|
export interface CreatedAt {
|
|
739
817
|
/**
|
|
740
818
|
* Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
@@ -66,7 +66,7 @@ export interface DigitalWalletToken {
|
|
|
66
66
|
* - `inactive` - The digital wallet token has been created but not successfully
|
|
67
67
|
* activated via two-factor authentication yet.
|
|
68
68
|
* - `suspended` - The digital wallet token has been temporarily paused.
|
|
69
|
-
* - `deactivated` - The digital wallet token has been permanently
|
|
69
|
+
* - `deactivated` - The digital wallet token has been permanently canceled.
|
|
70
70
|
*/
|
|
71
71
|
status: 'active' | 'inactive' | 'suspended' | 'deactivated';
|
|
72
72
|
|
|
@@ -9,12 +9,18 @@ export class BeneficialOwners extends APIResource {
|
|
|
9
9
|
/**
|
|
10
10
|
* Create a beneficial owner for a corporate Entity
|
|
11
11
|
*/
|
|
12
|
-
create(
|
|
13
|
-
|
|
14
|
-
|
|
12
|
+
create(body: BeneficialOwnerCreateParams, options?: Core.RequestOptions): Core.APIPromise<Entities.Entity> {
|
|
13
|
+
return this.post('/entity_beneficial_owners', { body, ...options });
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Archive a beneficial owner belonging to a corporate Entity
|
|
18
|
+
*/
|
|
19
|
+
archive(
|
|
20
|
+
body: BeneficialOwnerArchiveParams,
|
|
15
21
|
options?: Core.RequestOptions,
|
|
16
22
|
): Core.APIPromise<Entities.Entity> {
|
|
17
|
-
return this.post(
|
|
23
|
+
return this.post('/entity_beneficial_owners/archive', { body, ...options });
|
|
18
24
|
}
|
|
19
25
|
}
|
|
20
26
|
|
|
@@ -24,6 +30,11 @@ export interface BeneficialOwnerCreateParams {
|
|
|
24
30
|
* corporation.
|
|
25
31
|
*/
|
|
26
32
|
beneficial_owner: BeneficialOwnerCreateParams.BeneficialOwner;
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* The identifier of the Entity to associate with the new Beneficial Owner.
|
|
36
|
+
*/
|
|
37
|
+
entity_id: string;
|
|
27
38
|
}
|
|
28
39
|
|
|
29
40
|
export namespace BeneficialOwnerCreateParams {
|
|
@@ -55,7 +66,7 @@ export namespace BeneficialOwnerCreateParams {
|
|
|
55
66
|
*/
|
|
56
67
|
export interface Individual {
|
|
57
68
|
/**
|
|
58
|
-
* The individual's address.
|
|
69
|
+
* The individual's physical address. Post Office Boxes are disallowed.
|
|
59
70
|
*/
|
|
60
71
|
address: Individual.Address;
|
|
61
72
|
|
|
@@ -85,7 +96,7 @@ export namespace BeneficialOwnerCreateParams {
|
|
|
85
96
|
|
|
86
97
|
export namespace Individual {
|
|
87
98
|
/**
|
|
88
|
-
* The individual's address.
|
|
99
|
+
* The individual's physical address. Post Office Boxes are disallowed.
|
|
89
100
|
*/
|
|
90
101
|
export interface Address {
|
|
91
102
|
/**
|
|
@@ -246,6 +257,20 @@ export namespace BeneficialOwnerCreateParams {
|
|
|
246
257
|
}
|
|
247
258
|
}
|
|
248
259
|
|
|
260
|
+
export interface BeneficialOwnerArchiveParams {
|
|
261
|
+
/**
|
|
262
|
+
* The identifying details of anyone controlling or owning 25% or more of the
|
|
263
|
+
* corporation.
|
|
264
|
+
*/
|
|
265
|
+
beneficial_owner_id: string;
|
|
266
|
+
|
|
267
|
+
/**
|
|
268
|
+
* The identifier of the Entity to retrieve.
|
|
269
|
+
*/
|
|
270
|
+
entity_id: string;
|
|
271
|
+
}
|
|
272
|
+
|
|
249
273
|
export namespace BeneficialOwners {
|
|
250
274
|
export import BeneficialOwnerCreateParams = API.BeneficialOwnerCreateParams;
|
|
275
|
+
export import BeneficialOwnerArchiveParams = API.BeneficialOwnerArchiveParams;
|
|
251
276
|
}
|
|
@@ -196,6 +196,11 @@ export namespace Entity {
|
|
|
196
196
|
}
|
|
197
197
|
|
|
198
198
|
export interface BeneficialOwner {
|
|
199
|
+
/**
|
|
200
|
+
* The identifier of this beneficial owner.
|
|
201
|
+
*/
|
|
202
|
+
beneficial_owner_id: string;
|
|
203
|
+
|
|
199
204
|
/**
|
|
200
205
|
* This person's role or title within the entity.
|
|
201
206
|
*/
|
|
@@ -854,7 +859,7 @@ export namespace EntityCreateParams {
|
|
|
854
859
|
*/
|
|
855
860
|
export interface Corporation {
|
|
856
861
|
/**
|
|
857
|
-
* The corporation's address.
|
|
862
|
+
* The corporation's physical address. Post Office Boxes are disallowed.
|
|
858
863
|
*/
|
|
859
864
|
address: Corporation.Address;
|
|
860
865
|
|
|
@@ -888,7 +893,7 @@ export namespace EntityCreateParams {
|
|
|
888
893
|
|
|
889
894
|
export namespace Corporation {
|
|
890
895
|
/**
|
|
891
|
-
* The corporation's address.
|
|
896
|
+
* The corporation's physical address. Post Office Boxes are disallowed.
|
|
892
897
|
*/
|
|
893
898
|
export interface Address {
|
|
894
899
|
/**
|
|
@@ -942,7 +947,7 @@ export namespace EntityCreateParams {
|
|
|
942
947
|
*/
|
|
943
948
|
export interface Individual {
|
|
944
949
|
/**
|
|
945
|
-
* The individual's address.
|
|
950
|
+
* The individual's physical address. Post Office Boxes are disallowed.
|
|
946
951
|
*/
|
|
947
952
|
address: Individual.Address;
|
|
948
953
|
|
|
@@ -972,7 +977,7 @@ export namespace EntityCreateParams {
|
|
|
972
977
|
|
|
973
978
|
export namespace Individual {
|
|
974
979
|
/**
|
|
975
|
-
* The individual's address.
|
|
980
|
+
* The individual's physical address. Post Office Boxes are disallowed.
|
|
976
981
|
*/
|
|
977
982
|
export interface Address {
|
|
978
983
|
/**
|
|
@@ -1152,7 +1157,7 @@ export namespace EntityCreateParams {
|
|
|
1152
1157
|
export namespace Joint {
|
|
1153
1158
|
export interface Individual {
|
|
1154
1159
|
/**
|
|
1155
|
-
* The individual's address.
|
|
1160
|
+
* The individual's physical address. Post Office Boxes are disallowed.
|
|
1156
1161
|
*/
|
|
1157
1162
|
address: Individual.Address;
|
|
1158
1163
|
|
|
@@ -1182,7 +1187,7 @@ export namespace EntityCreateParams {
|
|
|
1182
1187
|
|
|
1183
1188
|
export namespace Individual {
|
|
1184
1189
|
/**
|
|
1185
|
-
* The individual's address.
|
|
1190
|
+
* The individual's physical address. Post Office Boxes are disallowed.
|
|
1186
1191
|
*/
|
|
1187
1192
|
export interface Address {
|
|
1188
1193
|
/**
|
|
@@ -1350,7 +1355,7 @@ export namespace EntityCreateParams {
|
|
|
1350
1355
|
*/
|
|
1351
1356
|
export interface NaturalPerson {
|
|
1352
1357
|
/**
|
|
1353
|
-
* The individual's address.
|
|
1358
|
+
* The individual's physical address. Post Office Boxes are disallowed.
|
|
1354
1359
|
*/
|
|
1355
1360
|
address: NaturalPerson.Address;
|
|
1356
1361
|
|
|
@@ -1380,7 +1385,7 @@ export namespace EntityCreateParams {
|
|
|
1380
1385
|
|
|
1381
1386
|
export namespace NaturalPerson {
|
|
1382
1387
|
/**
|
|
1383
|
-
* The individual's address.
|
|
1388
|
+
* The individual's physical address. Post Office Boxes are disallowed.
|
|
1384
1389
|
*/
|
|
1385
1390
|
export interface Address {
|
|
1386
1391
|
/**
|
|
@@ -1552,7 +1557,7 @@ export namespace EntityCreateParams {
|
|
|
1552
1557
|
*/
|
|
1553
1558
|
export interface Trust {
|
|
1554
1559
|
/**
|
|
1555
|
-
* The trust's address.
|
|
1560
|
+
* The trust's physical address. Post Office Boxes are disallowed.
|
|
1556
1561
|
*/
|
|
1557
1562
|
address: Trust.Address;
|
|
1558
1563
|
|
|
@@ -1601,7 +1606,7 @@ export namespace EntityCreateParams {
|
|
|
1601
1606
|
|
|
1602
1607
|
export namespace Trust {
|
|
1603
1608
|
/**
|
|
1604
|
-
* The trust's address.
|
|
1609
|
+
* The trust's physical address. Post Office Boxes are disallowed.
|
|
1605
1610
|
*/
|
|
1606
1611
|
export interface Address {
|
|
1607
1612
|
/**
|
|
@@ -1653,7 +1658,7 @@ export namespace EntityCreateParams {
|
|
|
1653
1658
|
*/
|
|
1654
1659
|
export interface Individual {
|
|
1655
1660
|
/**
|
|
1656
|
-
* The individual's address.
|
|
1661
|
+
* The individual's physical address. Post Office Boxes are disallowed.
|
|
1657
1662
|
*/
|
|
1658
1663
|
address: Individual.Address;
|
|
1659
1664
|
|
|
@@ -1683,7 +1688,7 @@ export namespace EntityCreateParams {
|
|
|
1683
1688
|
|
|
1684
1689
|
export namespace Individual {
|
|
1685
1690
|
/**
|
|
1686
|
-
* The individual's address.
|
|
1691
|
+
* The individual's physical address. Post Office Boxes are disallowed.
|
|
1687
1692
|
*/
|
|
1688
1693
|
export interface Address {
|
|
1689
1694
|
/**
|
|
@@ -1848,7 +1853,7 @@ export namespace EntityCreateParams {
|
|
|
1848
1853
|
*/
|
|
1849
1854
|
export interface Grantor {
|
|
1850
1855
|
/**
|
|
1851
|
-
* The individual's address.
|
|
1856
|
+
* The individual's physical address. Post Office Boxes are disallowed.
|
|
1852
1857
|
*/
|
|
1853
1858
|
address: Grantor.Address;
|
|
1854
1859
|
|
|
@@ -1878,7 +1883,7 @@ export namespace EntityCreateParams {
|
|
|
1878
1883
|
|
|
1879
1884
|
export namespace Grantor {
|
|
1880
1885
|
/**
|
|
1881
|
-
* The individual's address.
|
|
1886
|
+
* The individual's physical address. Post Office Boxes are disallowed.
|
|
1882
1887
|
*/
|
|
1883
1888
|
export interface Address {
|
|
1884
1889
|
/**
|
|
@@ -2079,6 +2084,7 @@ export namespace Entities {
|
|
|
2079
2084
|
|
|
2080
2085
|
export import BeneficialOwners = API.BeneficialOwners;
|
|
2081
2086
|
export import BeneficialOwnerCreateParams = API.BeneficialOwnerCreateParams;
|
|
2087
|
+
export import BeneficialOwnerArchiveParams = API.BeneficialOwnerArchiveParams;
|
|
2082
2088
|
|
|
2083
2089
|
export import SupplementalDocuments = API.SupplementalDocuments;
|
|
2084
2090
|
export import SupplementalDocument = API.SupplementalDocument;
|
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless.
|
|
2
2
|
|
|
3
|
-
export {
|
|
3
|
+
export {
|
|
4
|
+
BeneficialOwnerCreateParams,
|
|
5
|
+
BeneficialOwnerArchiveParams,
|
|
6
|
+
BeneficialOwners,
|
|
7
|
+
} from './beneficial-owners';
|
|
4
8
|
export { Entity, EntityCreateParams, EntityListParams, EntitiesPage, Entities } from './entities';
|
|
5
9
|
export {
|
|
6
10
|
SupplementalDocument,
|
|
@@ -118,6 +118,10 @@ export interface EventSubscription {
|
|
|
118
118
|
* - `group.updated` - Occurs whenever a Group is updated.
|
|
119
119
|
* - `group.heartbeat` - Increase may send webhooks with this category to see if a
|
|
120
120
|
* webhook endpoint is working properly.
|
|
121
|
+
* - `inbound_ach_transfer.created` - Occurs whenever an Inbound ACH Transfer is
|
|
122
|
+
* created.
|
|
123
|
+
* - `inbound_ach_transfer.updated` - Occurs whenever an Inbound ACH Transfer is
|
|
124
|
+
* updated.
|
|
121
125
|
* - `inbound_ach_transfer_return.created` - Occurs whenever an Inbound ACH
|
|
122
126
|
* Transfer Return is created.
|
|
123
127
|
* - `inbound_ach_transfer_return.updated` - Occurs whenever an Inbound ACH
|
|
@@ -139,15 +143,15 @@ export interface EventSubscription {
|
|
|
139
143
|
* - `real_time_decision.digital_wallet_authentication_requested` - Occurs whenever
|
|
140
144
|
* a Real-Time Decision is created in response to a digital wallet requiring
|
|
141
145
|
* two-factor authentication.
|
|
142
|
-
* - `real_time_payments_transfer.created` - Occurs whenever a Real
|
|
146
|
+
* - `real_time_payments_transfer.created` - Occurs whenever a Real-Time Payments
|
|
143
147
|
* Transfer is created.
|
|
144
|
-
* - `real_time_payments_transfer.updated` - Occurs whenever a Real
|
|
148
|
+
* - `real_time_payments_transfer.updated` - Occurs whenever a Real-Time Payments
|
|
145
149
|
* Transfer is updated.
|
|
146
|
-
* - `real_time_payments_request_for_payment.created` - Occurs whenever a Real
|
|
150
|
+
* - `real_time_payments_request_for_payment.created` - Occurs whenever a Real-Time
|
|
147
151
|
* Payments Request for Payment is created.
|
|
148
|
-
* - `real_time_payments_request_for_payment.updated` - Occurs whenever a Real
|
|
152
|
+
* - `real_time_payments_request_for_payment.updated` - Occurs whenever a Real-Time
|
|
149
153
|
* Payments Request for Payment is updated.
|
|
150
|
-
* - `transaction.created` - Occurs whenever a Transaction is
|
|
154
|
+
* - `transaction.created` - Occurs whenever a Transaction is created.
|
|
151
155
|
* - `wire_drawdown_request.created` - Occurs whenever a Wire Drawdown Request is
|
|
152
156
|
* created.
|
|
153
157
|
* - `wire_drawdown_request.updated` - Occurs whenever a Wire Drawdown Request is
|
|
@@ -187,6 +191,8 @@ export interface EventSubscription {
|
|
|
187
191
|
| 'file.created'
|
|
188
192
|
| 'group.updated'
|
|
189
193
|
| 'group.heartbeat'
|
|
194
|
+
| 'inbound_ach_transfer.created'
|
|
195
|
+
| 'inbound_ach_transfer.updated'
|
|
190
196
|
| 'inbound_ach_transfer_return.created'
|
|
191
197
|
| 'inbound_ach_transfer_return.updated'
|
|
192
198
|
| 'inbound_wire_drawdown_request.created'
|
|
@@ -280,6 +286,10 @@ export interface EventSubscriptionCreateParams {
|
|
|
280
286
|
* - `group.updated` - Occurs whenever a Group is updated.
|
|
281
287
|
* - `group.heartbeat` - Increase may send webhooks with this category to see if a
|
|
282
288
|
* webhook endpoint is working properly.
|
|
289
|
+
* - `inbound_ach_transfer.created` - Occurs whenever an Inbound ACH Transfer is
|
|
290
|
+
* created.
|
|
291
|
+
* - `inbound_ach_transfer.updated` - Occurs whenever an Inbound ACH Transfer is
|
|
292
|
+
* updated.
|
|
283
293
|
* - `inbound_ach_transfer_return.created` - Occurs whenever an Inbound ACH
|
|
284
294
|
* Transfer Return is created.
|
|
285
295
|
* - `inbound_ach_transfer_return.updated` - Occurs whenever an Inbound ACH
|
|
@@ -301,15 +311,15 @@ export interface EventSubscriptionCreateParams {
|
|
|
301
311
|
* - `real_time_decision.digital_wallet_authentication_requested` - Occurs whenever
|
|
302
312
|
* a Real-Time Decision is created in response to a digital wallet requiring
|
|
303
313
|
* two-factor authentication.
|
|
304
|
-
* - `real_time_payments_transfer.created` - Occurs whenever a Real
|
|
314
|
+
* - `real_time_payments_transfer.created` - Occurs whenever a Real-Time Payments
|
|
305
315
|
* Transfer is created.
|
|
306
|
-
* - `real_time_payments_transfer.updated` - Occurs whenever a Real
|
|
316
|
+
* - `real_time_payments_transfer.updated` - Occurs whenever a Real-Time Payments
|
|
307
317
|
* Transfer is updated.
|
|
308
|
-
* - `real_time_payments_request_for_payment.created` - Occurs whenever a Real
|
|
318
|
+
* - `real_time_payments_request_for_payment.created` - Occurs whenever a Real-Time
|
|
309
319
|
* Payments Request for Payment is created.
|
|
310
|
-
* - `real_time_payments_request_for_payment.updated` - Occurs whenever a Real
|
|
320
|
+
* - `real_time_payments_request_for_payment.updated` - Occurs whenever a Real-Time
|
|
311
321
|
* Payments Request for Payment is updated.
|
|
312
|
-
* - `transaction.created` - Occurs whenever a Transaction is
|
|
322
|
+
* - `transaction.created` - Occurs whenever a Transaction is created.
|
|
313
323
|
* - `wire_drawdown_request.created` - Occurs whenever a Wire Drawdown Request is
|
|
314
324
|
* created.
|
|
315
325
|
* - `wire_drawdown_request.updated` - Occurs whenever a Wire Drawdown Request is
|
|
@@ -349,6 +359,8 @@ export interface EventSubscriptionCreateParams {
|
|
|
349
359
|
| 'file.created'
|
|
350
360
|
| 'group.updated'
|
|
351
361
|
| 'group.heartbeat'
|
|
362
|
+
| 'inbound_ach_transfer.created'
|
|
363
|
+
| 'inbound_ach_transfer.updated'
|
|
352
364
|
| 'inbound_ach_transfer_return.created'
|
|
353
365
|
| 'inbound_ach_transfer_return.updated'
|
|
354
366
|
| 'inbound_wire_drawdown_request.created'
|
package/src/resources/events.ts
CHANGED
|
@@ -97,6 +97,10 @@ export interface Event {
|
|
|
97
97
|
* - `group.updated` - Occurs whenever a Group is updated.
|
|
98
98
|
* - `group.heartbeat` - Increase may send webhooks with this category to see if a
|
|
99
99
|
* webhook endpoint is working properly.
|
|
100
|
+
* - `inbound_ach_transfer.created` - Occurs whenever an Inbound ACH Transfer is
|
|
101
|
+
* created.
|
|
102
|
+
* - `inbound_ach_transfer.updated` - Occurs whenever an Inbound ACH Transfer is
|
|
103
|
+
* updated.
|
|
100
104
|
* - `inbound_ach_transfer_return.created` - Occurs whenever an Inbound ACH
|
|
101
105
|
* Transfer Return is created.
|
|
102
106
|
* - `inbound_ach_transfer_return.updated` - Occurs whenever an Inbound ACH
|
|
@@ -118,15 +122,15 @@ export interface Event {
|
|
|
118
122
|
* - `real_time_decision.digital_wallet_authentication_requested` - Occurs whenever
|
|
119
123
|
* a Real-Time Decision is created in response to a digital wallet requiring
|
|
120
124
|
* two-factor authentication.
|
|
121
|
-
* - `real_time_payments_transfer.created` - Occurs whenever a Real
|
|
125
|
+
* - `real_time_payments_transfer.created` - Occurs whenever a Real-Time Payments
|
|
122
126
|
* Transfer is created.
|
|
123
|
-
* - `real_time_payments_transfer.updated` - Occurs whenever a Real
|
|
127
|
+
* - `real_time_payments_transfer.updated` - Occurs whenever a Real-Time Payments
|
|
124
128
|
* Transfer is updated.
|
|
125
|
-
* - `real_time_payments_request_for_payment.created` - Occurs whenever a Real
|
|
129
|
+
* - `real_time_payments_request_for_payment.created` - Occurs whenever a Real-Time
|
|
126
130
|
* Payments Request for Payment is created.
|
|
127
|
-
* - `real_time_payments_request_for_payment.updated` - Occurs whenever a Real
|
|
131
|
+
* - `real_time_payments_request_for_payment.updated` - Occurs whenever a Real-Time
|
|
128
132
|
* Payments Request for Payment is updated.
|
|
129
|
-
* - `transaction.created` - Occurs whenever a Transaction is
|
|
133
|
+
* - `transaction.created` - Occurs whenever a Transaction is created.
|
|
130
134
|
* - `wire_drawdown_request.created` - Occurs whenever a Wire Drawdown Request is
|
|
131
135
|
* created.
|
|
132
136
|
* - `wire_drawdown_request.updated` - Occurs whenever a Wire Drawdown Request is
|
|
@@ -166,6 +170,8 @@ export interface Event {
|
|
|
166
170
|
| 'file.created'
|
|
167
171
|
| 'group.updated'
|
|
168
172
|
| 'group.heartbeat'
|
|
173
|
+
| 'inbound_ach_transfer.created'
|
|
174
|
+
| 'inbound_ach_transfer.updated'
|
|
169
175
|
| 'inbound_ach_transfer_return.created'
|
|
170
176
|
| 'inbound_ach_transfer_return.updated'
|
|
171
177
|
| 'inbound_wire_drawdown_request.created'
|
|
@@ -248,6 +254,8 @@ export namespace EventListParams {
|
|
|
248
254
|
| 'file.created'
|
|
249
255
|
| 'group.updated'
|
|
250
256
|
| 'group.heartbeat'
|
|
257
|
+
| 'inbound_ach_transfer.created'
|
|
258
|
+
| 'inbound_ach_transfer.updated'
|
|
251
259
|
| 'inbound_ach_transfer_return.created'
|
|
252
260
|
| 'inbound_ach_transfer_return.updated'
|
|
253
261
|
| 'inbound_wire_drawdown_request.created'
|
|
@@ -98,7 +98,7 @@ export interface ExternalAccount {
|
|
|
98
98
|
/**
|
|
99
99
|
* The External Account's status.
|
|
100
100
|
*
|
|
101
|
-
* - `active` - The External
|
|
101
|
+
* - `active` - The External Account is active.
|
|
102
102
|
* - `archived` - The External Account is archived and won't appear in the
|
|
103
103
|
* dashboard.
|
|
104
104
|
*/
|
|
@@ -156,7 +156,7 @@ export interface ExternalAccountUpdateParams {
|
|
|
156
156
|
/**
|
|
157
157
|
* The status of the External Account.
|
|
158
158
|
*
|
|
159
|
-
* - `active` - The External
|
|
159
|
+
* - `active` - The External Account is active.
|
|
160
160
|
* - `archived` - The External Account is archived and won't appear in the
|
|
161
161
|
* dashboard.
|
|
162
162
|
*/
|