@augustusbank/typescript-sdk 0.21.0 → 0.22.1
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 +39 -0
- package/client.d.mts +12 -6
- package/client.d.mts.map +1 -1
- package/client.d.ts +12 -6
- package/client.d.ts.map +1 -1
- package/client.js +6 -0
- package/client.js.map +1 -1
- package/client.mjs +6 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/account-holders.d.mts +1555 -1184
- package/resources/account-holders.d.mts.map +1 -1
- package/resources/account-holders.d.ts +1555 -1184
- package/resources/account-holders.d.ts.map +1 -1
- package/resources/account-holders.js +59 -0
- package/resources/account-holders.js.map +1 -1
- package/resources/account-holders.mjs +59 -0
- package/resources/account-holders.mjs.map +1 -1
- package/resources/account-programs.d.mts +22 -17
- package/resources/account-programs.d.mts.map +1 -1
- package/resources/account-programs.d.ts +22 -17
- package/resources/account-programs.d.ts.map +1 -1
- package/resources/account-programs.js +2 -2
- package/resources/account-programs.js.map +1 -1
- package/resources/account-programs.mjs +2 -2
- package/resources/account-programs.mjs.map +1 -1
- package/resources/accounts.d.mts +226 -48
- package/resources/accounts.d.mts.map +1 -1
- package/resources/accounts.d.ts +226 -48
- package/resources/accounts.d.ts.map +1 -1
- package/resources/accounts.js +55 -2
- package/resources/accounts.js.map +1 -1
- package/resources/accounts.mjs +55 -2
- package/resources/accounts.mjs.map +1 -1
- package/resources/api-keys.d.mts +1 -1
- package/resources/api-keys.d.mts.map +1 -1
- package/resources/api-keys.d.ts +1 -1
- package/resources/api-keys.d.ts.map +1 -1
- package/resources/api-versions.d.mts +3 -0
- package/resources/api-versions.d.mts.map +1 -1
- package/resources/api-versions.d.ts +3 -0
- package/resources/api-versions.d.ts.map +1 -1
- package/resources/conversions.d.mts +36 -81
- package/resources/conversions.d.mts.map +1 -1
- package/resources/conversions.d.ts +36 -81
- package/resources/conversions.d.ts.map +1 -1
- package/resources/conversions.js +25 -1
- package/resources/conversions.js.map +1 -1
- package/resources/conversions.mjs +25 -1
- package/resources/conversions.mjs.map +1 -1
- package/resources/counterparties.d.mts +1042 -0
- package/resources/counterparties.d.mts.map +1 -0
- package/resources/counterparties.d.ts +1042 -0
- package/resources/counterparties.d.ts.map +1 -0
- package/resources/counterparties.js +45 -0
- package/resources/counterparties.js.map +1 -0
- package/resources/counterparties.mjs +41 -0
- package/resources/counterparties.mjs.map +1 -0
- package/resources/deposits.d.mts +48 -186
- package/resources/deposits.d.mts.map +1 -1
- package/resources/deposits.d.ts +48 -186
- package/resources/deposits.d.ts.map +1 -1
- package/resources/events.d.mts +3 -3
- package/resources/events.d.mts.map +1 -1
- package/resources/events.d.ts +3 -3
- package/resources/events.d.ts.map +1 -1
- package/resources/index.d.mts +5 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +5 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +5 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -0
- package/resources/index.mjs.map +1 -1
- package/resources/payouts.d.mts +133 -335
- package/resources/payouts.d.mts.map +1 -1
- package/resources/payouts.d.ts +133 -335
- package/resources/payouts.d.ts.map +1 -1
- package/resources/payouts.js +25 -0
- package/resources/payouts.js.map +1 -1
- package/resources/payouts.mjs +25 -0
- package/resources/payouts.mjs.map +1 -1
- package/resources/quotes/indicative.d.mts +7 -11
- package/resources/quotes/indicative.d.mts.map +1 -1
- package/resources/quotes/indicative.d.ts +7 -11
- package/resources/quotes/indicative.d.ts.map +1 -1
- package/resources/quotes/quotes.d.mts +4 -8
- package/resources/quotes/quotes.d.mts.map +1 -1
- package/resources/quotes/quotes.d.ts +4 -8
- package/resources/quotes/quotes.d.ts.map +1 -1
- package/resources/quotes/quotes.js.map +1 -1
- package/resources/quotes/quotes.mjs.map +1 -1
- package/resources/returns.d.mts +84 -39
- package/resources/returns.d.mts.map +1 -1
- package/resources/returns.d.ts +84 -39
- package/resources/returns.d.ts.map +1 -1
- package/resources/returns.js +22 -0
- package/resources/returns.js.map +1 -1
- package/resources/returns.mjs +22 -0
- package/resources/returns.mjs.map +1 -1
- package/resources/scopes.d.mts +4 -1
- package/resources/scopes.d.mts.map +1 -1
- package/resources/scopes.d.ts +4 -1
- package/resources/scopes.d.ts.map +1 -1
- package/resources/simulations/account-programs.d.mts +215 -0
- package/resources/simulations/account-programs.d.mts.map +1 -0
- package/resources/simulations/account-programs.d.ts +215 -0
- package/resources/simulations/account-programs.d.ts.map +1 -0
- package/resources/simulations/account-programs.js +96 -0
- package/resources/simulations/account-programs.js.map +1 -0
- package/resources/simulations/account-programs.mjs +92 -0
- package/resources/simulations/account-programs.mjs.map +1 -0
- package/resources/simulations/accounts.d.mts +209 -0
- package/resources/simulations/accounts.d.mts.map +1 -0
- package/resources/simulations/accounts.d.ts +209 -0
- package/resources/simulations/accounts.d.ts.map +1 -0
- package/resources/simulations/accounts.js +90 -0
- package/resources/simulations/accounts.js.map +1 -0
- package/resources/simulations/accounts.mjs +86 -0
- package/resources/simulations/accounts.mjs.map +1 -0
- package/resources/simulations/conversions.d.mts +54 -0
- package/resources/simulations/conversions.d.mts.map +1 -0
- package/resources/simulations/conversions.d.ts +54 -0
- package/resources/simulations/conversions.d.ts.map +1 -0
- package/resources/simulations/conversions.js +39 -0
- package/resources/simulations/conversions.js.map +1 -0
- package/resources/simulations/conversions.mjs +35 -0
- package/resources/simulations/conversions.mjs.map +1 -0
- package/resources/simulations/deposits.d.mts +202 -0
- package/resources/simulations/deposits.d.mts.map +1 -0
- package/resources/simulations/deposits.d.ts +202 -0
- package/resources/simulations/deposits.d.ts.map +1 -0
- package/resources/simulations/deposits.js +25 -0
- package/resources/simulations/deposits.js.map +1 -0
- package/resources/simulations/deposits.mjs +21 -0
- package/resources/simulations/deposits.mjs.map +1 -0
- package/resources/simulations/index.d.mts +7 -0
- package/resources/simulations/index.d.mts.map +1 -0
- package/resources/simulations/index.d.ts +7 -0
- package/resources/simulations/index.d.ts.map +1 -0
- package/resources/simulations/index.js +17 -0
- package/resources/simulations/index.js.map +1 -0
- package/resources/simulations/index.mjs +8 -0
- package/resources/simulations/index.mjs.map +1 -0
- package/resources/simulations/payouts.d.mts +62 -0
- package/resources/simulations/payouts.d.mts.map +1 -0
- package/resources/simulations/payouts.d.ts +62 -0
- package/resources/simulations/payouts.d.ts.map +1 -0
- package/resources/simulations/payouts.js +39 -0
- package/resources/simulations/payouts.js.map +1 -0
- package/resources/simulations/payouts.mjs +35 -0
- package/resources/simulations/payouts.mjs.map +1 -0
- package/resources/simulations/simulations.d.mts +26 -0
- package/resources/simulations/simulations.d.mts.map +1 -0
- package/resources/simulations/simulations.d.ts +26 -0
- package/resources/simulations/simulations.d.ts.map +1 -0
- package/resources/simulations/simulations.js +33 -0
- package/resources/simulations/simulations.js.map +1 -0
- package/resources/simulations/simulations.mjs +28 -0
- package/resources/simulations/simulations.mjs.map +1 -0
- package/resources/simulations.d.mts +2 -0
- package/resources/simulations.d.mts.map +1 -0
- package/resources/simulations.d.ts +2 -0
- package/resources/simulations.d.ts.map +1 -0
- package/resources/simulations.js +6 -0
- package/resources/simulations.js.map +1 -0
- package/resources/simulations.mjs +3 -0
- package/resources/simulations.mjs.map +1 -0
- package/resources/transactions.d.mts +342 -162
- package/resources/transactions.d.mts.map +1 -1
- package/resources/transactions.d.ts +342 -162
- package/resources/transactions.d.ts.map +1 -1
- package/resources/webhook-subscriptions.d.mts +61 -11
- package/resources/webhook-subscriptions.d.mts.map +1 -1
- package/resources/webhook-subscriptions.d.ts +61 -11
- package/resources/webhook-subscriptions.d.ts.map +1 -1
- package/resources/webhook-subscriptions.js +49 -0
- package/resources/webhook-subscriptions.js.map +1 -1
- package/resources/webhook-subscriptions.mjs +49 -0
- package/resources/webhook-subscriptions.mjs.map +1 -1
- package/resources/webhooks.d.mts +976 -978
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +976 -978
- package/resources/webhooks.d.ts.map +1 -1
- package/src/client.ts +48 -8
- package/src/resources/account-holders.ts +1701 -1282
- package/src/resources/account-programs.ts +30 -19
- package/src/resources/accounts.ts +265 -50
- package/src/resources/api-keys.ts +3 -0
- package/src/resources/api-versions.ts +3 -0
- package/src/resources/conversions.ts +36 -93
- package/src/resources/counterparties.ts +3127 -0
- package/src/resources/deposits.ts +66 -269
- package/src/resources/events.ts +18 -12
- package/src/resources/index.ts +21 -4
- package/src/resources/payouts.ts +204 -439
- package/src/resources/quotes/indicative.ts +7 -12
- package/src/resources/quotes/quotes.ts +4 -9
- package/src/resources/returns.ts +144 -40
- package/src/resources/scopes.ts +7 -1
- package/src/resources/simulations/account-programs.ts +282 -0
- package/src/resources/simulations/accounts.ts +265 -0
- package/src/resources/simulations/conversions.ts +70 -0
- package/src/resources/simulations/deposits.ts +522 -0
- package/src/resources/simulations/index.ts +33 -0
- package/src/resources/simulations/payouts.ts +80 -0
- package/src/resources/simulations/simulations.ts +92 -0
- package/src/resources/simulations.ts +3 -0
- package/src/resources/transactions.ts +954 -206
- package/src/resources/webhook-subscriptions.ts +102 -36
- package/src/resources/webhooks.ts +1283 -1153
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/webhooks.d.mts
CHANGED
|
@@ -5,7 +5,7 @@ export declare class Webhooks extends APIResource {
|
|
|
5
5
|
key?: string;
|
|
6
6
|
}): UnwrapWebhookEvent;
|
|
7
7
|
}
|
|
8
|
-
export interface
|
|
8
|
+
export interface PayoutInitiatedWebhookEvent {
|
|
9
9
|
/**
|
|
10
10
|
* Unique identifier for the event. Stable across retries.
|
|
11
11
|
*/
|
|
@@ -21,13 +21,13 @@ export interface PayoutCreatedWebhookEvent {
|
|
|
21
21
|
/**
|
|
22
22
|
* Full resource snapshot at the time of the event.
|
|
23
23
|
*/
|
|
24
|
-
payload:
|
|
24
|
+
payload: PayoutInitiatedWebhookEvent.Payload;
|
|
25
25
|
/**
|
|
26
26
|
* Event type in resource.action format.
|
|
27
27
|
*/
|
|
28
|
-
type: 'payout.
|
|
28
|
+
type: 'payout.initiated';
|
|
29
29
|
}
|
|
30
|
-
export declare namespace
|
|
30
|
+
export declare namespace PayoutInitiatedWebhookEvent {
|
|
31
31
|
/**
|
|
32
32
|
* Full resource snapshot at the time of the event.
|
|
33
33
|
*/
|
|
@@ -36,26 +36,30 @@ export declare namespace PayoutCreatedWebhookEvent {
|
|
|
36
36
|
* Unique identifier of the payout.
|
|
37
37
|
*/
|
|
38
38
|
id: string;
|
|
39
|
+
/**
|
|
40
|
+
* ID of the account that was debited.
|
|
41
|
+
*/
|
|
42
|
+
account_id: string;
|
|
39
43
|
/**
|
|
40
44
|
* Amount as a string decimal (e.g. "100.50").
|
|
41
45
|
*/
|
|
42
46
|
amount: string;
|
|
43
47
|
/**
|
|
44
|
-
*
|
|
48
|
+
* ID of the counterparty that receives the money.
|
|
45
49
|
*/
|
|
46
|
-
|
|
50
|
+
counterparty_id: string;
|
|
47
51
|
/**
|
|
48
|
-
* Currency code (ISO 4217
|
|
52
|
+
* Currency code (ISO 4217 or crypto).
|
|
49
53
|
*/
|
|
50
54
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
51
|
-
/**
|
|
52
|
-
* Bank account or crypto wallet the payout was sent to.
|
|
53
|
-
*/
|
|
54
|
-
destination: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.CryptoWalletFinancialAddress;
|
|
55
55
|
/**
|
|
56
56
|
* Failure details when status is failed, otherwise null.
|
|
57
57
|
*/
|
|
58
58
|
failure: Payload.Failure | null;
|
|
59
|
+
/**
|
|
60
|
+
* ISO 8601 UTC timestamp when the payout was initiated.
|
|
61
|
+
*/
|
|
62
|
+
initiated_at: string;
|
|
59
63
|
/**
|
|
60
64
|
* Key-value pairs stored with the payout.
|
|
61
65
|
*/
|
|
@@ -63,95 +67,38 @@ export declare namespace PayoutCreatedWebhookEvent {
|
|
|
63
67
|
[key: string]: string;
|
|
64
68
|
};
|
|
65
69
|
/**
|
|
66
|
-
* Payment
|
|
70
|
+
* Payment scheme or blockchain used for the payout, or null when unknown.
|
|
67
71
|
*/
|
|
68
|
-
|
|
72
|
+
rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
|
|
69
73
|
/**
|
|
70
|
-
*
|
|
74
|
+
* ISO 8601 UTC timestamp when the payout was sent.
|
|
71
75
|
*/
|
|
72
|
-
|
|
76
|
+
sent_at: string | null;
|
|
73
77
|
/**
|
|
74
78
|
* Current status of the payout.
|
|
75
79
|
*/
|
|
76
|
-
status: '
|
|
80
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
81
|
+
/**
|
|
82
|
+
* Reference used to track the payment across the payment network, such as the UETR
|
|
83
|
+
* for SWIFT payments.
|
|
84
|
+
*/
|
|
85
|
+
tracking_reference: string | null;
|
|
86
|
+
/**
|
|
87
|
+
* Transaction hash for crypto payouts, or null when not known. Only blockchain
|
|
88
|
+
* rails support this field.
|
|
89
|
+
*/
|
|
90
|
+
tx_hash: string | null;
|
|
77
91
|
/**
|
|
78
92
|
* Resource type discriminator.
|
|
79
93
|
*/
|
|
80
94
|
type: 'payout';
|
|
81
95
|
/**
|
|
82
|
-
*
|
|
96
|
+
* Unstructured remittance information attached to the transfer. Not all rails
|
|
97
|
+
* support this field.
|
|
83
98
|
*/
|
|
84
|
-
|
|
99
|
+
unstructured_remittance_information: string | null;
|
|
85
100
|
}
|
|
86
101
|
namespace Payload {
|
|
87
|
-
interface IbanFinancialAddress {
|
|
88
|
-
/**
|
|
89
|
-
* Name of the account holder.
|
|
90
|
-
*/
|
|
91
|
-
account_holder_name: string;
|
|
92
|
-
/**
|
|
93
|
-
* Bank Identifier Code, or null if not provided.
|
|
94
|
-
*/
|
|
95
|
-
bic: string | null;
|
|
96
|
-
/**
|
|
97
|
-
* International Bank Account Number.
|
|
98
|
-
*/
|
|
99
|
-
iban: string;
|
|
100
|
-
/**
|
|
101
|
-
* Discriminator for IBAN financial address.
|
|
102
|
-
*/
|
|
103
|
-
type: 'iban';
|
|
104
|
-
}
|
|
105
|
-
interface SortCodeFinancialAddress {
|
|
106
|
-
/**
|
|
107
|
-
* Name of the account holder.
|
|
108
|
-
*/
|
|
109
|
-
account_holder_name: string;
|
|
110
|
-
/**
|
|
111
|
-
* UK account number (8 digits).
|
|
112
|
-
*/
|
|
113
|
-
account_number: string;
|
|
114
|
-
/**
|
|
115
|
-
* UK sort code (6 digits).
|
|
116
|
-
*/
|
|
117
|
-
sort_code: string;
|
|
118
|
-
/**
|
|
119
|
-
* Discriminator for UK sort code financial address.
|
|
120
|
-
*/
|
|
121
|
-
type: 'sort_code';
|
|
122
|
-
}
|
|
123
|
-
interface AbaFinancialAddress {
|
|
124
|
-
/**
|
|
125
|
-
* Name of the account holder.
|
|
126
|
-
*/
|
|
127
|
-
account_holder_name: string;
|
|
128
|
-
/**
|
|
129
|
-
* Bank account number.
|
|
130
|
-
*/
|
|
131
|
-
account_number: string;
|
|
132
|
-
/**
|
|
133
|
-
* ABA routing number (9 digits).
|
|
134
|
-
*/
|
|
135
|
-
routing_number: string;
|
|
136
|
-
/**
|
|
137
|
-
* Discriminator for ABA wire financial address.
|
|
138
|
-
*/
|
|
139
|
-
type: 'aba';
|
|
140
|
-
}
|
|
141
|
-
interface CryptoWalletFinancialAddress {
|
|
142
|
-
/**
|
|
143
|
-
* Wallet address on the specified blockchain.
|
|
144
|
-
*/
|
|
145
|
-
address: string;
|
|
146
|
-
/**
|
|
147
|
-
* Blockchain network for the crypto wallet.
|
|
148
|
-
*/
|
|
149
|
-
blockchain: 'bitcoin' | 'ethereum' | 'solana' | 'polygon' | 'bitcoin_testnet4' | 'ethereum_sepolia' | 'solana_devnet' | 'polygon_amoy';
|
|
150
|
-
/**
|
|
151
|
-
* Discriminator for crypto wallet financial address.
|
|
152
|
-
*/
|
|
153
|
-
type: 'crypto_wallet';
|
|
154
|
-
}
|
|
155
102
|
/**
|
|
156
103
|
* Failure details when status is failed, otherwise null.
|
|
157
104
|
*/
|
|
@@ -159,7 +106,7 @@ export declare namespace PayoutCreatedWebhookEvent {
|
|
|
159
106
|
/**
|
|
160
107
|
* Failure code.
|
|
161
108
|
*/
|
|
162
|
-
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
109
|
+
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
163
110
|
/**
|
|
164
111
|
* Human-readable description of the failure.
|
|
165
112
|
*/
|
|
@@ -171,7 +118,7 @@ export declare namespace PayoutCreatedWebhookEvent {
|
|
|
171
118
|
}
|
|
172
119
|
}
|
|
173
120
|
}
|
|
174
|
-
export interface
|
|
121
|
+
export interface PayoutSubmittedWebhookEvent {
|
|
175
122
|
/**
|
|
176
123
|
* Unique identifier for the event. Stable across retries.
|
|
177
124
|
*/
|
|
@@ -187,13 +134,13 @@ export interface PayoutInitiatedWebhookEvent {
|
|
|
187
134
|
/**
|
|
188
135
|
* Full resource snapshot at the time of the event.
|
|
189
136
|
*/
|
|
190
|
-
payload:
|
|
137
|
+
payload: PayoutSubmittedWebhookEvent.Payload;
|
|
191
138
|
/**
|
|
192
139
|
* Event type in resource.action format.
|
|
193
140
|
*/
|
|
194
|
-
type: 'payout.
|
|
141
|
+
type: 'payout.submitted';
|
|
195
142
|
}
|
|
196
|
-
export declare namespace
|
|
143
|
+
export declare namespace PayoutSubmittedWebhookEvent {
|
|
197
144
|
/**
|
|
198
145
|
* Full resource snapshot at the time of the event.
|
|
199
146
|
*/
|
|
@@ -202,26 +149,30 @@ export declare namespace PayoutInitiatedWebhookEvent {
|
|
|
202
149
|
* Unique identifier of the payout.
|
|
203
150
|
*/
|
|
204
151
|
id: string;
|
|
152
|
+
/**
|
|
153
|
+
* ID of the account that was debited.
|
|
154
|
+
*/
|
|
155
|
+
account_id: string;
|
|
205
156
|
/**
|
|
206
157
|
* Amount as a string decimal (e.g. "100.50").
|
|
207
158
|
*/
|
|
208
159
|
amount: string;
|
|
209
160
|
/**
|
|
210
|
-
*
|
|
161
|
+
* ID of the counterparty that receives the money.
|
|
211
162
|
*/
|
|
212
|
-
|
|
163
|
+
counterparty_id: string;
|
|
213
164
|
/**
|
|
214
|
-
* Currency code (ISO 4217
|
|
165
|
+
* Currency code (ISO 4217 or crypto).
|
|
215
166
|
*/
|
|
216
167
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
217
|
-
/**
|
|
218
|
-
* Bank account or crypto wallet the payout was sent to.
|
|
219
|
-
*/
|
|
220
|
-
destination: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.CryptoWalletFinancialAddress;
|
|
221
168
|
/**
|
|
222
169
|
* Failure details when status is failed, otherwise null.
|
|
223
170
|
*/
|
|
224
171
|
failure: Payload.Failure | null;
|
|
172
|
+
/**
|
|
173
|
+
* ISO 8601 UTC timestamp when the payout was initiated.
|
|
174
|
+
*/
|
|
175
|
+
initiated_at: string;
|
|
225
176
|
/**
|
|
226
177
|
* Key-value pairs stored with the payout.
|
|
227
178
|
*/
|
|
@@ -229,95 +180,38 @@ export declare namespace PayoutInitiatedWebhookEvent {
|
|
|
229
180
|
[key: string]: string;
|
|
230
181
|
};
|
|
231
182
|
/**
|
|
232
|
-
* Payment
|
|
183
|
+
* Payment scheme or blockchain used for the payout, or null when unknown.
|
|
233
184
|
*/
|
|
234
|
-
|
|
185
|
+
rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
|
|
235
186
|
/**
|
|
236
|
-
*
|
|
187
|
+
* ISO 8601 UTC timestamp when the payout was sent.
|
|
237
188
|
*/
|
|
238
|
-
|
|
189
|
+
sent_at: string | null;
|
|
239
190
|
/**
|
|
240
191
|
* Current status of the payout.
|
|
241
192
|
*/
|
|
242
|
-
status: '
|
|
193
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
194
|
+
/**
|
|
195
|
+
* Reference used to track the payment across the payment network, such as the UETR
|
|
196
|
+
* for SWIFT payments.
|
|
197
|
+
*/
|
|
198
|
+
tracking_reference: string | null;
|
|
199
|
+
/**
|
|
200
|
+
* Transaction hash for crypto payouts, or null when not known. Only blockchain
|
|
201
|
+
* rails support this field.
|
|
202
|
+
*/
|
|
203
|
+
tx_hash: string | null;
|
|
243
204
|
/**
|
|
244
205
|
* Resource type discriminator.
|
|
245
206
|
*/
|
|
246
207
|
type: 'payout';
|
|
247
208
|
/**
|
|
248
|
-
*
|
|
209
|
+
* Unstructured remittance information attached to the transfer. Not all rails
|
|
210
|
+
* support this field.
|
|
249
211
|
*/
|
|
250
|
-
|
|
212
|
+
unstructured_remittance_information: string | null;
|
|
251
213
|
}
|
|
252
214
|
namespace Payload {
|
|
253
|
-
interface IbanFinancialAddress {
|
|
254
|
-
/**
|
|
255
|
-
* Name of the account holder.
|
|
256
|
-
*/
|
|
257
|
-
account_holder_name: string;
|
|
258
|
-
/**
|
|
259
|
-
* Bank Identifier Code, or null if not provided.
|
|
260
|
-
*/
|
|
261
|
-
bic: string | null;
|
|
262
|
-
/**
|
|
263
|
-
* International Bank Account Number.
|
|
264
|
-
*/
|
|
265
|
-
iban: string;
|
|
266
|
-
/**
|
|
267
|
-
* Discriminator for IBAN financial address.
|
|
268
|
-
*/
|
|
269
|
-
type: 'iban';
|
|
270
|
-
}
|
|
271
|
-
interface SortCodeFinancialAddress {
|
|
272
|
-
/**
|
|
273
|
-
* Name of the account holder.
|
|
274
|
-
*/
|
|
275
|
-
account_holder_name: string;
|
|
276
|
-
/**
|
|
277
|
-
* UK account number (8 digits).
|
|
278
|
-
*/
|
|
279
|
-
account_number: string;
|
|
280
|
-
/**
|
|
281
|
-
* UK sort code (6 digits).
|
|
282
|
-
*/
|
|
283
|
-
sort_code: string;
|
|
284
|
-
/**
|
|
285
|
-
* Discriminator for UK sort code financial address.
|
|
286
|
-
*/
|
|
287
|
-
type: 'sort_code';
|
|
288
|
-
}
|
|
289
|
-
interface AbaFinancialAddress {
|
|
290
|
-
/**
|
|
291
|
-
* Name of the account holder.
|
|
292
|
-
*/
|
|
293
|
-
account_holder_name: string;
|
|
294
|
-
/**
|
|
295
|
-
* Bank account number.
|
|
296
|
-
*/
|
|
297
|
-
account_number: string;
|
|
298
|
-
/**
|
|
299
|
-
* ABA routing number (9 digits).
|
|
300
|
-
*/
|
|
301
|
-
routing_number: string;
|
|
302
|
-
/**
|
|
303
|
-
* Discriminator for ABA wire financial address.
|
|
304
|
-
*/
|
|
305
|
-
type: 'aba';
|
|
306
|
-
}
|
|
307
|
-
interface CryptoWalletFinancialAddress {
|
|
308
|
-
/**
|
|
309
|
-
* Wallet address on the specified blockchain.
|
|
310
|
-
*/
|
|
311
|
-
address: string;
|
|
312
|
-
/**
|
|
313
|
-
* Blockchain network for the crypto wallet.
|
|
314
|
-
*/
|
|
315
|
-
blockchain: 'bitcoin' | 'ethereum' | 'solana' | 'polygon' | 'bitcoin_testnet4' | 'ethereum_sepolia' | 'solana_devnet' | 'polygon_amoy';
|
|
316
|
-
/**
|
|
317
|
-
* Discriminator for crypto wallet financial address.
|
|
318
|
-
*/
|
|
319
|
-
type: 'crypto_wallet';
|
|
320
|
-
}
|
|
321
215
|
/**
|
|
322
216
|
* Failure details when status is failed, otherwise null.
|
|
323
217
|
*/
|
|
@@ -325,7 +219,7 @@ export declare namespace PayoutInitiatedWebhookEvent {
|
|
|
325
219
|
/**
|
|
326
220
|
* Failure code.
|
|
327
221
|
*/
|
|
328
|
-
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
222
|
+
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
329
223
|
/**
|
|
330
224
|
* Human-readable description of the failure.
|
|
331
225
|
*/
|
|
@@ -337,7 +231,7 @@ export declare namespace PayoutInitiatedWebhookEvent {
|
|
|
337
231
|
}
|
|
338
232
|
}
|
|
339
233
|
}
|
|
340
|
-
export interface
|
|
234
|
+
export interface PayoutSentWebhookEvent {
|
|
341
235
|
/**
|
|
342
236
|
* Unique identifier for the event. Stable across retries.
|
|
343
237
|
*/
|
|
@@ -353,13 +247,13 @@ export interface PayoutPaidWebhookEvent {
|
|
|
353
247
|
/**
|
|
354
248
|
* Full resource snapshot at the time of the event.
|
|
355
249
|
*/
|
|
356
|
-
payload:
|
|
250
|
+
payload: PayoutSentWebhookEvent.Payload;
|
|
357
251
|
/**
|
|
358
252
|
* Event type in resource.action format.
|
|
359
253
|
*/
|
|
360
|
-
type: 'payout.
|
|
254
|
+
type: 'payout.sent';
|
|
361
255
|
}
|
|
362
|
-
export declare namespace
|
|
256
|
+
export declare namespace PayoutSentWebhookEvent {
|
|
363
257
|
/**
|
|
364
258
|
* Full resource snapshot at the time of the event.
|
|
365
259
|
*/
|
|
@@ -368,26 +262,30 @@ export declare namespace PayoutPaidWebhookEvent {
|
|
|
368
262
|
* Unique identifier of the payout.
|
|
369
263
|
*/
|
|
370
264
|
id: string;
|
|
265
|
+
/**
|
|
266
|
+
* ID of the account that was debited.
|
|
267
|
+
*/
|
|
268
|
+
account_id: string;
|
|
371
269
|
/**
|
|
372
270
|
* Amount as a string decimal (e.g. "100.50").
|
|
373
271
|
*/
|
|
374
272
|
amount: string;
|
|
375
273
|
/**
|
|
376
|
-
*
|
|
274
|
+
* ID of the counterparty that receives the money.
|
|
377
275
|
*/
|
|
378
|
-
|
|
276
|
+
counterparty_id: string;
|
|
379
277
|
/**
|
|
380
|
-
* Currency code (ISO 4217
|
|
278
|
+
* Currency code (ISO 4217 or crypto).
|
|
381
279
|
*/
|
|
382
280
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
383
|
-
/**
|
|
384
|
-
* Bank account or crypto wallet the payout was sent to.
|
|
385
|
-
*/
|
|
386
|
-
destination: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.CryptoWalletFinancialAddress;
|
|
387
281
|
/**
|
|
388
282
|
* Failure details when status is failed, otherwise null.
|
|
389
283
|
*/
|
|
390
284
|
failure: Payload.Failure | null;
|
|
285
|
+
/**
|
|
286
|
+
* ISO 8601 UTC timestamp when the payout was initiated.
|
|
287
|
+
*/
|
|
288
|
+
initiated_at: string;
|
|
391
289
|
/**
|
|
392
290
|
* Key-value pairs stored with the payout.
|
|
393
291
|
*/
|
|
@@ -395,95 +293,264 @@ export declare namespace PayoutPaidWebhookEvent {
|
|
|
395
293
|
[key: string]: string;
|
|
396
294
|
};
|
|
397
295
|
/**
|
|
398
|
-
* Payment
|
|
296
|
+
* Payment scheme or blockchain used for the payout, or null when unknown.
|
|
399
297
|
*/
|
|
400
|
-
|
|
298
|
+
rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
|
|
401
299
|
/**
|
|
402
|
-
*
|
|
300
|
+
* ISO 8601 UTC timestamp when the payout was sent.
|
|
403
301
|
*/
|
|
404
|
-
|
|
302
|
+
sent_at: string | null;
|
|
405
303
|
/**
|
|
406
304
|
* Current status of the payout.
|
|
407
305
|
*/
|
|
408
|
-
status: '
|
|
306
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
307
|
+
/**
|
|
308
|
+
* Reference used to track the payment across the payment network, such as the UETR
|
|
309
|
+
* for SWIFT payments.
|
|
310
|
+
*/
|
|
311
|
+
tracking_reference: string | null;
|
|
312
|
+
/**
|
|
313
|
+
* Transaction hash for crypto payouts, or null when not known. Only blockchain
|
|
314
|
+
* rails support this field.
|
|
315
|
+
*/
|
|
316
|
+
tx_hash: string | null;
|
|
409
317
|
/**
|
|
410
318
|
* Resource type discriminator.
|
|
411
319
|
*/
|
|
412
320
|
type: 'payout';
|
|
413
321
|
/**
|
|
414
|
-
*
|
|
322
|
+
* Unstructured remittance information attached to the transfer. Not all rails
|
|
323
|
+
* support this field.
|
|
415
324
|
*/
|
|
416
|
-
|
|
325
|
+
unstructured_remittance_information: string | null;
|
|
417
326
|
}
|
|
418
327
|
namespace Payload {
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
account_holder_name: string;
|
|
424
|
-
/**
|
|
425
|
-
* Bank Identifier Code, or null if not provided.
|
|
426
|
-
*/
|
|
427
|
-
bic: string | null;
|
|
428
|
-
/**
|
|
429
|
-
* International Bank Account Number.
|
|
430
|
-
*/
|
|
431
|
-
iban: string;
|
|
432
|
-
/**
|
|
433
|
-
* Discriminator for IBAN financial address.
|
|
434
|
-
*/
|
|
435
|
-
type: 'iban';
|
|
436
|
-
}
|
|
437
|
-
interface SortCodeFinancialAddress {
|
|
438
|
-
/**
|
|
439
|
-
* Name of the account holder.
|
|
440
|
-
*/
|
|
441
|
-
account_holder_name: string;
|
|
442
|
-
/**
|
|
443
|
-
* UK account number (8 digits).
|
|
444
|
-
*/
|
|
445
|
-
account_number: string;
|
|
446
|
-
/**
|
|
447
|
-
* UK sort code (6 digits).
|
|
448
|
-
*/
|
|
449
|
-
sort_code: string;
|
|
450
|
-
/**
|
|
451
|
-
* Discriminator for UK sort code financial address.
|
|
452
|
-
*/
|
|
453
|
-
type: 'sort_code';
|
|
454
|
-
}
|
|
455
|
-
interface AbaFinancialAddress {
|
|
456
|
-
/**
|
|
457
|
-
* Name of the account holder.
|
|
458
|
-
*/
|
|
459
|
-
account_holder_name: string;
|
|
328
|
+
/**
|
|
329
|
+
* Failure details when status is failed, otherwise null.
|
|
330
|
+
*/
|
|
331
|
+
interface Failure {
|
|
460
332
|
/**
|
|
461
|
-
*
|
|
333
|
+
* Failure code.
|
|
462
334
|
*/
|
|
463
|
-
|
|
335
|
+
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
464
336
|
/**
|
|
465
|
-
*
|
|
337
|
+
* Human-readable description of the failure.
|
|
466
338
|
*/
|
|
467
|
-
|
|
339
|
+
message: string;
|
|
468
340
|
/**
|
|
469
|
-
*
|
|
341
|
+
* Whether the payout can be retried.
|
|
470
342
|
*/
|
|
471
|
-
|
|
343
|
+
retry: boolean;
|
|
472
344
|
}
|
|
473
|
-
|
|
345
|
+
}
|
|
346
|
+
}
|
|
347
|
+
export interface PayoutFailedWebhookEvent {
|
|
348
|
+
/**
|
|
349
|
+
* Unique identifier for the event. Stable across retries.
|
|
350
|
+
*/
|
|
351
|
+
id: string;
|
|
352
|
+
/**
|
|
353
|
+
* API version the payload was rendered at. Stable across retries and redeliveries.
|
|
354
|
+
*/
|
|
355
|
+
api_version: string;
|
|
356
|
+
/**
|
|
357
|
+
* ISO 8601 UTC timestamp when the event was created.
|
|
358
|
+
*/
|
|
359
|
+
date: string;
|
|
360
|
+
/**
|
|
361
|
+
* Full resource snapshot at the time of the event.
|
|
362
|
+
*/
|
|
363
|
+
payload: PayoutFailedWebhookEvent.Payload;
|
|
364
|
+
/**
|
|
365
|
+
* Event type in resource.action format.
|
|
366
|
+
*/
|
|
367
|
+
type: 'payout.failed';
|
|
368
|
+
}
|
|
369
|
+
export declare namespace PayoutFailedWebhookEvent {
|
|
370
|
+
/**
|
|
371
|
+
* Full resource snapshot at the time of the event.
|
|
372
|
+
*/
|
|
373
|
+
interface Payload {
|
|
374
|
+
/**
|
|
375
|
+
* Unique identifier of the payout.
|
|
376
|
+
*/
|
|
377
|
+
id: string;
|
|
378
|
+
/**
|
|
379
|
+
* ID of the account that was debited.
|
|
380
|
+
*/
|
|
381
|
+
account_id: string;
|
|
382
|
+
/**
|
|
383
|
+
* Amount as a string decimal (e.g. "100.50").
|
|
384
|
+
*/
|
|
385
|
+
amount: string;
|
|
386
|
+
/**
|
|
387
|
+
* ID of the counterparty that receives the money.
|
|
388
|
+
*/
|
|
389
|
+
counterparty_id: string;
|
|
390
|
+
/**
|
|
391
|
+
* Currency code (ISO 4217 or crypto).
|
|
392
|
+
*/
|
|
393
|
+
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
394
|
+
/**
|
|
395
|
+
* Failure details when status is failed, otherwise null.
|
|
396
|
+
*/
|
|
397
|
+
failure: Payload.Failure | null;
|
|
398
|
+
/**
|
|
399
|
+
* ISO 8601 UTC timestamp when the payout was initiated.
|
|
400
|
+
*/
|
|
401
|
+
initiated_at: string;
|
|
402
|
+
/**
|
|
403
|
+
* Key-value pairs stored with the payout.
|
|
404
|
+
*/
|
|
405
|
+
metadata: {
|
|
406
|
+
[key: string]: string;
|
|
407
|
+
};
|
|
408
|
+
/**
|
|
409
|
+
* Payment scheme or blockchain used for the payout, or null when unknown.
|
|
410
|
+
*/
|
|
411
|
+
rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
|
|
412
|
+
/**
|
|
413
|
+
* ISO 8601 UTC timestamp when the payout was sent.
|
|
414
|
+
*/
|
|
415
|
+
sent_at: string | null;
|
|
416
|
+
/**
|
|
417
|
+
* Current status of the payout.
|
|
418
|
+
*/
|
|
419
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
420
|
+
/**
|
|
421
|
+
* Reference used to track the payment across the payment network, such as the UETR
|
|
422
|
+
* for SWIFT payments.
|
|
423
|
+
*/
|
|
424
|
+
tracking_reference: string | null;
|
|
425
|
+
/**
|
|
426
|
+
* Transaction hash for crypto payouts, or null when not known. Only blockchain
|
|
427
|
+
* rails support this field.
|
|
428
|
+
*/
|
|
429
|
+
tx_hash: string | null;
|
|
430
|
+
/**
|
|
431
|
+
* Resource type discriminator.
|
|
432
|
+
*/
|
|
433
|
+
type: 'payout';
|
|
434
|
+
/**
|
|
435
|
+
* Unstructured remittance information attached to the transfer. Not all rails
|
|
436
|
+
* support this field.
|
|
437
|
+
*/
|
|
438
|
+
unstructured_remittance_information: string | null;
|
|
439
|
+
}
|
|
440
|
+
namespace Payload {
|
|
441
|
+
/**
|
|
442
|
+
* Failure details when status is failed, otherwise null.
|
|
443
|
+
*/
|
|
444
|
+
interface Failure {
|
|
474
445
|
/**
|
|
475
|
-
*
|
|
446
|
+
* Failure code.
|
|
476
447
|
*/
|
|
477
|
-
|
|
448
|
+
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
478
449
|
/**
|
|
479
|
-
*
|
|
450
|
+
* Human-readable description of the failure.
|
|
480
451
|
*/
|
|
481
|
-
|
|
452
|
+
message: string;
|
|
482
453
|
/**
|
|
483
|
-
*
|
|
454
|
+
* Whether the payout can be retried.
|
|
484
455
|
*/
|
|
485
|
-
|
|
456
|
+
retry: boolean;
|
|
486
457
|
}
|
|
458
|
+
}
|
|
459
|
+
}
|
|
460
|
+
export interface PayoutReturnedWebhookEvent {
|
|
461
|
+
/**
|
|
462
|
+
* Unique identifier for the event. Stable across retries.
|
|
463
|
+
*/
|
|
464
|
+
id: string;
|
|
465
|
+
/**
|
|
466
|
+
* API version the payload was rendered at. Stable across retries and redeliveries.
|
|
467
|
+
*/
|
|
468
|
+
api_version: string;
|
|
469
|
+
/**
|
|
470
|
+
* ISO 8601 UTC timestamp when the event was created.
|
|
471
|
+
*/
|
|
472
|
+
date: string;
|
|
473
|
+
/**
|
|
474
|
+
* Full resource snapshot at the time of the event.
|
|
475
|
+
*/
|
|
476
|
+
payload: PayoutReturnedWebhookEvent.Payload;
|
|
477
|
+
/**
|
|
478
|
+
* Event type in resource.action format.
|
|
479
|
+
*/
|
|
480
|
+
type: 'payout.returned';
|
|
481
|
+
}
|
|
482
|
+
export declare namespace PayoutReturnedWebhookEvent {
|
|
483
|
+
/**
|
|
484
|
+
* Full resource snapshot at the time of the event.
|
|
485
|
+
*/
|
|
486
|
+
interface Payload {
|
|
487
|
+
/**
|
|
488
|
+
* Unique identifier of the payout.
|
|
489
|
+
*/
|
|
490
|
+
id: string;
|
|
491
|
+
/**
|
|
492
|
+
* ID of the account that was debited.
|
|
493
|
+
*/
|
|
494
|
+
account_id: string;
|
|
495
|
+
/**
|
|
496
|
+
* Amount as a string decimal (e.g. "100.50").
|
|
497
|
+
*/
|
|
498
|
+
amount: string;
|
|
499
|
+
/**
|
|
500
|
+
* ID of the counterparty that receives the money.
|
|
501
|
+
*/
|
|
502
|
+
counterparty_id: string;
|
|
503
|
+
/**
|
|
504
|
+
* Currency code (ISO 4217 or crypto).
|
|
505
|
+
*/
|
|
506
|
+
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
507
|
+
/**
|
|
508
|
+
* Failure details when status is failed, otherwise null.
|
|
509
|
+
*/
|
|
510
|
+
failure: Payload.Failure | null;
|
|
511
|
+
/**
|
|
512
|
+
* ISO 8601 UTC timestamp when the payout was initiated.
|
|
513
|
+
*/
|
|
514
|
+
initiated_at: string;
|
|
515
|
+
/**
|
|
516
|
+
* Key-value pairs stored with the payout.
|
|
517
|
+
*/
|
|
518
|
+
metadata: {
|
|
519
|
+
[key: string]: string;
|
|
520
|
+
};
|
|
521
|
+
/**
|
|
522
|
+
* Payment scheme or blockchain used for the payout, or null when unknown.
|
|
523
|
+
*/
|
|
524
|
+
rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
|
|
525
|
+
/**
|
|
526
|
+
* ISO 8601 UTC timestamp when the payout was sent.
|
|
527
|
+
*/
|
|
528
|
+
sent_at: string | null;
|
|
529
|
+
/**
|
|
530
|
+
* Current status of the payout.
|
|
531
|
+
*/
|
|
532
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
533
|
+
/**
|
|
534
|
+
* Reference used to track the payment across the payment network, such as the UETR
|
|
535
|
+
* for SWIFT payments.
|
|
536
|
+
*/
|
|
537
|
+
tracking_reference: string | null;
|
|
538
|
+
/**
|
|
539
|
+
* Transaction hash for crypto payouts, or null when not known. Only blockchain
|
|
540
|
+
* rails support this field.
|
|
541
|
+
*/
|
|
542
|
+
tx_hash: string | null;
|
|
543
|
+
/**
|
|
544
|
+
* Resource type discriminator.
|
|
545
|
+
*/
|
|
546
|
+
type: 'payout';
|
|
547
|
+
/**
|
|
548
|
+
* Unstructured remittance information attached to the transfer. Not all rails
|
|
549
|
+
* support this field.
|
|
550
|
+
*/
|
|
551
|
+
unstructured_remittance_information: string | null;
|
|
552
|
+
}
|
|
553
|
+
namespace Payload {
|
|
487
554
|
/**
|
|
488
555
|
* Failure details when status is failed, otherwise null.
|
|
489
556
|
*/
|
|
@@ -491,7 +558,7 @@ export declare namespace PayoutPaidWebhookEvent {
|
|
|
491
558
|
/**
|
|
492
559
|
* Failure code.
|
|
493
560
|
*/
|
|
494
|
-
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
561
|
+
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
495
562
|
/**
|
|
496
563
|
* Human-readable description of the failure.
|
|
497
564
|
*/
|
|
@@ -503,7 +570,7 @@ export declare namespace PayoutPaidWebhookEvent {
|
|
|
503
570
|
}
|
|
504
571
|
}
|
|
505
572
|
}
|
|
506
|
-
export interface
|
|
573
|
+
export interface ReturnInitiatedWebhookEvent {
|
|
507
574
|
/**
|
|
508
575
|
* Unique identifier for the event. Stable across retries.
|
|
509
576
|
*/
|
|
@@ -519,19 +586,19 @@ export interface PayoutFailedWebhookEvent {
|
|
|
519
586
|
/**
|
|
520
587
|
* Full resource snapshot at the time of the event.
|
|
521
588
|
*/
|
|
522
|
-
payload:
|
|
589
|
+
payload: ReturnInitiatedWebhookEvent.Payload;
|
|
523
590
|
/**
|
|
524
591
|
* Event type in resource.action format.
|
|
525
592
|
*/
|
|
526
|
-
type: '
|
|
593
|
+
type: 'return.initiated';
|
|
527
594
|
}
|
|
528
|
-
export declare namespace
|
|
595
|
+
export declare namespace ReturnInitiatedWebhookEvent {
|
|
529
596
|
/**
|
|
530
597
|
* Full resource snapshot at the time of the event.
|
|
531
598
|
*/
|
|
532
599
|
interface Payload {
|
|
533
600
|
/**
|
|
534
|
-
* Unique identifier of the
|
|
601
|
+
* Unique identifier of the return.
|
|
535
602
|
*/
|
|
536
603
|
id: string;
|
|
537
604
|
/**
|
|
@@ -539,117 +606,44 @@ export declare namespace PayoutFailedWebhookEvent {
|
|
|
539
606
|
*/
|
|
540
607
|
amount: string;
|
|
541
608
|
/**
|
|
542
|
-
*
|
|
543
|
-
*/
|
|
544
|
-
created_at: string;
|
|
545
|
-
/**
|
|
546
|
-
* Currency code (ISO 4217 currency code or crypto currency code).
|
|
609
|
+
* Currency code (ISO 4217 or crypto).
|
|
547
610
|
*/
|
|
548
611
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
549
612
|
/**
|
|
550
|
-
*
|
|
613
|
+
* ID of the parent deposit.
|
|
551
614
|
*/
|
|
552
|
-
|
|
615
|
+
deposit_id: string;
|
|
553
616
|
/**
|
|
554
617
|
* Failure details when status is failed, otherwise null.
|
|
555
618
|
*/
|
|
556
619
|
failure: Payload.Failure | null;
|
|
557
620
|
/**
|
|
558
|
-
*
|
|
621
|
+
* ISO 8601 UTC timestamp when the return was initiated.
|
|
559
622
|
*/
|
|
560
|
-
|
|
561
|
-
[key: string]: string;
|
|
562
|
-
};
|
|
623
|
+
initiated_at: string;
|
|
563
624
|
/**
|
|
564
|
-
* Payment
|
|
625
|
+
* Payment scheme or blockchain used for the return, or null when unknown.
|
|
565
626
|
*/
|
|
566
|
-
|
|
627
|
+
rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
|
|
567
628
|
/**
|
|
568
|
-
*
|
|
629
|
+
* ISO 8601 UTC timestamp when the return was sent.
|
|
569
630
|
*/
|
|
570
|
-
|
|
631
|
+
sent_at: string | null;
|
|
571
632
|
/**
|
|
572
|
-
* Current status of the
|
|
633
|
+
* Current status of the return.
|
|
573
634
|
*/
|
|
574
|
-
status: '
|
|
635
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
575
636
|
/**
|
|
576
|
-
*
|
|
637
|
+
* Transaction hash for crypto returns, or null when not known. Only blockchain
|
|
638
|
+
* rails support this field.
|
|
577
639
|
*/
|
|
578
|
-
|
|
640
|
+
tx_hash: string | null;
|
|
579
641
|
/**
|
|
580
|
-
*
|
|
642
|
+
* Resource type discriminator.
|
|
581
643
|
*/
|
|
582
|
-
|
|
644
|
+
type: 'return';
|
|
583
645
|
}
|
|
584
646
|
namespace Payload {
|
|
585
|
-
interface IbanFinancialAddress {
|
|
586
|
-
/**
|
|
587
|
-
* Name of the account holder.
|
|
588
|
-
*/
|
|
589
|
-
account_holder_name: string;
|
|
590
|
-
/**
|
|
591
|
-
* Bank Identifier Code, or null if not provided.
|
|
592
|
-
*/
|
|
593
|
-
bic: string | null;
|
|
594
|
-
/**
|
|
595
|
-
* International Bank Account Number.
|
|
596
|
-
*/
|
|
597
|
-
iban: string;
|
|
598
|
-
/**
|
|
599
|
-
* Discriminator for IBAN financial address.
|
|
600
|
-
*/
|
|
601
|
-
type: 'iban';
|
|
602
|
-
}
|
|
603
|
-
interface SortCodeFinancialAddress {
|
|
604
|
-
/**
|
|
605
|
-
* Name of the account holder.
|
|
606
|
-
*/
|
|
607
|
-
account_holder_name: string;
|
|
608
|
-
/**
|
|
609
|
-
* UK account number (8 digits).
|
|
610
|
-
*/
|
|
611
|
-
account_number: string;
|
|
612
|
-
/**
|
|
613
|
-
* UK sort code (6 digits).
|
|
614
|
-
*/
|
|
615
|
-
sort_code: string;
|
|
616
|
-
/**
|
|
617
|
-
* Discriminator for UK sort code financial address.
|
|
618
|
-
*/
|
|
619
|
-
type: 'sort_code';
|
|
620
|
-
}
|
|
621
|
-
interface AbaFinancialAddress {
|
|
622
|
-
/**
|
|
623
|
-
* Name of the account holder.
|
|
624
|
-
*/
|
|
625
|
-
account_holder_name: string;
|
|
626
|
-
/**
|
|
627
|
-
* Bank account number.
|
|
628
|
-
*/
|
|
629
|
-
account_number: string;
|
|
630
|
-
/**
|
|
631
|
-
* ABA routing number (9 digits).
|
|
632
|
-
*/
|
|
633
|
-
routing_number: string;
|
|
634
|
-
/**
|
|
635
|
-
* Discriminator for ABA wire financial address.
|
|
636
|
-
*/
|
|
637
|
-
type: 'aba';
|
|
638
|
-
}
|
|
639
|
-
interface CryptoWalletFinancialAddress {
|
|
640
|
-
/**
|
|
641
|
-
* Wallet address on the specified blockchain.
|
|
642
|
-
*/
|
|
643
|
-
address: string;
|
|
644
|
-
/**
|
|
645
|
-
* Blockchain network for the crypto wallet.
|
|
646
|
-
*/
|
|
647
|
-
blockchain: 'bitcoin' | 'ethereum' | 'solana' | 'polygon' | 'bitcoin_testnet4' | 'ethereum_sepolia' | 'solana_devnet' | 'polygon_amoy';
|
|
648
|
-
/**
|
|
649
|
-
* Discriminator for crypto wallet financial address.
|
|
650
|
-
*/
|
|
651
|
-
type: 'crypto_wallet';
|
|
652
|
-
}
|
|
653
647
|
/**
|
|
654
648
|
* Failure details when status is failed, otherwise null.
|
|
655
649
|
*/
|
|
@@ -657,19 +651,19 @@ export declare namespace PayoutFailedWebhookEvent {
|
|
|
657
651
|
/**
|
|
658
652
|
* Failure code.
|
|
659
653
|
*/
|
|
660
|
-
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
654
|
+
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
661
655
|
/**
|
|
662
656
|
* Human-readable description of the failure.
|
|
663
657
|
*/
|
|
664
658
|
message: string;
|
|
665
659
|
/**
|
|
666
|
-
* Whether the
|
|
660
|
+
* Whether the return can be retried.
|
|
667
661
|
*/
|
|
668
662
|
retry: boolean;
|
|
669
663
|
}
|
|
670
664
|
}
|
|
671
665
|
}
|
|
672
|
-
export interface
|
|
666
|
+
export interface ReturnSubmittedWebhookEvent {
|
|
673
667
|
/**
|
|
674
668
|
* Unique identifier for the event. Stable across retries.
|
|
675
669
|
*/
|
|
@@ -685,13 +679,13 @@ export interface ReturnInitiatedWebhookEvent {
|
|
|
685
679
|
/**
|
|
686
680
|
* Full resource snapshot at the time of the event.
|
|
687
681
|
*/
|
|
688
|
-
payload:
|
|
682
|
+
payload: ReturnSubmittedWebhookEvent.Payload;
|
|
689
683
|
/**
|
|
690
684
|
* Event type in resource.action format.
|
|
691
685
|
*/
|
|
692
|
-
type: 'return.
|
|
686
|
+
type: 'return.submitted';
|
|
693
687
|
}
|
|
694
|
-
export declare namespace
|
|
688
|
+
export declare namespace ReturnSubmittedWebhookEvent {
|
|
695
689
|
/**
|
|
696
690
|
* Full resource snapshot at the time of the event.
|
|
697
691
|
*/
|
|
@@ -705,11 +699,7 @@ export declare namespace ReturnInitiatedWebhookEvent {
|
|
|
705
699
|
*/
|
|
706
700
|
amount: string;
|
|
707
701
|
/**
|
|
708
|
-
*
|
|
709
|
-
*/
|
|
710
|
-
created_at: string;
|
|
711
|
-
/**
|
|
712
|
-
* Currency code (ISO 4217 currency code or crypto currency code).
|
|
702
|
+
* Currency code (ISO 4217 or crypto).
|
|
713
703
|
*/
|
|
714
704
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
715
705
|
/**
|
|
@@ -720,18 +710,31 @@ export declare namespace ReturnInitiatedWebhookEvent {
|
|
|
720
710
|
* Failure details when status is failed, otherwise null.
|
|
721
711
|
*/
|
|
722
712
|
failure: Payload.Failure | null;
|
|
713
|
+
/**
|
|
714
|
+
* ISO 8601 UTC timestamp when the return was initiated.
|
|
715
|
+
*/
|
|
716
|
+
initiated_at: string;
|
|
717
|
+
/**
|
|
718
|
+
* Payment scheme or blockchain used for the return, or null when unknown.
|
|
719
|
+
*/
|
|
720
|
+
rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
|
|
721
|
+
/**
|
|
722
|
+
* ISO 8601 UTC timestamp when the return was sent.
|
|
723
|
+
*/
|
|
724
|
+
sent_at: string | null;
|
|
723
725
|
/**
|
|
724
726
|
* Current status of the return.
|
|
725
727
|
*/
|
|
726
|
-
status: '
|
|
728
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
727
729
|
/**
|
|
728
|
-
*
|
|
730
|
+
* Transaction hash for crypto returns, or null when not known. Only blockchain
|
|
731
|
+
* rails support this field.
|
|
729
732
|
*/
|
|
730
|
-
|
|
733
|
+
tx_hash: string | null;
|
|
731
734
|
/**
|
|
732
|
-
*
|
|
735
|
+
* Resource type discriminator.
|
|
733
736
|
*/
|
|
734
|
-
|
|
737
|
+
type: 'return';
|
|
735
738
|
}
|
|
736
739
|
namespace Payload {
|
|
737
740
|
/**
|
|
@@ -741,7 +744,7 @@ export declare namespace ReturnInitiatedWebhookEvent {
|
|
|
741
744
|
/**
|
|
742
745
|
* Failure code.
|
|
743
746
|
*/
|
|
744
|
-
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
747
|
+
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
745
748
|
/**
|
|
746
749
|
* Human-readable description of the failure.
|
|
747
750
|
*/
|
|
@@ -753,7 +756,7 @@ export declare namespace ReturnInitiatedWebhookEvent {
|
|
|
753
756
|
}
|
|
754
757
|
}
|
|
755
758
|
}
|
|
756
|
-
export interface
|
|
759
|
+
export interface ReturnSentWebhookEvent {
|
|
757
760
|
/**
|
|
758
761
|
* Unique identifier for the event. Stable across retries.
|
|
759
762
|
*/
|
|
@@ -769,13 +772,13 @@ export interface ReturnPaidWebhookEvent {
|
|
|
769
772
|
/**
|
|
770
773
|
* Full resource snapshot at the time of the event.
|
|
771
774
|
*/
|
|
772
|
-
payload:
|
|
775
|
+
payload: ReturnSentWebhookEvent.Payload;
|
|
773
776
|
/**
|
|
774
777
|
* Event type in resource.action format.
|
|
775
778
|
*/
|
|
776
|
-
type: 'return.
|
|
779
|
+
type: 'return.sent';
|
|
777
780
|
}
|
|
778
|
-
export declare namespace
|
|
781
|
+
export declare namespace ReturnSentWebhookEvent {
|
|
779
782
|
/**
|
|
780
783
|
* Full resource snapshot at the time of the event.
|
|
781
784
|
*/
|
|
@@ -789,11 +792,7 @@ export declare namespace ReturnPaidWebhookEvent {
|
|
|
789
792
|
*/
|
|
790
793
|
amount: string;
|
|
791
794
|
/**
|
|
792
|
-
*
|
|
793
|
-
*/
|
|
794
|
-
created_at: string;
|
|
795
|
-
/**
|
|
796
|
-
* Currency code (ISO 4217 currency code or crypto currency code).
|
|
795
|
+
* Currency code (ISO 4217 or crypto).
|
|
797
796
|
*/
|
|
798
797
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
799
798
|
/**
|
|
@@ -804,18 +803,31 @@ export declare namespace ReturnPaidWebhookEvent {
|
|
|
804
803
|
* Failure details when status is failed, otherwise null.
|
|
805
804
|
*/
|
|
806
805
|
failure: Payload.Failure | null;
|
|
806
|
+
/**
|
|
807
|
+
* ISO 8601 UTC timestamp when the return was initiated.
|
|
808
|
+
*/
|
|
809
|
+
initiated_at: string;
|
|
810
|
+
/**
|
|
811
|
+
* Payment scheme or blockchain used for the return, or null when unknown.
|
|
812
|
+
*/
|
|
813
|
+
rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
|
|
814
|
+
/**
|
|
815
|
+
* ISO 8601 UTC timestamp when the return was sent.
|
|
816
|
+
*/
|
|
817
|
+
sent_at: string | null;
|
|
807
818
|
/**
|
|
808
819
|
* Current status of the return.
|
|
809
820
|
*/
|
|
810
|
-
status: '
|
|
821
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
811
822
|
/**
|
|
812
|
-
*
|
|
823
|
+
* Transaction hash for crypto returns, or null when not known. Only blockchain
|
|
824
|
+
* rails support this field.
|
|
813
825
|
*/
|
|
814
|
-
|
|
826
|
+
tx_hash: string | null;
|
|
815
827
|
/**
|
|
816
|
-
*
|
|
828
|
+
* Resource type discriminator.
|
|
817
829
|
*/
|
|
818
|
-
|
|
830
|
+
type: 'return';
|
|
819
831
|
}
|
|
820
832
|
namespace Payload {
|
|
821
833
|
/**
|
|
@@ -825,7 +837,7 @@ export declare namespace ReturnPaidWebhookEvent {
|
|
|
825
837
|
/**
|
|
826
838
|
* Failure code.
|
|
827
839
|
*/
|
|
828
|
-
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
840
|
+
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
829
841
|
/**
|
|
830
842
|
* Human-readable description of the failure.
|
|
831
843
|
*/
|
|
@@ -873,11 +885,7 @@ export declare namespace ReturnFailedWebhookEvent {
|
|
|
873
885
|
*/
|
|
874
886
|
amount: string;
|
|
875
887
|
/**
|
|
876
|
-
*
|
|
877
|
-
*/
|
|
878
|
-
created_at: string;
|
|
879
|
-
/**
|
|
880
|
-
* Currency code (ISO 4217 currency code or crypto currency code).
|
|
888
|
+
* Currency code (ISO 4217 or crypto).
|
|
881
889
|
*/
|
|
882
890
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
883
891
|
/**
|
|
@@ -888,18 +896,31 @@ export declare namespace ReturnFailedWebhookEvent {
|
|
|
888
896
|
* Failure details when status is failed, otherwise null.
|
|
889
897
|
*/
|
|
890
898
|
failure: Payload.Failure | null;
|
|
899
|
+
/**
|
|
900
|
+
* ISO 8601 UTC timestamp when the return was initiated.
|
|
901
|
+
*/
|
|
902
|
+
initiated_at: string;
|
|
903
|
+
/**
|
|
904
|
+
* Payment scheme or blockchain used for the return, or null when unknown.
|
|
905
|
+
*/
|
|
906
|
+
rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
|
|
907
|
+
/**
|
|
908
|
+
* ISO 8601 UTC timestamp when the return was sent.
|
|
909
|
+
*/
|
|
910
|
+
sent_at: string | null;
|
|
891
911
|
/**
|
|
892
912
|
* Current status of the return.
|
|
893
913
|
*/
|
|
894
|
-
status: '
|
|
914
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
895
915
|
/**
|
|
896
|
-
*
|
|
916
|
+
* Transaction hash for crypto returns, or null when not known. Only blockchain
|
|
917
|
+
* rails support this field.
|
|
897
918
|
*/
|
|
898
|
-
|
|
919
|
+
tx_hash: string | null;
|
|
899
920
|
/**
|
|
900
|
-
*
|
|
921
|
+
* Resource type discriminator.
|
|
901
922
|
*/
|
|
902
|
-
|
|
923
|
+
type: 'return';
|
|
903
924
|
}
|
|
904
925
|
namespace Payload {
|
|
905
926
|
/**
|
|
@@ -909,7 +930,7 @@ export declare namespace ReturnFailedWebhookEvent {
|
|
|
909
930
|
/**
|
|
910
931
|
* Failure code.
|
|
911
932
|
*/
|
|
912
|
-
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
933
|
+
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
913
934
|
/**
|
|
914
935
|
* Human-readable description of the failure.
|
|
915
936
|
*/
|
|
@@ -957,11 +978,7 @@ export declare namespace ReturnReturnedWebhookEvent {
|
|
|
957
978
|
*/
|
|
958
979
|
amount: string;
|
|
959
980
|
/**
|
|
960
|
-
*
|
|
961
|
-
*/
|
|
962
|
-
created_at: string;
|
|
963
|
-
/**
|
|
964
|
-
* Currency code (ISO 4217 currency code or crypto currency code).
|
|
981
|
+
* Currency code (ISO 4217 or crypto).
|
|
965
982
|
*/
|
|
966
983
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
967
984
|
/**
|
|
@@ -972,18 +989,31 @@ export declare namespace ReturnReturnedWebhookEvent {
|
|
|
972
989
|
* Failure details when status is failed, otherwise null.
|
|
973
990
|
*/
|
|
974
991
|
failure: Payload.Failure | null;
|
|
992
|
+
/**
|
|
993
|
+
* ISO 8601 UTC timestamp when the return was initiated.
|
|
994
|
+
*/
|
|
995
|
+
initiated_at: string;
|
|
996
|
+
/**
|
|
997
|
+
* Payment scheme or blockchain used for the return, or null when unknown.
|
|
998
|
+
*/
|
|
999
|
+
rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
|
|
1000
|
+
/**
|
|
1001
|
+
* ISO 8601 UTC timestamp when the return was sent.
|
|
1002
|
+
*/
|
|
1003
|
+
sent_at: string | null;
|
|
975
1004
|
/**
|
|
976
1005
|
* Current status of the return.
|
|
977
1006
|
*/
|
|
978
|
-
status: '
|
|
1007
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
979
1008
|
/**
|
|
980
|
-
*
|
|
1009
|
+
* Transaction hash for crypto returns, or null when not known. Only blockchain
|
|
1010
|
+
* rails support this field.
|
|
981
1011
|
*/
|
|
982
|
-
|
|
1012
|
+
tx_hash: string | null;
|
|
983
1013
|
/**
|
|
984
|
-
*
|
|
1014
|
+
* Resource type discriminator.
|
|
985
1015
|
*/
|
|
986
|
-
|
|
1016
|
+
type: 'return';
|
|
987
1017
|
}
|
|
988
1018
|
namespace Payload {
|
|
989
1019
|
/**
|
|
@@ -993,7 +1023,7 @@ export declare namespace ReturnReturnedWebhookEvent {
|
|
|
993
1023
|
/**
|
|
994
1024
|
* Failure code.
|
|
995
1025
|
*/
|
|
996
|
-
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
1026
|
+
code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
|
|
997
1027
|
/**
|
|
998
1028
|
* Human-readable description of the failure.
|
|
999
1029
|
*/
|
|
@@ -1005,7 +1035,7 @@ export declare namespace ReturnReturnedWebhookEvent {
|
|
|
1005
1035
|
}
|
|
1006
1036
|
}
|
|
1007
1037
|
}
|
|
1008
|
-
export interface
|
|
1038
|
+
export interface DepositSettledWebhookEvent {
|
|
1009
1039
|
/**
|
|
1010
1040
|
* Unique identifier for the event. Stable across retries.
|
|
1011
1041
|
*/
|
|
@@ -1021,13 +1051,13 @@ export interface DepositReceivedWebhookEvent {
|
|
|
1021
1051
|
/**
|
|
1022
1052
|
* Full resource snapshot at the time of the event.
|
|
1023
1053
|
*/
|
|
1024
|
-
payload:
|
|
1054
|
+
payload: DepositSettledWebhookEvent.Payload;
|
|
1025
1055
|
/**
|
|
1026
1056
|
* Event type in resource.action format.
|
|
1027
1057
|
*/
|
|
1028
|
-
type: 'deposit.
|
|
1058
|
+
type: 'deposit.settled';
|
|
1029
1059
|
}
|
|
1030
|
-
export declare namespace
|
|
1060
|
+
export declare namespace DepositSettledWebhookEvent {
|
|
1031
1061
|
/**
|
|
1032
1062
|
* Full resource snapshot at the time of the event.
|
|
1033
1063
|
*/
|
|
@@ -1037,43 +1067,45 @@ export declare namespace DepositReceivedWebhookEvent {
|
|
|
1037
1067
|
*/
|
|
1038
1068
|
id: string;
|
|
1039
1069
|
/**
|
|
1040
|
-
*
|
|
1070
|
+
* ID of the account that was credited with the deposit.
|
|
1041
1071
|
*/
|
|
1042
|
-
|
|
1072
|
+
account_id: string;
|
|
1043
1073
|
/**
|
|
1044
|
-
*
|
|
1074
|
+
* Amount as a string decimal (e.g. "100.50").
|
|
1045
1075
|
*/
|
|
1046
|
-
|
|
1076
|
+
amount: string;
|
|
1047
1077
|
/**
|
|
1048
|
-
*
|
|
1078
|
+
* ID of the counterparty that sent the money, or null when not known.
|
|
1049
1079
|
*/
|
|
1050
|
-
|
|
1080
|
+
counterparty_id: string | null;
|
|
1051
1081
|
/**
|
|
1052
|
-
*
|
|
1082
|
+
* Currency code (ISO 4217 or crypto).
|
|
1053
1083
|
*/
|
|
1054
1084
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
1055
1085
|
/**
|
|
1056
|
-
*
|
|
1086
|
+
* Payment scheme or blockchain used for the deposit, or null when unknown.
|
|
1057
1087
|
*/
|
|
1058
|
-
|
|
1059
|
-
/**
|
|
1060
|
-
* Payment rail or blockchain used for the deposit, or null when unknown.
|
|
1061
|
-
*/
|
|
1062
|
-
rail: 'sepa_instant' | 'faster_payments' | 'sepa' | 'elixir' | 'express_elixir' | 'sek_account_to_account' | 'sumclearing' | 'straksclearing' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'btc' | 'btc_testnet4' | 'eth' | 'eth_sepolia' | 'sol' | 'sol_devnet' | 'matic' | 'matic_amoy' | null;
|
|
1088
|
+
rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
|
|
1063
1089
|
/**
|
|
1064
1090
|
* Array of deposit return IDs associated with this deposit.
|
|
1065
1091
|
*/
|
|
1066
1092
|
returns: Array<string>;
|
|
1067
1093
|
/**
|
|
1068
|
-
*
|
|
1094
|
+
* ISO 8601 UTC timestamp when the deposit was settled.
|
|
1069
1095
|
*/
|
|
1070
|
-
|
|
1096
|
+
settled_at: string;
|
|
1071
1097
|
/**
|
|
1072
1098
|
* Current status of the deposit.
|
|
1073
1099
|
*/
|
|
1074
|
-
status: '
|
|
1100
|
+
status: 'settled';
|
|
1101
|
+
/**
|
|
1102
|
+
* Reference used to track the payment across the payment network, such as the UETR
|
|
1103
|
+
* for SWIFT payments.
|
|
1104
|
+
*/
|
|
1105
|
+
tracking_reference: string | null;
|
|
1075
1106
|
/**
|
|
1076
|
-
* Transaction hash for crypto deposits, or null when not known.
|
|
1107
|
+
* Transaction hash for crypto deposits, or null when not known. Only blockchain
|
|
1108
|
+
* rails support this field.
|
|
1077
1109
|
*/
|
|
1078
1110
|
tx_hash: string | null;
|
|
1079
1111
|
/**
|
|
@@ -1081,79 +1113,10 @@ export declare namespace DepositReceivedWebhookEvent {
|
|
|
1081
1113
|
*/
|
|
1082
1114
|
type: 'deposit';
|
|
1083
1115
|
/**
|
|
1084
|
-
*
|
|
1116
|
+
* Unstructured remittance information attached to the transfer. Not all rails
|
|
1117
|
+
* support this field.
|
|
1085
1118
|
*/
|
|
1086
|
-
|
|
1087
|
-
}
|
|
1088
|
-
namespace Payload {
|
|
1089
|
-
interface Iban {
|
|
1090
|
-
/**
|
|
1091
|
-
* Name of the account holder.
|
|
1092
|
-
*/
|
|
1093
|
-
account_holder_name: string;
|
|
1094
|
-
/**
|
|
1095
|
-
* Bank Identifier Code, or null if not provided.
|
|
1096
|
-
*/
|
|
1097
|
-
bic: string | null;
|
|
1098
|
-
/**
|
|
1099
|
-
* International Bank Account Number.
|
|
1100
|
-
*/
|
|
1101
|
-
iban: string;
|
|
1102
|
-
/**
|
|
1103
|
-
* Discriminator for IBAN source.
|
|
1104
|
-
*/
|
|
1105
|
-
type: 'iban';
|
|
1106
|
-
}
|
|
1107
|
-
interface UkSortCode {
|
|
1108
|
-
/**
|
|
1109
|
-
* Name of the account holder.
|
|
1110
|
-
*/
|
|
1111
|
-
account_holder_name: string;
|
|
1112
|
-
/**
|
|
1113
|
-
* UK account number (8 digits).
|
|
1114
|
-
*/
|
|
1115
|
-
account_number: string;
|
|
1116
|
-
/**
|
|
1117
|
-
* UK sort code (6 digits).
|
|
1118
|
-
*/
|
|
1119
|
-
sort_code: string;
|
|
1120
|
-
/**
|
|
1121
|
-
* Discriminator for UK sort code source.
|
|
1122
|
-
*/
|
|
1123
|
-
type: 'sort_code';
|
|
1124
|
-
}
|
|
1125
|
-
interface Aba {
|
|
1126
|
-
/**
|
|
1127
|
-
* Name of the account holder.
|
|
1128
|
-
*/
|
|
1129
|
-
account_holder_name: string;
|
|
1130
|
-
/**
|
|
1131
|
-
* Bank account number.
|
|
1132
|
-
*/
|
|
1133
|
-
account_number: string;
|
|
1134
|
-
/**
|
|
1135
|
-
* ABA routing number (9 digits).
|
|
1136
|
-
*/
|
|
1137
|
-
routing_number: string;
|
|
1138
|
-
/**
|
|
1139
|
-
* Discriminator for ABA wire source.
|
|
1140
|
-
*/
|
|
1141
|
-
type: 'aba';
|
|
1142
|
-
}
|
|
1143
|
-
interface Wallet {
|
|
1144
|
-
/**
|
|
1145
|
-
* Wallet address on the specified blockchain.
|
|
1146
|
-
*/
|
|
1147
|
-
address: string;
|
|
1148
|
-
/**
|
|
1149
|
-
* Blockchain network for the crypto wallet.
|
|
1150
|
-
*/
|
|
1151
|
-
blockchain: 'bitcoin' | 'ethereum' | 'solana' | 'polygon' | 'bitcoin_testnet4' | 'ethereum_sepolia' | 'solana_devnet' | 'polygon_amoy';
|
|
1152
|
-
/**
|
|
1153
|
-
* Discriminator for crypto wallet source.
|
|
1154
|
-
*/
|
|
1155
|
-
type: 'crypto_wallet';
|
|
1156
|
-
}
|
|
1119
|
+
unstructured_remittance_information: string | null;
|
|
1157
1120
|
}
|
|
1158
1121
|
}
|
|
1159
1122
|
export interface ConversionCreatedWebhookEvent {
|
|
@@ -1195,32 +1158,20 @@ export declare namespace ConversionCreatedWebhookEvent {
|
|
|
1195
1158
|
* ISO 8601 UTC timestamp when the conversion was created.
|
|
1196
1159
|
*/
|
|
1197
1160
|
created_at: string;
|
|
1198
|
-
/**
|
|
1199
|
-
* Failure details when status is failed, otherwise null.
|
|
1200
|
-
*/
|
|
1201
|
-
failure: Payload.Failure | null;
|
|
1202
1161
|
/**
|
|
1203
1162
|
* Key-value pairs stored with the conversion.
|
|
1204
1163
|
*/
|
|
1205
1164
|
metadata: {
|
|
1206
1165
|
[key: string]: string;
|
|
1207
1166
|
};
|
|
1208
|
-
/**
|
|
1209
|
-
* ID of the associated quote, or null.
|
|
1210
|
-
*/
|
|
1211
|
-
quote_id: string | null;
|
|
1212
1167
|
/**
|
|
1213
1168
|
* ID of the source account, or null.
|
|
1214
1169
|
*/
|
|
1215
1170
|
source_account_id: string | null;
|
|
1216
1171
|
/**
|
|
1217
|
-
*
|
|
1172
|
+
* Amount as a string decimal (e.g. "100.50").
|
|
1218
1173
|
*/
|
|
1219
1174
|
source_amount: string;
|
|
1220
|
-
/**
|
|
1221
|
-
* Source currency code.
|
|
1222
|
-
*/
|
|
1223
|
-
source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
1224
1175
|
/**
|
|
1225
1176
|
* Current status of the conversion.
|
|
1226
1177
|
*/
|
|
@@ -1230,9 +1181,9 @@ export declare namespace ConversionCreatedWebhookEvent {
|
|
|
1230
1181
|
*/
|
|
1231
1182
|
target_account_id: string | null;
|
|
1232
1183
|
/**
|
|
1233
|
-
*
|
|
1184
|
+
* Amount as a string decimal (e.g. "100.50").
|
|
1234
1185
|
*/
|
|
1235
|
-
|
|
1186
|
+
target_amount: string;
|
|
1236
1187
|
/**
|
|
1237
1188
|
* Resource type discriminator.
|
|
1238
1189
|
*/
|
|
@@ -1242,17 +1193,6 @@ export declare namespace ConversionCreatedWebhookEvent {
|
|
|
1242
1193
|
*/
|
|
1243
1194
|
updated_at: string;
|
|
1244
1195
|
}
|
|
1245
|
-
namespace Payload {
|
|
1246
|
-
/**
|
|
1247
|
-
* Failure details when status is failed, otherwise null.
|
|
1248
|
-
*/
|
|
1249
|
-
interface Failure {
|
|
1250
|
-
/**
|
|
1251
|
-
* Human-readable description of the failure.
|
|
1252
|
-
*/
|
|
1253
|
-
message: string;
|
|
1254
|
-
}
|
|
1255
|
-
}
|
|
1256
1196
|
}
|
|
1257
1197
|
export interface ConversionCompletedWebhookEvent {
|
|
1258
1198
|
/**
|
|
@@ -1293,32 +1233,20 @@ export declare namespace ConversionCompletedWebhookEvent {
|
|
|
1293
1233
|
* ISO 8601 UTC timestamp when the conversion was created.
|
|
1294
1234
|
*/
|
|
1295
1235
|
created_at: string;
|
|
1296
|
-
/**
|
|
1297
|
-
* Failure details when status is failed, otherwise null.
|
|
1298
|
-
*/
|
|
1299
|
-
failure: Payload.Failure | null;
|
|
1300
1236
|
/**
|
|
1301
1237
|
* Key-value pairs stored with the conversion.
|
|
1302
1238
|
*/
|
|
1303
1239
|
metadata: {
|
|
1304
1240
|
[key: string]: string;
|
|
1305
1241
|
};
|
|
1306
|
-
/**
|
|
1307
|
-
* ID of the associated quote, or null.
|
|
1308
|
-
*/
|
|
1309
|
-
quote_id: string | null;
|
|
1310
1242
|
/**
|
|
1311
1243
|
* ID of the source account, or null.
|
|
1312
1244
|
*/
|
|
1313
1245
|
source_account_id: string | null;
|
|
1314
1246
|
/**
|
|
1315
|
-
*
|
|
1247
|
+
* Amount as a string decimal (e.g. "100.50").
|
|
1316
1248
|
*/
|
|
1317
1249
|
source_amount: string;
|
|
1318
|
-
/**
|
|
1319
|
-
* Source currency code.
|
|
1320
|
-
*/
|
|
1321
|
-
source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
1322
1250
|
/**
|
|
1323
1251
|
* Current status of the conversion.
|
|
1324
1252
|
*/
|
|
@@ -1328,9 +1256,9 @@ export declare namespace ConversionCompletedWebhookEvent {
|
|
|
1328
1256
|
*/
|
|
1329
1257
|
target_account_id: string | null;
|
|
1330
1258
|
/**
|
|
1331
|
-
*
|
|
1259
|
+
* Amount as a string decimal (e.g. "100.50").
|
|
1332
1260
|
*/
|
|
1333
|
-
|
|
1261
|
+
target_amount: string;
|
|
1334
1262
|
/**
|
|
1335
1263
|
* Resource type discriminator.
|
|
1336
1264
|
*/
|
|
@@ -1340,17 +1268,6 @@ export declare namespace ConversionCompletedWebhookEvent {
|
|
|
1340
1268
|
*/
|
|
1341
1269
|
updated_at: string;
|
|
1342
1270
|
}
|
|
1343
|
-
namespace Payload {
|
|
1344
|
-
/**
|
|
1345
|
-
* Failure details when status is failed, otherwise null.
|
|
1346
|
-
*/
|
|
1347
|
-
interface Failure {
|
|
1348
|
-
/**
|
|
1349
|
-
* Human-readable description of the failure.
|
|
1350
|
-
*/
|
|
1351
|
-
message: string;
|
|
1352
|
-
}
|
|
1353
|
-
}
|
|
1354
1271
|
}
|
|
1355
1272
|
export interface ConversionFailedWebhookEvent {
|
|
1356
1273
|
/**
|
|
@@ -1391,32 +1308,20 @@ export declare namespace ConversionFailedWebhookEvent {
|
|
|
1391
1308
|
* ISO 8601 UTC timestamp when the conversion was created.
|
|
1392
1309
|
*/
|
|
1393
1310
|
created_at: string;
|
|
1394
|
-
/**
|
|
1395
|
-
* Failure details when status is failed, otherwise null.
|
|
1396
|
-
*/
|
|
1397
|
-
failure: Payload.Failure | null;
|
|
1398
1311
|
/**
|
|
1399
1312
|
* Key-value pairs stored with the conversion.
|
|
1400
1313
|
*/
|
|
1401
1314
|
metadata: {
|
|
1402
1315
|
[key: string]: string;
|
|
1403
1316
|
};
|
|
1404
|
-
/**
|
|
1405
|
-
* ID of the associated quote, or null.
|
|
1406
|
-
*/
|
|
1407
|
-
quote_id: string | null;
|
|
1408
1317
|
/**
|
|
1409
1318
|
* ID of the source account, or null.
|
|
1410
1319
|
*/
|
|
1411
1320
|
source_account_id: string | null;
|
|
1412
1321
|
/**
|
|
1413
|
-
*
|
|
1322
|
+
* Amount as a string decimal (e.g. "100.50").
|
|
1414
1323
|
*/
|
|
1415
1324
|
source_amount: string;
|
|
1416
|
-
/**
|
|
1417
|
-
* Source currency code.
|
|
1418
|
-
*/
|
|
1419
|
-
source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
1420
1325
|
/**
|
|
1421
1326
|
* Current status of the conversion.
|
|
1422
1327
|
*/
|
|
@@ -1426,9 +1331,9 @@ export declare namespace ConversionFailedWebhookEvent {
|
|
|
1426
1331
|
*/
|
|
1427
1332
|
target_account_id: string | null;
|
|
1428
1333
|
/**
|
|
1429
|
-
*
|
|
1334
|
+
* Amount as a string decimal (e.g. "100.50").
|
|
1430
1335
|
*/
|
|
1431
|
-
|
|
1336
|
+
target_amount: string;
|
|
1432
1337
|
/**
|
|
1433
1338
|
* Resource type discriminator.
|
|
1434
1339
|
*/
|
|
@@ -1438,17 +1343,6 @@ export declare namespace ConversionFailedWebhookEvent {
|
|
|
1438
1343
|
*/
|
|
1439
1344
|
updated_at: string;
|
|
1440
1345
|
}
|
|
1441
|
-
namespace Payload {
|
|
1442
|
-
/**
|
|
1443
|
-
* Failure details when status is failed, otherwise null.
|
|
1444
|
-
*/
|
|
1445
|
-
interface Failure {
|
|
1446
|
-
/**
|
|
1447
|
-
* Human-readable description of the failure.
|
|
1448
|
-
*/
|
|
1449
|
-
message: string;
|
|
1450
|
-
}
|
|
1451
|
-
}
|
|
1452
1346
|
}
|
|
1453
1347
|
export interface AccountHolderActiveWebhookEvent {
|
|
1454
1348
|
/**
|
|
@@ -1482,9 +1376,12 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1482
1376
|
*/
|
|
1483
1377
|
id: string;
|
|
1484
1378
|
/**
|
|
1485
|
-
* Beneficiary details used to create this account holder.
|
|
1379
|
+
* Beneficiary details used to create this account holder. Which shape is returned
|
|
1380
|
+
* follows `country_of_citizenship`: **US individual** when it is `US`, **Non-US
|
|
1381
|
+
* individual** for any other country, **Business** when `holder_type` is
|
|
1382
|
+
* `business`.
|
|
1486
1383
|
*/
|
|
1487
|
-
beneficiary_data: Payload.
|
|
1384
|
+
beneficiary_data: Payload.V1UsBeneficiaryDataResponse | Payload.V1NonUsBeneficiaryDataResponse | Payload.V1BusinessBeneficiaryDataResponse;
|
|
1488
1385
|
/**
|
|
1489
1386
|
* ISO 8601 UTC timestamp when the account holder was created.
|
|
1490
1387
|
*/
|
|
@@ -1503,7 +1400,7 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1503
1400
|
type: 'account_holder';
|
|
1504
1401
|
}
|
|
1505
1402
|
namespace Payload {
|
|
1506
|
-
interface
|
|
1403
|
+
interface V1UsBeneficiaryDataResponse {
|
|
1507
1404
|
/**
|
|
1508
1405
|
* ISO 3166-1 alpha-2 country code of citizenship.
|
|
1509
1406
|
*/
|
|
@@ -1516,75 +1413,81 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1516
1413
|
* Government-issued identification with type: "ssn" (Social Security Number,
|
|
1517
1414
|
* format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
|
|
1518
1415
|
*/
|
|
1519
|
-
identification:
|
|
1416
|
+
identification: V1UsBeneficiaryDataResponse.V1SsnIdentification | V1UsBeneficiaryDataResponse.V1ItinIdentification;
|
|
1520
1417
|
/**
|
|
1521
1418
|
* Full legal name of the account holder.
|
|
1522
1419
|
*/
|
|
1523
1420
|
legal_name: string;
|
|
1524
1421
|
/**
|
|
1525
|
-
* Residential address of the account holder.
|
|
1422
|
+
* Residential address of the account holder. **US address** requires
|
|
1423
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1424
|
+
* other country and allows `state` to be null.
|
|
1526
1425
|
*/
|
|
1527
|
-
residential_address:
|
|
1426
|
+
residential_address: V1UsBeneficiaryDataResponse.V1UsResidentialAddress | V1UsBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
1528
1427
|
}
|
|
1529
|
-
namespace
|
|
1530
|
-
interface
|
|
1428
|
+
namespace V1UsBeneficiaryDataResponse {
|
|
1429
|
+
interface V1SsnIdentification {
|
|
1531
1430
|
type: 'ssn';
|
|
1532
1431
|
value: string;
|
|
1533
1432
|
}
|
|
1534
|
-
interface
|
|
1433
|
+
interface V1ItinIdentification {
|
|
1535
1434
|
type: 'itin';
|
|
1536
1435
|
value: string;
|
|
1537
1436
|
}
|
|
1538
|
-
interface
|
|
1437
|
+
interface V1UsResidentialAddress {
|
|
1539
1438
|
/**
|
|
1540
|
-
* City
|
|
1439
|
+
* City or locality.
|
|
1541
1440
|
*/
|
|
1542
1441
|
city: string;
|
|
1543
1442
|
/**
|
|
1544
1443
|
* ISO 3166-1 alpha-2 country code.
|
|
1545
1444
|
*/
|
|
1546
|
-
|
|
1445
|
+
country_code: 'US';
|
|
1547
1446
|
/**
|
|
1548
|
-
*
|
|
1447
|
+
* Primary street address.
|
|
1549
1448
|
*/
|
|
1550
|
-
|
|
1449
|
+
line_1: string;
|
|
1551
1450
|
/**
|
|
1552
|
-
*
|
|
1451
|
+
* Secondary street address, or null if not recorded.
|
|
1553
1452
|
*/
|
|
1554
|
-
|
|
1453
|
+
line_2: string | null;
|
|
1555
1454
|
/**
|
|
1556
|
-
*
|
|
1455
|
+
* Postal or ZIP code.
|
|
1557
1456
|
*/
|
|
1558
|
-
|
|
1457
|
+
postal_code: string;
|
|
1559
1458
|
/**
|
|
1560
|
-
*
|
|
1459
|
+
* State, province, or region.
|
|
1561
1460
|
*/
|
|
1562
|
-
|
|
1461
|
+
state: string;
|
|
1563
1462
|
}
|
|
1564
|
-
interface
|
|
1463
|
+
interface V1NonUsResidentialAddress {
|
|
1565
1464
|
/**
|
|
1566
|
-
* City
|
|
1465
|
+
* City or locality.
|
|
1567
1466
|
*/
|
|
1568
1467
|
city: string;
|
|
1569
1468
|
/**
|
|
1570
1469
|
* ISO 3166-1 alpha-2 country code.
|
|
1571
1470
|
*/
|
|
1572
|
-
|
|
1471
|
+
country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
1573
1472
|
/**
|
|
1574
|
-
*
|
|
1473
|
+
* Primary street address.
|
|
1575
1474
|
*/
|
|
1576
|
-
|
|
1475
|
+
line_1: string;
|
|
1577
1476
|
/**
|
|
1578
|
-
*
|
|
1477
|
+
* Secondary street address, or null if not recorded.
|
|
1579
1478
|
*/
|
|
1580
|
-
|
|
1479
|
+
line_2: string | null;
|
|
1480
|
+
/**
|
|
1481
|
+
* Postal or ZIP code.
|
|
1482
|
+
*/
|
|
1483
|
+
postal_code: string;
|
|
1581
1484
|
/**
|
|
1582
|
-
*
|
|
1485
|
+
* State, province, or region, or null if not recorded.
|
|
1583
1486
|
*/
|
|
1584
|
-
|
|
1487
|
+
state: string | null;
|
|
1585
1488
|
}
|
|
1586
1489
|
}
|
|
1587
|
-
interface
|
|
1490
|
+
interface V1NonUsBeneficiaryDataResponse {
|
|
1588
1491
|
/**
|
|
1589
1492
|
* ISO 3166-1 alpha-2 country code of citizenship.
|
|
1590
1493
|
*/
|
|
@@ -1596,17 +1499,19 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1596
1499
|
/**
|
|
1597
1500
|
* Government-issued identification with type: "id" (generic government-issued ID).
|
|
1598
1501
|
*/
|
|
1599
|
-
identification:
|
|
1502
|
+
identification: V1NonUsBeneficiaryDataResponse.Identification;
|
|
1600
1503
|
/**
|
|
1601
1504
|
* Full legal name of the account holder.
|
|
1602
1505
|
*/
|
|
1603
1506
|
legal_name: string;
|
|
1604
1507
|
/**
|
|
1605
|
-
* Residential address of the account holder.
|
|
1508
|
+
* Residential address of the account holder. **US address** requires
|
|
1509
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1510
|
+
* other country and allows `state` to be null.
|
|
1606
1511
|
*/
|
|
1607
|
-
residential_address:
|
|
1512
|
+
residential_address: V1NonUsBeneficiaryDataResponse.V1UsResidentialAddress | V1NonUsBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
1608
1513
|
}
|
|
1609
|
-
namespace
|
|
1514
|
+
namespace V1NonUsBeneficiaryDataResponse {
|
|
1610
1515
|
/**
|
|
1611
1516
|
* Government-issued identification with type: "id" (generic government-issued ID).
|
|
1612
1517
|
*/
|
|
@@ -1614,65 +1519,70 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1614
1519
|
type: 'id';
|
|
1615
1520
|
value: string;
|
|
1616
1521
|
}
|
|
1617
|
-
interface
|
|
1522
|
+
interface V1UsResidentialAddress {
|
|
1618
1523
|
/**
|
|
1619
|
-
* City
|
|
1524
|
+
* City or locality.
|
|
1620
1525
|
*/
|
|
1621
1526
|
city: string;
|
|
1622
1527
|
/**
|
|
1623
1528
|
* ISO 3166-1 alpha-2 country code.
|
|
1624
1529
|
*/
|
|
1625
|
-
|
|
1530
|
+
country_code: 'US';
|
|
1626
1531
|
/**
|
|
1627
|
-
*
|
|
1532
|
+
* Primary street address.
|
|
1628
1533
|
*/
|
|
1629
|
-
|
|
1534
|
+
line_1: string;
|
|
1630
1535
|
/**
|
|
1631
|
-
*
|
|
1536
|
+
* Secondary street address, or null if not recorded.
|
|
1632
1537
|
*/
|
|
1633
|
-
|
|
1538
|
+
line_2: string | null;
|
|
1634
1539
|
/**
|
|
1635
|
-
*
|
|
1540
|
+
* Postal or ZIP code.
|
|
1636
1541
|
*/
|
|
1637
|
-
|
|
1542
|
+
postal_code: string;
|
|
1638
1543
|
/**
|
|
1639
|
-
*
|
|
1544
|
+
* State, province, or region.
|
|
1640
1545
|
*/
|
|
1641
|
-
|
|
1546
|
+
state: string;
|
|
1642
1547
|
}
|
|
1643
|
-
interface
|
|
1548
|
+
interface V1NonUsResidentialAddress {
|
|
1644
1549
|
/**
|
|
1645
|
-
* City
|
|
1550
|
+
* City or locality.
|
|
1646
1551
|
*/
|
|
1647
1552
|
city: string;
|
|
1648
1553
|
/**
|
|
1649
1554
|
* ISO 3166-1 alpha-2 country code.
|
|
1650
1555
|
*/
|
|
1651
|
-
|
|
1556
|
+
country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
1652
1557
|
/**
|
|
1653
|
-
*
|
|
1558
|
+
* Primary street address.
|
|
1654
1559
|
*/
|
|
1655
|
-
|
|
1560
|
+
line_1: string;
|
|
1656
1561
|
/**
|
|
1657
|
-
*
|
|
1562
|
+
* Secondary street address, or null if not recorded.
|
|
1658
1563
|
*/
|
|
1659
|
-
|
|
1564
|
+
line_2: string | null;
|
|
1565
|
+
/**
|
|
1566
|
+
* Postal or ZIP code.
|
|
1567
|
+
*/
|
|
1568
|
+
postal_code: string;
|
|
1660
1569
|
/**
|
|
1661
|
-
*
|
|
1570
|
+
* State, province, or region, or null if not recorded.
|
|
1662
1571
|
*/
|
|
1663
|
-
|
|
1572
|
+
state: string | null;
|
|
1664
1573
|
}
|
|
1665
1574
|
}
|
|
1666
|
-
interface
|
|
1575
|
+
interface V1BusinessBeneficiaryDataResponse {
|
|
1667
1576
|
/**
|
|
1668
1577
|
* Beneficial owners of the business. At least one required.
|
|
1669
1578
|
*/
|
|
1670
|
-
beneficial_owners: Array<
|
|
1579
|
+
beneficial_owners: Array<V1BusinessBeneficiaryDataResponse.V1UsBeneficiaryDataResponse | V1BusinessBeneficiaryDataResponse.V1NonUsBeneficiaryDataResponse>;
|
|
1671
1580
|
/**
|
|
1672
1581
|
* Individual with primary responsibility for controlling, managing, or directing
|
|
1673
|
-
* the business.
|
|
1582
|
+
* the business. Follows the same US / non-US split as `beneficiary_data`, based on
|
|
1583
|
+
* the control person's own `country_of_citizenship`.
|
|
1674
1584
|
*/
|
|
1675
|
-
control_person:
|
|
1585
|
+
control_person: V1BusinessBeneficiaryDataResponse.UnionMember0 | V1BusinessBeneficiaryDataResponse.UnionMember1;
|
|
1676
1586
|
/**
|
|
1677
1587
|
* ISO 3166-1 alpha-2 country code where the business is incorporated.
|
|
1678
1588
|
*/
|
|
@@ -1686,18 +1596,22 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1686
1596
|
*/
|
|
1687
1597
|
legal_business_name: string;
|
|
1688
1598
|
/**
|
|
1689
|
-
* Physical operating address of the business.
|
|
1599
|
+
* Physical operating address of the business. **US address** requires
|
|
1600
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1601
|
+
* other country and allows `state` to be null.
|
|
1690
1602
|
*/
|
|
1691
|
-
physical_address:
|
|
1603
|
+
physical_address: V1BusinessBeneficiaryDataResponse.V1UsResidentialAddress | V1BusinessBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
1692
1604
|
/**
|
|
1693
|
-
* Registered legal address of the business.
|
|
1605
|
+
* Registered legal address of the business. **US address** requires
|
|
1606
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1607
|
+
* other country and allows `state` to be null.
|
|
1694
1608
|
*/
|
|
1695
|
-
registered_address:
|
|
1609
|
+
registered_address: V1BusinessBeneficiaryDataResponse.V1UsResidentialAddress | V1BusinessBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
1696
1610
|
/**
|
|
1697
1611
|
* Business registration number: type "ein" (Employer Identification Number, format
|
|
1698
1612
|
* ##-#######) or "ssn" (Social Security Number, format ###-##-####).
|
|
1699
1613
|
*/
|
|
1700
|
-
registration_number:
|
|
1614
|
+
registration_number: V1BusinessBeneficiaryDataResponse.V1EinIdentification | V1BusinessBeneficiaryDataResponse.V1SsnIdentification;
|
|
1701
1615
|
/**
|
|
1702
1616
|
* State or subdivision where the business is incorporated.
|
|
1703
1617
|
*/
|
|
@@ -1707,8 +1621,8 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1707
1621
|
*/
|
|
1708
1622
|
year_of_incorporation: number;
|
|
1709
1623
|
}
|
|
1710
|
-
namespace
|
|
1711
|
-
interface
|
|
1624
|
+
namespace V1BusinessBeneficiaryDataResponse {
|
|
1625
|
+
interface V1UsBeneficiaryDataResponse {
|
|
1712
1626
|
/**
|
|
1713
1627
|
* ISO 3166-1 alpha-2 country code of citizenship.
|
|
1714
1628
|
*/
|
|
@@ -1721,75 +1635,81 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1721
1635
|
* Government-issued identification with type: "ssn" (Social Security Number,
|
|
1722
1636
|
* format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
|
|
1723
1637
|
*/
|
|
1724
|
-
identification:
|
|
1638
|
+
identification: V1UsBeneficiaryDataResponse.V1SsnIdentification | V1UsBeneficiaryDataResponse.V1ItinIdentification;
|
|
1725
1639
|
/**
|
|
1726
1640
|
* Full legal name of the account holder.
|
|
1727
1641
|
*/
|
|
1728
1642
|
legal_name: string;
|
|
1729
1643
|
/**
|
|
1730
|
-
* Residential address of the account holder.
|
|
1644
|
+
* Residential address of the account holder. **US address** requires
|
|
1645
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1646
|
+
* other country and allows `state` to be null.
|
|
1731
1647
|
*/
|
|
1732
|
-
residential_address:
|
|
1648
|
+
residential_address: V1UsBeneficiaryDataResponse.V1UsResidentialAddress | V1UsBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
1733
1649
|
}
|
|
1734
|
-
namespace
|
|
1735
|
-
interface
|
|
1650
|
+
namespace V1UsBeneficiaryDataResponse {
|
|
1651
|
+
interface V1SsnIdentification {
|
|
1736
1652
|
type: 'ssn';
|
|
1737
1653
|
value: string;
|
|
1738
1654
|
}
|
|
1739
|
-
interface
|
|
1655
|
+
interface V1ItinIdentification {
|
|
1740
1656
|
type: 'itin';
|
|
1741
1657
|
value: string;
|
|
1742
1658
|
}
|
|
1743
|
-
interface
|
|
1659
|
+
interface V1UsResidentialAddress {
|
|
1744
1660
|
/**
|
|
1745
|
-
* City
|
|
1661
|
+
* City or locality.
|
|
1746
1662
|
*/
|
|
1747
1663
|
city: string;
|
|
1748
1664
|
/**
|
|
1749
1665
|
* ISO 3166-1 alpha-2 country code.
|
|
1750
1666
|
*/
|
|
1751
|
-
|
|
1667
|
+
country_code: 'US';
|
|
1752
1668
|
/**
|
|
1753
|
-
*
|
|
1669
|
+
* Primary street address.
|
|
1754
1670
|
*/
|
|
1755
|
-
|
|
1671
|
+
line_1: string;
|
|
1756
1672
|
/**
|
|
1757
|
-
*
|
|
1673
|
+
* Secondary street address, or null if not recorded.
|
|
1758
1674
|
*/
|
|
1759
|
-
|
|
1675
|
+
line_2: string | null;
|
|
1760
1676
|
/**
|
|
1761
|
-
*
|
|
1677
|
+
* Postal or ZIP code.
|
|
1762
1678
|
*/
|
|
1763
|
-
|
|
1679
|
+
postal_code: string;
|
|
1764
1680
|
/**
|
|
1765
|
-
*
|
|
1681
|
+
* State, province, or region.
|
|
1766
1682
|
*/
|
|
1767
|
-
|
|
1683
|
+
state: string;
|
|
1768
1684
|
}
|
|
1769
|
-
interface
|
|
1685
|
+
interface V1NonUsResidentialAddress {
|
|
1770
1686
|
/**
|
|
1771
|
-
* City
|
|
1687
|
+
* City or locality.
|
|
1772
1688
|
*/
|
|
1773
1689
|
city: string;
|
|
1774
1690
|
/**
|
|
1775
1691
|
* ISO 3166-1 alpha-2 country code.
|
|
1776
1692
|
*/
|
|
1777
|
-
|
|
1693
|
+
country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
1778
1694
|
/**
|
|
1779
|
-
*
|
|
1695
|
+
* Primary street address.
|
|
1780
1696
|
*/
|
|
1781
|
-
|
|
1697
|
+
line_1: string;
|
|
1782
1698
|
/**
|
|
1783
|
-
*
|
|
1699
|
+
* Secondary street address, or null if not recorded.
|
|
1784
1700
|
*/
|
|
1785
|
-
|
|
1701
|
+
line_2: string | null;
|
|
1702
|
+
/**
|
|
1703
|
+
* Postal or ZIP code.
|
|
1704
|
+
*/
|
|
1705
|
+
postal_code: string;
|
|
1786
1706
|
/**
|
|
1787
|
-
*
|
|
1707
|
+
* State, province, or region, or null if not recorded.
|
|
1788
1708
|
*/
|
|
1789
|
-
|
|
1709
|
+
state: string | null;
|
|
1790
1710
|
}
|
|
1791
1711
|
}
|
|
1792
|
-
interface
|
|
1712
|
+
interface V1NonUsBeneficiaryDataResponse {
|
|
1793
1713
|
/**
|
|
1794
1714
|
* ISO 3166-1 alpha-2 country code of citizenship.
|
|
1795
1715
|
*/
|
|
@@ -1801,17 +1721,19 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1801
1721
|
/**
|
|
1802
1722
|
* Government-issued identification with type: "id" (generic government-issued ID).
|
|
1803
1723
|
*/
|
|
1804
|
-
identification:
|
|
1724
|
+
identification: V1NonUsBeneficiaryDataResponse.Identification;
|
|
1805
1725
|
/**
|
|
1806
1726
|
* Full legal name of the account holder.
|
|
1807
1727
|
*/
|
|
1808
1728
|
legal_name: string;
|
|
1809
1729
|
/**
|
|
1810
|
-
* Residential address of the account holder.
|
|
1730
|
+
* Residential address of the account holder. **US address** requires
|
|
1731
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1732
|
+
* other country and allows `state` to be null.
|
|
1811
1733
|
*/
|
|
1812
|
-
residential_address:
|
|
1734
|
+
residential_address: V1NonUsBeneficiaryDataResponse.V1UsResidentialAddress | V1NonUsBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
1813
1735
|
}
|
|
1814
|
-
namespace
|
|
1736
|
+
namespace V1NonUsBeneficiaryDataResponse {
|
|
1815
1737
|
/**
|
|
1816
1738
|
* Government-issued identification with type: "id" (generic government-issued ID).
|
|
1817
1739
|
*/
|
|
@@ -1819,53 +1741,57 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1819
1741
|
type: 'id';
|
|
1820
1742
|
value: string;
|
|
1821
1743
|
}
|
|
1822
|
-
interface
|
|
1744
|
+
interface V1UsResidentialAddress {
|
|
1823
1745
|
/**
|
|
1824
|
-
* City
|
|
1746
|
+
* City or locality.
|
|
1825
1747
|
*/
|
|
1826
1748
|
city: string;
|
|
1827
1749
|
/**
|
|
1828
1750
|
* ISO 3166-1 alpha-2 country code.
|
|
1829
1751
|
*/
|
|
1830
|
-
|
|
1752
|
+
country_code: 'US';
|
|
1831
1753
|
/**
|
|
1832
|
-
*
|
|
1754
|
+
* Primary street address.
|
|
1833
1755
|
*/
|
|
1834
|
-
|
|
1756
|
+
line_1: string;
|
|
1835
1757
|
/**
|
|
1836
|
-
*
|
|
1758
|
+
* Secondary street address, or null if not recorded.
|
|
1837
1759
|
*/
|
|
1838
|
-
|
|
1760
|
+
line_2: string | null;
|
|
1839
1761
|
/**
|
|
1840
|
-
*
|
|
1762
|
+
* Postal or ZIP code.
|
|
1841
1763
|
*/
|
|
1842
|
-
|
|
1764
|
+
postal_code: string;
|
|
1843
1765
|
/**
|
|
1844
|
-
*
|
|
1766
|
+
* State, province, or region.
|
|
1845
1767
|
*/
|
|
1846
|
-
|
|
1768
|
+
state: string;
|
|
1847
1769
|
}
|
|
1848
|
-
interface
|
|
1770
|
+
interface V1NonUsResidentialAddress {
|
|
1849
1771
|
/**
|
|
1850
|
-
* City
|
|
1772
|
+
* City or locality.
|
|
1851
1773
|
*/
|
|
1852
1774
|
city: string;
|
|
1853
1775
|
/**
|
|
1854
1776
|
* ISO 3166-1 alpha-2 country code.
|
|
1855
1777
|
*/
|
|
1856
|
-
|
|
1778
|
+
country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
1857
1779
|
/**
|
|
1858
|
-
*
|
|
1780
|
+
* Primary street address.
|
|
1859
1781
|
*/
|
|
1860
|
-
|
|
1782
|
+
line_1: string;
|
|
1861
1783
|
/**
|
|
1862
|
-
*
|
|
1784
|
+
* Secondary street address, or null if not recorded.
|
|
1863
1785
|
*/
|
|
1864
|
-
|
|
1786
|
+
line_2: string | null;
|
|
1787
|
+
/**
|
|
1788
|
+
* Postal or ZIP code.
|
|
1789
|
+
*/
|
|
1790
|
+
postal_code: string;
|
|
1865
1791
|
/**
|
|
1866
|
-
*
|
|
1792
|
+
* State, province, or region, or null if not recorded.
|
|
1867
1793
|
*/
|
|
1868
|
-
|
|
1794
|
+
state: string | null;
|
|
1869
1795
|
}
|
|
1870
1796
|
}
|
|
1871
1797
|
interface UnionMember0 {
|
|
@@ -1881,15 +1807,17 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1881
1807
|
* Government-issued identification with type: "ssn" (Social Security Number,
|
|
1882
1808
|
* format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
|
|
1883
1809
|
*/
|
|
1884
|
-
identification: UnionMember0.
|
|
1810
|
+
identification: UnionMember0.V1SsnIdentification | UnionMember0.V1ItinIdentification;
|
|
1885
1811
|
/**
|
|
1886
1812
|
* Full legal name of the account holder.
|
|
1887
1813
|
*/
|
|
1888
1814
|
legal_name: string;
|
|
1889
1815
|
/**
|
|
1890
|
-
* Residential address of the account holder.
|
|
1816
|
+
* Residential address of the account holder. **US address** requires
|
|
1817
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1818
|
+
* other country and allows `state` to be null.
|
|
1891
1819
|
*/
|
|
1892
|
-
residential_address: UnionMember0.
|
|
1820
|
+
residential_address: UnionMember0.V1UsResidentialAddress | UnionMember0.V1NonUsResidentialAddress;
|
|
1893
1821
|
/**
|
|
1894
1822
|
* Role of the control person at the business (e.g., "CEO", "President", "Managing
|
|
1895
1823
|
* Director").
|
|
@@ -1897,61 +1825,65 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1897
1825
|
title: string;
|
|
1898
1826
|
}
|
|
1899
1827
|
namespace UnionMember0 {
|
|
1900
|
-
interface
|
|
1828
|
+
interface V1SsnIdentification {
|
|
1901
1829
|
type: 'ssn';
|
|
1902
1830
|
value: string;
|
|
1903
1831
|
}
|
|
1904
|
-
interface
|
|
1832
|
+
interface V1ItinIdentification {
|
|
1905
1833
|
type: 'itin';
|
|
1906
1834
|
value: string;
|
|
1907
1835
|
}
|
|
1908
|
-
interface
|
|
1836
|
+
interface V1UsResidentialAddress {
|
|
1909
1837
|
/**
|
|
1910
|
-
* City
|
|
1838
|
+
* City or locality.
|
|
1911
1839
|
*/
|
|
1912
1840
|
city: string;
|
|
1913
1841
|
/**
|
|
1914
1842
|
* ISO 3166-1 alpha-2 country code.
|
|
1915
1843
|
*/
|
|
1916
|
-
|
|
1844
|
+
country_code: 'US';
|
|
1917
1845
|
/**
|
|
1918
|
-
*
|
|
1846
|
+
* Primary street address.
|
|
1919
1847
|
*/
|
|
1920
|
-
|
|
1848
|
+
line_1: string;
|
|
1921
1849
|
/**
|
|
1922
|
-
*
|
|
1850
|
+
* Secondary street address, or null if not recorded.
|
|
1923
1851
|
*/
|
|
1924
|
-
|
|
1852
|
+
line_2: string | null;
|
|
1925
1853
|
/**
|
|
1926
|
-
*
|
|
1854
|
+
* Postal or ZIP code.
|
|
1927
1855
|
*/
|
|
1928
|
-
|
|
1856
|
+
postal_code: string;
|
|
1929
1857
|
/**
|
|
1930
|
-
*
|
|
1858
|
+
* State, province, or region.
|
|
1931
1859
|
*/
|
|
1932
|
-
|
|
1860
|
+
state: string;
|
|
1933
1861
|
}
|
|
1934
|
-
interface
|
|
1862
|
+
interface V1NonUsResidentialAddress {
|
|
1935
1863
|
/**
|
|
1936
|
-
* City
|
|
1864
|
+
* City or locality.
|
|
1937
1865
|
*/
|
|
1938
1866
|
city: string;
|
|
1939
1867
|
/**
|
|
1940
1868
|
* ISO 3166-1 alpha-2 country code.
|
|
1941
1869
|
*/
|
|
1942
|
-
|
|
1870
|
+
country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
1943
1871
|
/**
|
|
1944
|
-
*
|
|
1872
|
+
* Primary street address.
|
|
1945
1873
|
*/
|
|
1946
|
-
|
|
1874
|
+
line_1: string;
|
|
1947
1875
|
/**
|
|
1948
|
-
*
|
|
1876
|
+
* Secondary street address, or null if not recorded.
|
|
1949
1877
|
*/
|
|
1950
|
-
|
|
1878
|
+
line_2: string | null;
|
|
1879
|
+
/**
|
|
1880
|
+
* Postal or ZIP code.
|
|
1881
|
+
*/
|
|
1882
|
+
postal_code: string;
|
|
1951
1883
|
/**
|
|
1952
|
-
*
|
|
1884
|
+
* State, province, or region, or null if not recorded.
|
|
1953
1885
|
*/
|
|
1954
|
-
|
|
1886
|
+
state: string | null;
|
|
1955
1887
|
}
|
|
1956
1888
|
}
|
|
1957
1889
|
interface UnionMember1 {
|
|
@@ -1972,9 +1904,11 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1972
1904
|
*/
|
|
1973
1905
|
legal_name: string;
|
|
1974
1906
|
/**
|
|
1975
|
-
* Residential address of the account holder.
|
|
1907
|
+
* Residential address of the account holder. **US address** requires
|
|
1908
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1909
|
+
* other country and allows `state` to be null.
|
|
1976
1910
|
*/
|
|
1977
|
-
residential_address: UnionMember1.
|
|
1911
|
+
residential_address: UnionMember1.V1UsResidentialAddress | UnionMember1.V1NonUsResidentialAddress;
|
|
1978
1912
|
/**
|
|
1979
1913
|
* Role of the control person at the business (e.g., "CEO", "President", "Managing
|
|
1980
1914
|
* Director").
|
|
@@ -1989,156 +1923,168 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1989
1923
|
type: 'id';
|
|
1990
1924
|
value: string;
|
|
1991
1925
|
}
|
|
1992
|
-
interface
|
|
1926
|
+
interface V1UsResidentialAddress {
|
|
1993
1927
|
/**
|
|
1994
|
-
* City
|
|
1928
|
+
* City or locality.
|
|
1995
1929
|
*/
|
|
1996
1930
|
city: string;
|
|
1997
1931
|
/**
|
|
1998
1932
|
* ISO 3166-1 alpha-2 country code.
|
|
1999
1933
|
*/
|
|
2000
|
-
|
|
1934
|
+
country_code: 'US';
|
|
2001
1935
|
/**
|
|
2002
|
-
*
|
|
1936
|
+
* Primary street address.
|
|
2003
1937
|
*/
|
|
2004
|
-
|
|
1938
|
+
line_1: string;
|
|
2005
1939
|
/**
|
|
2006
|
-
*
|
|
1940
|
+
* Secondary street address, or null if not recorded.
|
|
2007
1941
|
*/
|
|
2008
|
-
|
|
1942
|
+
line_2: string | null;
|
|
2009
1943
|
/**
|
|
2010
|
-
*
|
|
1944
|
+
* Postal or ZIP code.
|
|
2011
1945
|
*/
|
|
2012
|
-
|
|
1946
|
+
postal_code: string;
|
|
2013
1947
|
/**
|
|
2014
|
-
*
|
|
1948
|
+
* State, province, or region.
|
|
2015
1949
|
*/
|
|
2016
|
-
|
|
1950
|
+
state: string;
|
|
2017
1951
|
}
|
|
2018
|
-
interface
|
|
1952
|
+
interface V1NonUsResidentialAddress {
|
|
2019
1953
|
/**
|
|
2020
|
-
* City
|
|
1954
|
+
* City or locality.
|
|
2021
1955
|
*/
|
|
2022
1956
|
city: string;
|
|
2023
1957
|
/**
|
|
2024
1958
|
* ISO 3166-1 alpha-2 country code.
|
|
2025
1959
|
*/
|
|
2026
|
-
|
|
1960
|
+
country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
2027
1961
|
/**
|
|
2028
|
-
*
|
|
1962
|
+
* Primary street address.
|
|
2029
1963
|
*/
|
|
2030
|
-
|
|
1964
|
+
line_1: string;
|
|
2031
1965
|
/**
|
|
2032
|
-
*
|
|
1966
|
+
* Secondary street address, or null if not recorded.
|
|
2033
1967
|
*/
|
|
2034
|
-
|
|
1968
|
+
line_2: string | null;
|
|
1969
|
+
/**
|
|
1970
|
+
* Postal or ZIP code.
|
|
1971
|
+
*/
|
|
1972
|
+
postal_code: string;
|
|
2035
1973
|
/**
|
|
2036
|
-
*
|
|
1974
|
+
* State, province, or region, or null if not recorded.
|
|
2037
1975
|
*/
|
|
2038
|
-
|
|
1976
|
+
state: string | null;
|
|
2039
1977
|
}
|
|
2040
1978
|
}
|
|
2041
|
-
interface
|
|
1979
|
+
interface V1UsResidentialAddress {
|
|
2042
1980
|
/**
|
|
2043
|
-
* City
|
|
1981
|
+
* City or locality.
|
|
2044
1982
|
*/
|
|
2045
1983
|
city: string;
|
|
2046
1984
|
/**
|
|
2047
1985
|
* ISO 3166-1 alpha-2 country code.
|
|
2048
1986
|
*/
|
|
2049
|
-
|
|
1987
|
+
country_code: 'US';
|
|
2050
1988
|
/**
|
|
2051
|
-
*
|
|
1989
|
+
* Primary street address.
|
|
2052
1990
|
*/
|
|
2053
|
-
|
|
1991
|
+
line_1: string;
|
|
2054
1992
|
/**
|
|
2055
|
-
*
|
|
1993
|
+
* Secondary street address, or null if not recorded.
|
|
2056
1994
|
*/
|
|
2057
|
-
|
|
1995
|
+
line_2: string | null;
|
|
2058
1996
|
/**
|
|
2059
|
-
*
|
|
1997
|
+
* Postal or ZIP code.
|
|
2060
1998
|
*/
|
|
2061
|
-
|
|
1999
|
+
postal_code: string;
|
|
2062
2000
|
/**
|
|
2063
|
-
*
|
|
2001
|
+
* State, province, or region.
|
|
2064
2002
|
*/
|
|
2065
|
-
|
|
2003
|
+
state: string;
|
|
2066
2004
|
}
|
|
2067
|
-
interface
|
|
2005
|
+
interface V1NonUsResidentialAddress {
|
|
2068
2006
|
/**
|
|
2069
|
-
* City
|
|
2007
|
+
* City or locality.
|
|
2070
2008
|
*/
|
|
2071
2009
|
city: string;
|
|
2072
2010
|
/**
|
|
2073
2011
|
* ISO 3166-1 alpha-2 country code.
|
|
2074
2012
|
*/
|
|
2075
|
-
|
|
2013
|
+
country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
2076
2014
|
/**
|
|
2077
|
-
*
|
|
2015
|
+
* Primary street address.
|
|
2078
2016
|
*/
|
|
2079
|
-
|
|
2017
|
+
line_1: string;
|
|
2080
2018
|
/**
|
|
2081
|
-
*
|
|
2019
|
+
* Secondary street address, or null if not recorded.
|
|
2082
2020
|
*/
|
|
2083
|
-
|
|
2021
|
+
line_2: string | null;
|
|
2022
|
+
/**
|
|
2023
|
+
* Postal or ZIP code.
|
|
2024
|
+
*/
|
|
2025
|
+
postal_code: string;
|
|
2084
2026
|
/**
|
|
2085
|
-
*
|
|
2027
|
+
* State, province, or region, or null if not recorded.
|
|
2086
2028
|
*/
|
|
2087
|
-
|
|
2029
|
+
state: string | null;
|
|
2088
2030
|
}
|
|
2089
|
-
interface
|
|
2031
|
+
interface V1UsResidentialAddress {
|
|
2090
2032
|
/**
|
|
2091
|
-
* City
|
|
2033
|
+
* City or locality.
|
|
2092
2034
|
*/
|
|
2093
2035
|
city: string;
|
|
2094
2036
|
/**
|
|
2095
2037
|
* ISO 3166-1 alpha-2 country code.
|
|
2096
2038
|
*/
|
|
2097
|
-
|
|
2039
|
+
country_code: 'US';
|
|
2098
2040
|
/**
|
|
2099
|
-
*
|
|
2041
|
+
* Primary street address.
|
|
2100
2042
|
*/
|
|
2101
|
-
|
|
2043
|
+
line_1: string;
|
|
2102
2044
|
/**
|
|
2103
|
-
*
|
|
2045
|
+
* Secondary street address, or null if not recorded.
|
|
2104
2046
|
*/
|
|
2105
|
-
|
|
2047
|
+
line_2: string | null;
|
|
2106
2048
|
/**
|
|
2107
|
-
*
|
|
2049
|
+
* Postal or ZIP code.
|
|
2108
2050
|
*/
|
|
2109
|
-
|
|
2051
|
+
postal_code: string;
|
|
2110
2052
|
/**
|
|
2111
|
-
*
|
|
2053
|
+
* State, province, or region.
|
|
2112
2054
|
*/
|
|
2113
|
-
|
|
2055
|
+
state: string;
|
|
2114
2056
|
}
|
|
2115
|
-
interface
|
|
2057
|
+
interface V1NonUsResidentialAddress {
|
|
2116
2058
|
/**
|
|
2117
|
-
* City
|
|
2059
|
+
* City or locality.
|
|
2118
2060
|
*/
|
|
2119
2061
|
city: string;
|
|
2120
2062
|
/**
|
|
2121
2063
|
* ISO 3166-1 alpha-2 country code.
|
|
2122
2064
|
*/
|
|
2123
|
-
|
|
2065
|
+
country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
2124
2066
|
/**
|
|
2125
|
-
*
|
|
2067
|
+
* Primary street address.
|
|
2126
2068
|
*/
|
|
2127
|
-
|
|
2069
|
+
line_1: string;
|
|
2128
2070
|
/**
|
|
2129
|
-
*
|
|
2071
|
+
* Secondary street address, or null if not recorded.
|
|
2130
2072
|
*/
|
|
2131
|
-
|
|
2073
|
+
line_2: string | null;
|
|
2074
|
+
/**
|
|
2075
|
+
* Postal or ZIP code.
|
|
2076
|
+
*/
|
|
2077
|
+
postal_code: string;
|
|
2132
2078
|
/**
|
|
2133
|
-
*
|
|
2079
|
+
* State, province, or region, or null if not recorded.
|
|
2134
2080
|
*/
|
|
2135
|
-
|
|
2081
|
+
state: string | null;
|
|
2136
2082
|
}
|
|
2137
|
-
interface
|
|
2083
|
+
interface V1EinIdentification {
|
|
2138
2084
|
type: 'ein';
|
|
2139
2085
|
value: string;
|
|
2140
2086
|
}
|
|
2141
|
-
interface
|
|
2087
|
+
interface V1SsnIdentification {
|
|
2142
2088
|
type: 'ssn';
|
|
2143
2089
|
value: string;
|
|
2144
2090
|
}
|
|
@@ -2177,9 +2123,12 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2177
2123
|
*/
|
|
2178
2124
|
id: string;
|
|
2179
2125
|
/**
|
|
2180
|
-
* Beneficiary details used to create this account holder.
|
|
2126
|
+
* Beneficiary details used to create this account holder. Which shape is returned
|
|
2127
|
+
* follows `country_of_citizenship`: **US individual** when it is `US`, **Non-US
|
|
2128
|
+
* individual** for any other country, **Business** when `holder_type` is
|
|
2129
|
+
* `business`.
|
|
2181
2130
|
*/
|
|
2182
|
-
beneficiary_data: Payload.
|
|
2131
|
+
beneficiary_data: Payload.V1UsBeneficiaryDataResponse | Payload.V1NonUsBeneficiaryDataResponse | Payload.V1BusinessBeneficiaryDataResponse;
|
|
2183
2132
|
/**
|
|
2184
2133
|
* ISO 8601 UTC timestamp when the account holder was created.
|
|
2185
2134
|
*/
|
|
@@ -2198,7 +2147,7 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2198
2147
|
type: 'account_holder';
|
|
2199
2148
|
}
|
|
2200
2149
|
namespace Payload {
|
|
2201
|
-
interface
|
|
2150
|
+
interface V1UsBeneficiaryDataResponse {
|
|
2202
2151
|
/**
|
|
2203
2152
|
* ISO 3166-1 alpha-2 country code of citizenship.
|
|
2204
2153
|
*/
|
|
@@ -2211,75 +2160,81 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2211
2160
|
* Government-issued identification with type: "ssn" (Social Security Number,
|
|
2212
2161
|
* format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
|
|
2213
2162
|
*/
|
|
2214
|
-
identification:
|
|
2163
|
+
identification: V1UsBeneficiaryDataResponse.V1SsnIdentification | V1UsBeneficiaryDataResponse.V1ItinIdentification;
|
|
2215
2164
|
/**
|
|
2216
2165
|
* Full legal name of the account holder.
|
|
2217
2166
|
*/
|
|
2218
2167
|
legal_name: string;
|
|
2219
2168
|
/**
|
|
2220
|
-
* Residential address of the account holder.
|
|
2169
|
+
* Residential address of the account holder. **US address** requires
|
|
2170
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
2171
|
+
* other country and allows `state` to be null.
|
|
2221
2172
|
*/
|
|
2222
|
-
residential_address:
|
|
2173
|
+
residential_address: V1UsBeneficiaryDataResponse.V1UsResidentialAddress | V1UsBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
2223
2174
|
}
|
|
2224
|
-
namespace
|
|
2225
|
-
interface
|
|
2175
|
+
namespace V1UsBeneficiaryDataResponse {
|
|
2176
|
+
interface V1SsnIdentification {
|
|
2226
2177
|
type: 'ssn';
|
|
2227
2178
|
value: string;
|
|
2228
2179
|
}
|
|
2229
|
-
interface
|
|
2180
|
+
interface V1ItinIdentification {
|
|
2230
2181
|
type: 'itin';
|
|
2231
2182
|
value: string;
|
|
2232
2183
|
}
|
|
2233
|
-
interface
|
|
2184
|
+
interface V1UsResidentialAddress {
|
|
2234
2185
|
/**
|
|
2235
|
-
* City
|
|
2186
|
+
* City or locality.
|
|
2236
2187
|
*/
|
|
2237
2188
|
city: string;
|
|
2238
2189
|
/**
|
|
2239
2190
|
* ISO 3166-1 alpha-2 country code.
|
|
2240
2191
|
*/
|
|
2241
|
-
|
|
2192
|
+
country_code: 'US';
|
|
2242
2193
|
/**
|
|
2243
|
-
*
|
|
2194
|
+
* Primary street address.
|
|
2244
2195
|
*/
|
|
2245
|
-
|
|
2196
|
+
line_1: string;
|
|
2246
2197
|
/**
|
|
2247
|
-
*
|
|
2198
|
+
* Secondary street address, or null if not recorded.
|
|
2248
2199
|
*/
|
|
2249
|
-
|
|
2200
|
+
line_2: string | null;
|
|
2250
2201
|
/**
|
|
2251
|
-
*
|
|
2202
|
+
* Postal or ZIP code.
|
|
2252
2203
|
*/
|
|
2253
|
-
|
|
2204
|
+
postal_code: string;
|
|
2254
2205
|
/**
|
|
2255
|
-
*
|
|
2206
|
+
* State, province, or region.
|
|
2256
2207
|
*/
|
|
2257
|
-
|
|
2208
|
+
state: string;
|
|
2258
2209
|
}
|
|
2259
|
-
interface
|
|
2210
|
+
interface V1NonUsResidentialAddress {
|
|
2260
2211
|
/**
|
|
2261
|
-
* City
|
|
2212
|
+
* City or locality.
|
|
2262
2213
|
*/
|
|
2263
2214
|
city: string;
|
|
2264
2215
|
/**
|
|
2265
2216
|
* ISO 3166-1 alpha-2 country code.
|
|
2266
2217
|
*/
|
|
2267
|
-
|
|
2218
|
+
country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
2268
2219
|
/**
|
|
2269
|
-
*
|
|
2220
|
+
* Primary street address.
|
|
2270
2221
|
*/
|
|
2271
|
-
|
|
2222
|
+
line_1: string;
|
|
2272
2223
|
/**
|
|
2273
|
-
*
|
|
2224
|
+
* Secondary street address, or null if not recorded.
|
|
2274
2225
|
*/
|
|
2275
|
-
|
|
2226
|
+
line_2: string | null;
|
|
2227
|
+
/**
|
|
2228
|
+
* Postal or ZIP code.
|
|
2229
|
+
*/
|
|
2230
|
+
postal_code: string;
|
|
2276
2231
|
/**
|
|
2277
|
-
*
|
|
2232
|
+
* State, province, or region, or null if not recorded.
|
|
2278
2233
|
*/
|
|
2279
|
-
|
|
2234
|
+
state: string | null;
|
|
2280
2235
|
}
|
|
2281
2236
|
}
|
|
2282
|
-
interface
|
|
2237
|
+
interface V1NonUsBeneficiaryDataResponse {
|
|
2283
2238
|
/**
|
|
2284
2239
|
* ISO 3166-1 alpha-2 country code of citizenship.
|
|
2285
2240
|
*/
|
|
@@ -2291,17 +2246,19 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2291
2246
|
/**
|
|
2292
2247
|
* Government-issued identification with type: "id" (generic government-issued ID).
|
|
2293
2248
|
*/
|
|
2294
|
-
identification:
|
|
2249
|
+
identification: V1NonUsBeneficiaryDataResponse.Identification;
|
|
2295
2250
|
/**
|
|
2296
2251
|
* Full legal name of the account holder.
|
|
2297
2252
|
*/
|
|
2298
2253
|
legal_name: string;
|
|
2299
2254
|
/**
|
|
2300
|
-
* Residential address of the account holder.
|
|
2255
|
+
* Residential address of the account holder. **US address** requires
|
|
2256
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
2257
|
+
* other country and allows `state` to be null.
|
|
2301
2258
|
*/
|
|
2302
|
-
residential_address:
|
|
2259
|
+
residential_address: V1NonUsBeneficiaryDataResponse.V1UsResidentialAddress | V1NonUsBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
2303
2260
|
}
|
|
2304
|
-
namespace
|
|
2261
|
+
namespace V1NonUsBeneficiaryDataResponse {
|
|
2305
2262
|
/**
|
|
2306
2263
|
* Government-issued identification with type: "id" (generic government-issued ID).
|
|
2307
2264
|
*/
|
|
@@ -2309,65 +2266,70 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2309
2266
|
type: 'id';
|
|
2310
2267
|
value: string;
|
|
2311
2268
|
}
|
|
2312
|
-
interface
|
|
2269
|
+
interface V1UsResidentialAddress {
|
|
2313
2270
|
/**
|
|
2314
|
-
* City
|
|
2271
|
+
* City or locality.
|
|
2315
2272
|
*/
|
|
2316
2273
|
city: string;
|
|
2317
2274
|
/**
|
|
2318
2275
|
* ISO 3166-1 alpha-2 country code.
|
|
2319
2276
|
*/
|
|
2320
|
-
|
|
2277
|
+
country_code: 'US';
|
|
2321
2278
|
/**
|
|
2322
|
-
*
|
|
2279
|
+
* Primary street address.
|
|
2323
2280
|
*/
|
|
2324
|
-
|
|
2281
|
+
line_1: string;
|
|
2325
2282
|
/**
|
|
2326
|
-
*
|
|
2283
|
+
* Secondary street address, or null if not recorded.
|
|
2327
2284
|
*/
|
|
2328
|
-
|
|
2285
|
+
line_2: string | null;
|
|
2329
2286
|
/**
|
|
2330
|
-
*
|
|
2287
|
+
* Postal or ZIP code.
|
|
2331
2288
|
*/
|
|
2332
|
-
|
|
2289
|
+
postal_code: string;
|
|
2333
2290
|
/**
|
|
2334
|
-
*
|
|
2291
|
+
* State, province, or region.
|
|
2335
2292
|
*/
|
|
2336
|
-
|
|
2293
|
+
state: string;
|
|
2337
2294
|
}
|
|
2338
|
-
interface
|
|
2295
|
+
interface V1NonUsResidentialAddress {
|
|
2339
2296
|
/**
|
|
2340
|
-
* City
|
|
2297
|
+
* City or locality.
|
|
2341
2298
|
*/
|
|
2342
2299
|
city: string;
|
|
2343
2300
|
/**
|
|
2344
2301
|
* ISO 3166-1 alpha-2 country code.
|
|
2345
2302
|
*/
|
|
2346
|
-
|
|
2303
|
+
country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
2347
2304
|
/**
|
|
2348
|
-
*
|
|
2305
|
+
* Primary street address.
|
|
2349
2306
|
*/
|
|
2350
|
-
|
|
2307
|
+
line_1: string;
|
|
2351
2308
|
/**
|
|
2352
|
-
*
|
|
2309
|
+
* Secondary street address, or null if not recorded.
|
|
2353
2310
|
*/
|
|
2354
|
-
|
|
2311
|
+
line_2: string | null;
|
|
2312
|
+
/**
|
|
2313
|
+
* Postal or ZIP code.
|
|
2314
|
+
*/
|
|
2315
|
+
postal_code: string;
|
|
2355
2316
|
/**
|
|
2356
|
-
*
|
|
2317
|
+
* State, province, or region, or null if not recorded.
|
|
2357
2318
|
*/
|
|
2358
|
-
|
|
2319
|
+
state: string | null;
|
|
2359
2320
|
}
|
|
2360
2321
|
}
|
|
2361
|
-
interface
|
|
2322
|
+
interface V1BusinessBeneficiaryDataResponse {
|
|
2362
2323
|
/**
|
|
2363
2324
|
* Beneficial owners of the business. At least one required.
|
|
2364
2325
|
*/
|
|
2365
|
-
beneficial_owners: Array<
|
|
2326
|
+
beneficial_owners: Array<V1BusinessBeneficiaryDataResponse.V1UsBeneficiaryDataResponse | V1BusinessBeneficiaryDataResponse.V1NonUsBeneficiaryDataResponse>;
|
|
2366
2327
|
/**
|
|
2367
2328
|
* Individual with primary responsibility for controlling, managing, or directing
|
|
2368
|
-
* the business.
|
|
2329
|
+
* the business. Follows the same US / non-US split as `beneficiary_data`, based on
|
|
2330
|
+
* the control person's own `country_of_citizenship`.
|
|
2369
2331
|
*/
|
|
2370
|
-
control_person:
|
|
2332
|
+
control_person: V1BusinessBeneficiaryDataResponse.UnionMember0 | V1BusinessBeneficiaryDataResponse.UnionMember1;
|
|
2371
2333
|
/**
|
|
2372
2334
|
* ISO 3166-1 alpha-2 country code where the business is incorporated.
|
|
2373
2335
|
*/
|
|
@@ -2381,18 +2343,22 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2381
2343
|
*/
|
|
2382
2344
|
legal_business_name: string;
|
|
2383
2345
|
/**
|
|
2384
|
-
* Physical operating address of the business.
|
|
2346
|
+
* Physical operating address of the business. **US address** requires
|
|
2347
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
2348
|
+
* other country and allows `state` to be null.
|
|
2385
2349
|
*/
|
|
2386
|
-
physical_address:
|
|
2350
|
+
physical_address: V1BusinessBeneficiaryDataResponse.V1UsResidentialAddress | V1BusinessBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
2387
2351
|
/**
|
|
2388
|
-
* Registered legal address of the business.
|
|
2352
|
+
* Registered legal address of the business. **US address** requires
|
|
2353
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
2354
|
+
* other country and allows `state` to be null.
|
|
2389
2355
|
*/
|
|
2390
|
-
registered_address:
|
|
2356
|
+
registered_address: V1BusinessBeneficiaryDataResponse.V1UsResidentialAddress | V1BusinessBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
2391
2357
|
/**
|
|
2392
2358
|
* Business registration number: type "ein" (Employer Identification Number, format
|
|
2393
2359
|
* ##-#######) or "ssn" (Social Security Number, format ###-##-####).
|
|
2394
2360
|
*/
|
|
2395
|
-
registration_number:
|
|
2361
|
+
registration_number: V1BusinessBeneficiaryDataResponse.V1EinIdentification | V1BusinessBeneficiaryDataResponse.V1SsnIdentification;
|
|
2396
2362
|
/**
|
|
2397
2363
|
* State or subdivision where the business is incorporated.
|
|
2398
2364
|
*/
|
|
@@ -2402,8 +2368,8 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2402
2368
|
*/
|
|
2403
2369
|
year_of_incorporation: number;
|
|
2404
2370
|
}
|
|
2405
|
-
namespace
|
|
2406
|
-
interface
|
|
2371
|
+
namespace V1BusinessBeneficiaryDataResponse {
|
|
2372
|
+
interface V1UsBeneficiaryDataResponse {
|
|
2407
2373
|
/**
|
|
2408
2374
|
* ISO 3166-1 alpha-2 country code of citizenship.
|
|
2409
2375
|
*/
|
|
@@ -2416,75 +2382,81 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2416
2382
|
* Government-issued identification with type: "ssn" (Social Security Number,
|
|
2417
2383
|
* format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
|
|
2418
2384
|
*/
|
|
2419
|
-
identification:
|
|
2385
|
+
identification: V1UsBeneficiaryDataResponse.V1SsnIdentification | V1UsBeneficiaryDataResponse.V1ItinIdentification;
|
|
2420
2386
|
/**
|
|
2421
2387
|
* Full legal name of the account holder.
|
|
2422
2388
|
*/
|
|
2423
2389
|
legal_name: string;
|
|
2424
2390
|
/**
|
|
2425
|
-
* Residential address of the account holder.
|
|
2391
|
+
* Residential address of the account holder. **US address** requires
|
|
2392
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
2393
|
+
* other country and allows `state` to be null.
|
|
2426
2394
|
*/
|
|
2427
|
-
residential_address:
|
|
2395
|
+
residential_address: V1UsBeneficiaryDataResponse.V1UsResidentialAddress | V1UsBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
2428
2396
|
}
|
|
2429
|
-
namespace
|
|
2430
|
-
interface
|
|
2397
|
+
namespace V1UsBeneficiaryDataResponse {
|
|
2398
|
+
interface V1SsnIdentification {
|
|
2431
2399
|
type: 'ssn';
|
|
2432
2400
|
value: string;
|
|
2433
2401
|
}
|
|
2434
|
-
interface
|
|
2402
|
+
interface V1ItinIdentification {
|
|
2435
2403
|
type: 'itin';
|
|
2436
2404
|
value: string;
|
|
2437
2405
|
}
|
|
2438
|
-
interface
|
|
2406
|
+
interface V1UsResidentialAddress {
|
|
2439
2407
|
/**
|
|
2440
|
-
* City
|
|
2408
|
+
* City or locality.
|
|
2441
2409
|
*/
|
|
2442
2410
|
city: string;
|
|
2443
2411
|
/**
|
|
2444
2412
|
* ISO 3166-1 alpha-2 country code.
|
|
2445
2413
|
*/
|
|
2446
|
-
|
|
2414
|
+
country_code: 'US';
|
|
2447
2415
|
/**
|
|
2448
|
-
*
|
|
2416
|
+
* Primary street address.
|
|
2449
2417
|
*/
|
|
2450
|
-
|
|
2418
|
+
line_1: string;
|
|
2451
2419
|
/**
|
|
2452
|
-
*
|
|
2420
|
+
* Secondary street address, or null if not recorded.
|
|
2453
2421
|
*/
|
|
2454
|
-
|
|
2422
|
+
line_2: string | null;
|
|
2455
2423
|
/**
|
|
2456
|
-
*
|
|
2424
|
+
* Postal or ZIP code.
|
|
2457
2425
|
*/
|
|
2458
|
-
|
|
2426
|
+
postal_code: string;
|
|
2459
2427
|
/**
|
|
2460
|
-
*
|
|
2428
|
+
* State, province, or region.
|
|
2461
2429
|
*/
|
|
2462
|
-
|
|
2430
|
+
state: string;
|
|
2463
2431
|
}
|
|
2464
|
-
interface
|
|
2432
|
+
interface V1NonUsResidentialAddress {
|
|
2465
2433
|
/**
|
|
2466
|
-
* City
|
|
2434
|
+
* City or locality.
|
|
2467
2435
|
*/
|
|
2468
2436
|
city: string;
|
|
2469
2437
|
/**
|
|
2470
2438
|
* ISO 3166-1 alpha-2 country code.
|
|
2471
2439
|
*/
|
|
2472
|
-
|
|
2440
|
+
country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
2473
2441
|
/**
|
|
2474
|
-
*
|
|
2442
|
+
* Primary street address.
|
|
2475
2443
|
*/
|
|
2476
|
-
|
|
2444
|
+
line_1: string;
|
|
2477
2445
|
/**
|
|
2478
|
-
*
|
|
2446
|
+
* Secondary street address, or null if not recorded.
|
|
2479
2447
|
*/
|
|
2480
|
-
|
|
2448
|
+
line_2: string | null;
|
|
2449
|
+
/**
|
|
2450
|
+
* Postal or ZIP code.
|
|
2451
|
+
*/
|
|
2452
|
+
postal_code: string;
|
|
2481
2453
|
/**
|
|
2482
|
-
*
|
|
2454
|
+
* State, province, or region, or null if not recorded.
|
|
2483
2455
|
*/
|
|
2484
|
-
|
|
2456
|
+
state: string | null;
|
|
2485
2457
|
}
|
|
2486
2458
|
}
|
|
2487
|
-
interface
|
|
2459
|
+
interface V1NonUsBeneficiaryDataResponse {
|
|
2488
2460
|
/**
|
|
2489
2461
|
* ISO 3166-1 alpha-2 country code of citizenship.
|
|
2490
2462
|
*/
|
|
@@ -2496,17 +2468,19 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2496
2468
|
/**
|
|
2497
2469
|
* Government-issued identification with type: "id" (generic government-issued ID).
|
|
2498
2470
|
*/
|
|
2499
|
-
identification:
|
|
2471
|
+
identification: V1NonUsBeneficiaryDataResponse.Identification;
|
|
2500
2472
|
/**
|
|
2501
2473
|
* Full legal name of the account holder.
|
|
2502
2474
|
*/
|
|
2503
2475
|
legal_name: string;
|
|
2504
2476
|
/**
|
|
2505
|
-
* Residential address of the account holder.
|
|
2477
|
+
* Residential address of the account holder. **US address** requires
|
|
2478
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
2479
|
+
* other country and allows `state` to be null.
|
|
2506
2480
|
*/
|
|
2507
|
-
residential_address:
|
|
2481
|
+
residential_address: V1NonUsBeneficiaryDataResponse.V1UsResidentialAddress | V1NonUsBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
2508
2482
|
}
|
|
2509
|
-
namespace
|
|
2483
|
+
namespace V1NonUsBeneficiaryDataResponse {
|
|
2510
2484
|
/**
|
|
2511
2485
|
* Government-issued identification with type: "id" (generic government-issued ID).
|
|
2512
2486
|
*/
|
|
@@ -2514,53 +2488,57 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2514
2488
|
type: 'id';
|
|
2515
2489
|
value: string;
|
|
2516
2490
|
}
|
|
2517
|
-
interface
|
|
2491
|
+
interface V1UsResidentialAddress {
|
|
2518
2492
|
/**
|
|
2519
|
-
* City
|
|
2493
|
+
* City or locality.
|
|
2520
2494
|
*/
|
|
2521
2495
|
city: string;
|
|
2522
2496
|
/**
|
|
2523
2497
|
* ISO 3166-1 alpha-2 country code.
|
|
2524
2498
|
*/
|
|
2525
|
-
|
|
2499
|
+
country_code: 'US';
|
|
2526
2500
|
/**
|
|
2527
|
-
*
|
|
2501
|
+
* Primary street address.
|
|
2528
2502
|
*/
|
|
2529
|
-
|
|
2503
|
+
line_1: string;
|
|
2530
2504
|
/**
|
|
2531
|
-
*
|
|
2505
|
+
* Secondary street address, or null if not recorded.
|
|
2532
2506
|
*/
|
|
2533
|
-
|
|
2507
|
+
line_2: string | null;
|
|
2534
2508
|
/**
|
|
2535
|
-
*
|
|
2509
|
+
* Postal or ZIP code.
|
|
2536
2510
|
*/
|
|
2537
|
-
|
|
2511
|
+
postal_code: string;
|
|
2538
2512
|
/**
|
|
2539
|
-
*
|
|
2513
|
+
* State, province, or region.
|
|
2540
2514
|
*/
|
|
2541
|
-
|
|
2515
|
+
state: string;
|
|
2542
2516
|
}
|
|
2543
|
-
interface
|
|
2517
|
+
interface V1NonUsResidentialAddress {
|
|
2544
2518
|
/**
|
|
2545
|
-
* City
|
|
2519
|
+
* City or locality.
|
|
2546
2520
|
*/
|
|
2547
2521
|
city: string;
|
|
2548
2522
|
/**
|
|
2549
2523
|
* ISO 3166-1 alpha-2 country code.
|
|
2550
2524
|
*/
|
|
2551
|
-
|
|
2525
|
+
country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
2552
2526
|
/**
|
|
2553
|
-
*
|
|
2527
|
+
* Primary street address.
|
|
2554
2528
|
*/
|
|
2555
|
-
|
|
2529
|
+
line_1: string;
|
|
2556
2530
|
/**
|
|
2557
|
-
*
|
|
2531
|
+
* Secondary street address, or null if not recorded.
|
|
2558
2532
|
*/
|
|
2559
|
-
|
|
2533
|
+
line_2: string | null;
|
|
2534
|
+
/**
|
|
2535
|
+
* Postal or ZIP code.
|
|
2536
|
+
*/
|
|
2537
|
+
postal_code: string;
|
|
2560
2538
|
/**
|
|
2561
|
-
*
|
|
2539
|
+
* State, province, or region, or null if not recorded.
|
|
2562
2540
|
*/
|
|
2563
|
-
|
|
2541
|
+
state: string | null;
|
|
2564
2542
|
}
|
|
2565
2543
|
}
|
|
2566
2544
|
interface UnionMember0 {
|
|
@@ -2576,15 +2554,17 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2576
2554
|
* Government-issued identification with type: "ssn" (Social Security Number,
|
|
2577
2555
|
* format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
|
|
2578
2556
|
*/
|
|
2579
|
-
identification: UnionMember0.
|
|
2557
|
+
identification: UnionMember0.V1SsnIdentification | UnionMember0.V1ItinIdentification;
|
|
2580
2558
|
/**
|
|
2581
2559
|
* Full legal name of the account holder.
|
|
2582
2560
|
*/
|
|
2583
2561
|
legal_name: string;
|
|
2584
2562
|
/**
|
|
2585
|
-
* Residential address of the account holder.
|
|
2563
|
+
* Residential address of the account holder. **US address** requires
|
|
2564
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
2565
|
+
* other country and allows `state` to be null.
|
|
2586
2566
|
*/
|
|
2587
|
-
residential_address: UnionMember0.
|
|
2567
|
+
residential_address: UnionMember0.V1UsResidentialAddress | UnionMember0.V1NonUsResidentialAddress;
|
|
2588
2568
|
/**
|
|
2589
2569
|
* Role of the control person at the business (e.g., "CEO", "President", "Managing
|
|
2590
2570
|
* Director").
|
|
@@ -2592,61 +2572,65 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2592
2572
|
title: string;
|
|
2593
2573
|
}
|
|
2594
2574
|
namespace UnionMember0 {
|
|
2595
|
-
interface
|
|
2575
|
+
interface V1SsnIdentification {
|
|
2596
2576
|
type: 'ssn';
|
|
2597
2577
|
value: string;
|
|
2598
2578
|
}
|
|
2599
|
-
interface
|
|
2579
|
+
interface V1ItinIdentification {
|
|
2600
2580
|
type: 'itin';
|
|
2601
2581
|
value: string;
|
|
2602
2582
|
}
|
|
2603
|
-
interface
|
|
2583
|
+
interface V1UsResidentialAddress {
|
|
2604
2584
|
/**
|
|
2605
|
-
* City
|
|
2585
|
+
* City or locality.
|
|
2606
2586
|
*/
|
|
2607
2587
|
city: string;
|
|
2608
2588
|
/**
|
|
2609
2589
|
* ISO 3166-1 alpha-2 country code.
|
|
2610
2590
|
*/
|
|
2611
|
-
|
|
2591
|
+
country_code: 'US';
|
|
2612
2592
|
/**
|
|
2613
|
-
*
|
|
2593
|
+
* Primary street address.
|
|
2614
2594
|
*/
|
|
2615
|
-
|
|
2595
|
+
line_1: string;
|
|
2616
2596
|
/**
|
|
2617
|
-
*
|
|
2597
|
+
* Secondary street address, or null if not recorded.
|
|
2618
2598
|
*/
|
|
2619
|
-
|
|
2599
|
+
line_2: string | null;
|
|
2620
2600
|
/**
|
|
2621
|
-
*
|
|
2601
|
+
* Postal or ZIP code.
|
|
2622
2602
|
*/
|
|
2623
|
-
|
|
2603
|
+
postal_code: string;
|
|
2624
2604
|
/**
|
|
2625
|
-
*
|
|
2605
|
+
* State, province, or region.
|
|
2626
2606
|
*/
|
|
2627
|
-
|
|
2607
|
+
state: string;
|
|
2628
2608
|
}
|
|
2629
|
-
interface
|
|
2609
|
+
interface V1NonUsResidentialAddress {
|
|
2630
2610
|
/**
|
|
2631
|
-
* City
|
|
2611
|
+
* City or locality.
|
|
2632
2612
|
*/
|
|
2633
2613
|
city: string;
|
|
2634
2614
|
/**
|
|
2635
2615
|
* ISO 3166-1 alpha-2 country code.
|
|
2636
2616
|
*/
|
|
2637
|
-
|
|
2617
|
+
country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
2638
2618
|
/**
|
|
2639
|
-
*
|
|
2619
|
+
* Primary street address.
|
|
2640
2620
|
*/
|
|
2641
|
-
|
|
2621
|
+
line_1: string;
|
|
2642
2622
|
/**
|
|
2643
|
-
*
|
|
2623
|
+
* Secondary street address, or null if not recorded.
|
|
2644
2624
|
*/
|
|
2645
|
-
|
|
2625
|
+
line_2: string | null;
|
|
2626
|
+
/**
|
|
2627
|
+
* Postal or ZIP code.
|
|
2628
|
+
*/
|
|
2629
|
+
postal_code: string;
|
|
2646
2630
|
/**
|
|
2647
|
-
*
|
|
2631
|
+
* State, province, or region, or null if not recorded.
|
|
2648
2632
|
*/
|
|
2649
|
-
|
|
2633
|
+
state: string | null;
|
|
2650
2634
|
}
|
|
2651
2635
|
}
|
|
2652
2636
|
interface UnionMember1 {
|
|
@@ -2667,9 +2651,11 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2667
2651
|
*/
|
|
2668
2652
|
legal_name: string;
|
|
2669
2653
|
/**
|
|
2670
|
-
* Residential address of the account holder.
|
|
2654
|
+
* Residential address of the account holder. **US address** requires
|
|
2655
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
2656
|
+
* other country and allows `state` to be null.
|
|
2671
2657
|
*/
|
|
2672
|
-
residential_address: UnionMember1.
|
|
2658
|
+
residential_address: UnionMember1.V1UsResidentialAddress | UnionMember1.V1NonUsResidentialAddress;
|
|
2673
2659
|
/**
|
|
2674
2660
|
* Role of the control person at the business (e.g., "CEO", "President", "Managing
|
|
2675
2661
|
* Director").
|
|
@@ -2684,156 +2670,168 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2684
2670
|
type: 'id';
|
|
2685
2671
|
value: string;
|
|
2686
2672
|
}
|
|
2687
|
-
interface
|
|
2673
|
+
interface V1UsResidentialAddress {
|
|
2688
2674
|
/**
|
|
2689
|
-
* City
|
|
2675
|
+
* City or locality.
|
|
2690
2676
|
*/
|
|
2691
2677
|
city: string;
|
|
2692
2678
|
/**
|
|
2693
2679
|
* ISO 3166-1 alpha-2 country code.
|
|
2694
2680
|
*/
|
|
2695
|
-
|
|
2681
|
+
country_code: 'US';
|
|
2696
2682
|
/**
|
|
2697
|
-
*
|
|
2683
|
+
* Primary street address.
|
|
2698
2684
|
*/
|
|
2699
|
-
|
|
2685
|
+
line_1: string;
|
|
2700
2686
|
/**
|
|
2701
|
-
*
|
|
2687
|
+
* Secondary street address, or null if not recorded.
|
|
2702
2688
|
*/
|
|
2703
|
-
|
|
2689
|
+
line_2: string | null;
|
|
2704
2690
|
/**
|
|
2705
|
-
*
|
|
2691
|
+
* Postal or ZIP code.
|
|
2706
2692
|
*/
|
|
2707
|
-
|
|
2693
|
+
postal_code: string;
|
|
2708
2694
|
/**
|
|
2709
|
-
*
|
|
2695
|
+
* State, province, or region.
|
|
2710
2696
|
*/
|
|
2711
|
-
|
|
2697
|
+
state: string;
|
|
2712
2698
|
}
|
|
2713
|
-
interface
|
|
2699
|
+
interface V1NonUsResidentialAddress {
|
|
2714
2700
|
/**
|
|
2715
|
-
* City
|
|
2701
|
+
* City or locality.
|
|
2716
2702
|
*/
|
|
2717
2703
|
city: string;
|
|
2718
2704
|
/**
|
|
2719
2705
|
* ISO 3166-1 alpha-2 country code.
|
|
2720
2706
|
*/
|
|
2721
|
-
|
|
2707
|
+
country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
2722
2708
|
/**
|
|
2723
|
-
*
|
|
2709
|
+
* Primary street address.
|
|
2724
2710
|
*/
|
|
2725
|
-
|
|
2711
|
+
line_1: string;
|
|
2726
2712
|
/**
|
|
2727
|
-
*
|
|
2713
|
+
* Secondary street address, or null if not recorded.
|
|
2728
2714
|
*/
|
|
2729
|
-
|
|
2715
|
+
line_2: string | null;
|
|
2716
|
+
/**
|
|
2717
|
+
* Postal or ZIP code.
|
|
2718
|
+
*/
|
|
2719
|
+
postal_code: string;
|
|
2730
2720
|
/**
|
|
2731
|
-
*
|
|
2721
|
+
* State, province, or region, or null if not recorded.
|
|
2732
2722
|
*/
|
|
2733
|
-
|
|
2723
|
+
state: string | null;
|
|
2734
2724
|
}
|
|
2735
2725
|
}
|
|
2736
|
-
interface
|
|
2726
|
+
interface V1UsResidentialAddress {
|
|
2737
2727
|
/**
|
|
2738
|
-
* City
|
|
2728
|
+
* City or locality.
|
|
2739
2729
|
*/
|
|
2740
2730
|
city: string;
|
|
2741
2731
|
/**
|
|
2742
2732
|
* ISO 3166-1 alpha-2 country code.
|
|
2743
2733
|
*/
|
|
2744
|
-
|
|
2734
|
+
country_code: 'US';
|
|
2745
2735
|
/**
|
|
2746
|
-
*
|
|
2736
|
+
* Primary street address.
|
|
2747
2737
|
*/
|
|
2748
|
-
|
|
2738
|
+
line_1: string;
|
|
2749
2739
|
/**
|
|
2750
|
-
*
|
|
2740
|
+
* Secondary street address, or null if not recorded.
|
|
2751
2741
|
*/
|
|
2752
|
-
|
|
2742
|
+
line_2: string | null;
|
|
2753
2743
|
/**
|
|
2754
|
-
*
|
|
2744
|
+
* Postal or ZIP code.
|
|
2755
2745
|
*/
|
|
2756
|
-
|
|
2746
|
+
postal_code: string;
|
|
2757
2747
|
/**
|
|
2758
|
-
*
|
|
2748
|
+
* State, province, or region.
|
|
2759
2749
|
*/
|
|
2760
|
-
|
|
2750
|
+
state: string;
|
|
2761
2751
|
}
|
|
2762
|
-
interface
|
|
2752
|
+
interface V1NonUsResidentialAddress {
|
|
2763
2753
|
/**
|
|
2764
|
-
* City
|
|
2754
|
+
* City or locality.
|
|
2765
2755
|
*/
|
|
2766
2756
|
city: string;
|
|
2767
2757
|
/**
|
|
2768
2758
|
* ISO 3166-1 alpha-2 country code.
|
|
2769
2759
|
*/
|
|
2770
|
-
|
|
2760
|
+
country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
2771
2761
|
/**
|
|
2772
|
-
*
|
|
2762
|
+
* Primary street address.
|
|
2773
2763
|
*/
|
|
2774
|
-
|
|
2764
|
+
line_1: string;
|
|
2775
2765
|
/**
|
|
2776
|
-
*
|
|
2766
|
+
* Secondary street address, or null if not recorded.
|
|
2777
2767
|
*/
|
|
2778
|
-
|
|
2768
|
+
line_2: string | null;
|
|
2769
|
+
/**
|
|
2770
|
+
* Postal or ZIP code.
|
|
2771
|
+
*/
|
|
2772
|
+
postal_code: string;
|
|
2779
2773
|
/**
|
|
2780
|
-
*
|
|
2774
|
+
* State, province, or region, or null if not recorded.
|
|
2781
2775
|
*/
|
|
2782
|
-
|
|
2776
|
+
state: string | null;
|
|
2783
2777
|
}
|
|
2784
|
-
interface
|
|
2778
|
+
interface V1UsResidentialAddress {
|
|
2785
2779
|
/**
|
|
2786
|
-
* City
|
|
2780
|
+
* City or locality.
|
|
2787
2781
|
*/
|
|
2788
2782
|
city: string;
|
|
2789
2783
|
/**
|
|
2790
2784
|
* ISO 3166-1 alpha-2 country code.
|
|
2791
2785
|
*/
|
|
2792
|
-
|
|
2786
|
+
country_code: 'US';
|
|
2793
2787
|
/**
|
|
2794
|
-
*
|
|
2788
|
+
* Primary street address.
|
|
2795
2789
|
*/
|
|
2796
|
-
|
|
2790
|
+
line_1: string;
|
|
2797
2791
|
/**
|
|
2798
|
-
*
|
|
2792
|
+
* Secondary street address, or null if not recorded.
|
|
2799
2793
|
*/
|
|
2800
|
-
|
|
2794
|
+
line_2: string | null;
|
|
2801
2795
|
/**
|
|
2802
|
-
*
|
|
2796
|
+
* Postal or ZIP code.
|
|
2803
2797
|
*/
|
|
2804
|
-
|
|
2798
|
+
postal_code: string;
|
|
2805
2799
|
/**
|
|
2806
|
-
*
|
|
2800
|
+
* State, province, or region.
|
|
2807
2801
|
*/
|
|
2808
|
-
|
|
2802
|
+
state: string;
|
|
2809
2803
|
}
|
|
2810
|
-
interface
|
|
2804
|
+
interface V1NonUsResidentialAddress {
|
|
2811
2805
|
/**
|
|
2812
|
-
* City
|
|
2806
|
+
* City or locality.
|
|
2813
2807
|
*/
|
|
2814
2808
|
city: string;
|
|
2815
2809
|
/**
|
|
2816
2810
|
* ISO 3166-1 alpha-2 country code.
|
|
2817
2811
|
*/
|
|
2818
|
-
|
|
2812
|
+
country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
2819
2813
|
/**
|
|
2820
|
-
*
|
|
2814
|
+
* Primary street address.
|
|
2821
2815
|
*/
|
|
2822
|
-
|
|
2816
|
+
line_1: string;
|
|
2823
2817
|
/**
|
|
2824
|
-
*
|
|
2818
|
+
* Secondary street address, or null if not recorded.
|
|
2825
2819
|
*/
|
|
2826
|
-
|
|
2820
|
+
line_2: string | null;
|
|
2821
|
+
/**
|
|
2822
|
+
* Postal or ZIP code.
|
|
2823
|
+
*/
|
|
2824
|
+
postal_code: string;
|
|
2827
2825
|
/**
|
|
2828
|
-
*
|
|
2826
|
+
* State, province, or region, or null if not recorded.
|
|
2829
2827
|
*/
|
|
2830
|
-
|
|
2828
|
+
state: string | null;
|
|
2831
2829
|
}
|
|
2832
|
-
interface
|
|
2830
|
+
interface V1EinIdentification {
|
|
2833
2831
|
type: 'ein';
|
|
2834
2832
|
value: string;
|
|
2835
2833
|
}
|
|
2836
|
-
interface
|
|
2834
|
+
interface V1SsnIdentification {
|
|
2837
2835
|
type: 'ssn';
|
|
2838
2836
|
value: string;
|
|
2839
2837
|
}
|
|
@@ -2890,8 +2888,8 @@ export declare namespace PingTestWebhookEvent {
|
|
|
2890
2888
|
type: 'ping';
|
|
2891
2889
|
}
|
|
2892
2890
|
}
|
|
2893
|
-
export type UnwrapWebhookEvent =
|
|
2891
|
+
export type UnwrapWebhookEvent = PayoutInitiatedWebhookEvent | PayoutSubmittedWebhookEvent | PayoutSentWebhookEvent | PayoutFailedWebhookEvent | PayoutReturnedWebhookEvent | ReturnInitiatedWebhookEvent | ReturnSubmittedWebhookEvent | ReturnSentWebhookEvent | ReturnFailedWebhookEvent | ReturnReturnedWebhookEvent | DepositSettledWebhookEvent | ConversionCreatedWebhookEvent | ConversionCompletedWebhookEvent | ConversionFailedWebhookEvent | AccountHolderActiveWebhookEvent | AccountHolderClosedWebhookEvent | PingTestWebhookEvent;
|
|
2894
2892
|
export declare namespace Webhooks {
|
|
2895
|
-
export { type
|
|
2893
|
+
export { type PayoutInitiatedWebhookEvent as PayoutInitiatedWebhookEvent, type PayoutSubmittedWebhookEvent as PayoutSubmittedWebhookEvent, type PayoutSentWebhookEvent as PayoutSentWebhookEvent, type PayoutFailedWebhookEvent as PayoutFailedWebhookEvent, type PayoutReturnedWebhookEvent as PayoutReturnedWebhookEvent, type ReturnInitiatedWebhookEvent as ReturnInitiatedWebhookEvent, type ReturnSubmittedWebhookEvent as ReturnSubmittedWebhookEvent, type ReturnSentWebhookEvent as ReturnSentWebhookEvent, type ReturnFailedWebhookEvent as ReturnFailedWebhookEvent, type ReturnReturnedWebhookEvent as ReturnReturnedWebhookEvent, type DepositSettledWebhookEvent as DepositSettledWebhookEvent, type ConversionCreatedWebhookEvent as ConversionCreatedWebhookEvent, type ConversionCompletedWebhookEvent as ConversionCompletedWebhookEvent, type ConversionFailedWebhookEvent as ConversionFailedWebhookEvent, type AccountHolderActiveWebhookEvent as AccountHolderActiveWebhookEvent, type AccountHolderClosedWebhookEvent as AccountHolderClosedWebhookEvent, type PingTestWebhookEvent as PingTestWebhookEvent, type UnwrapWebhookEvent as UnwrapWebhookEvent, };
|
|
2896
2894
|
}
|
|
2897
2895
|
//# sourceMappingURL=webhooks.d.mts.map
|