@augustusbank/typescript-sdk 0.20.0 → 0.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +28 -0
- package/client.d.mts +6 -0
- package/client.d.mts.map +1 -1
- package/client.d.ts +6 -0
- 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 +2 -2
- package/resources/account-programs.d.ts +2 -2
- package/resources/accounts.d.mts +206 -43
- package/resources/accounts.d.mts.map +1 -1
- package/resources/accounts.d.ts +206 -43
- package/resources/accounts.d.ts.map +1 -1
- package/resources/accounts.js +53 -0
- package/resources/accounts.js.map +1 -1
- package/resources/accounts.mjs +53 -0
- 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 +38 -186
- package/resources/deposits.d.mts.map +1 -1
- package/resources/deposits.d.ts +38 -186
- package/resources/deposits.d.ts.map +1 -1
- package/resources/index.d.mts +2 -0
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -0
- 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 +458 -276
- package/resources/payouts.d.mts.map +1 -1
- package/resources/payouts.d.ts +458 -276
- package/resources/payouts.d.ts.map +1 -1
- package/resources/payouts.js +27 -0
- package/resources/payouts.js.map +1 -1
- package/resources/payouts.mjs +27 -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 +281 -0
- package/resources/simulations/account-programs.d.mts.map +1 -0
- package/resources/simulations/account-programs.d.ts +281 -0
- package/resources/simulations/account-programs.d.ts.map +1 -0
- package/resources/simulations/account-programs.js +98 -0
- package/resources/simulations/account-programs.js.map +1 -0
- package/resources/simulations/account-programs.mjs +94 -0
- package/resources/simulations/account-programs.mjs.map +1 -0
- package/resources/simulations/accounts.d.mts +270 -0
- package/resources/simulations/accounts.d.mts.map +1 -0
- package/resources/simulations/accounts.d.ts +270 -0
- package/resources/simulations/accounts.d.ts.map +1 -0
- package/resources/simulations/accounts.js +91 -0
- package/resources/simulations/accounts.js.map +1 -0
- package/resources/simulations/accounts.mjs +87 -0
- package/resources/simulations/accounts.mjs.map +1 -0
- package/resources/simulations/deposits.d.mts +218 -0
- package/resources/simulations/deposits.d.mts.map +1 -0
- package/resources/simulations/deposits.d.ts +218 -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 +6 -0
- package/resources/simulations/index.d.mts.map +1 -0
- package/resources/simulations/index.d.ts +6 -0
- package/resources/simulations/index.d.ts.map +1 -0
- package/resources/simulations/index.js +15 -0
- package/resources/simulations/index.js.map +1 -0
- package/resources/simulations/index.mjs +7 -0
- package/resources/simulations/index.mjs.map +1 -0
- package/resources/simulations/payouts.d.mts +76 -0
- package/resources/simulations/payouts.d.mts.map +1 -0
- package/resources/simulations/payouts.d.ts +76 -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 +22 -0
- package/resources/simulations/simulations.d.mts.map +1 -0
- package/resources/simulations/simulations.d.ts +22 -0
- package/resources/simulations/simulations.d.ts.map +1 -0
- package/resources/simulations/simulations.js +29 -0
- package/resources/simulations/simulations.js.map +1 -0
- package/resources/simulations/simulations.mjs +24 -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 +300 -180
- package/resources/transactions.d.mts.map +1 -1
- package/resources/transactions.d.ts +300 -180
- package/resources/transactions.d.ts.map +1 -1
- package/resources/webhook-subscriptions.d.mts +54 -4
- package/resources/webhook-subscriptions.d.mts.map +1 -1
- package/resources/webhook-subscriptions.d.ts +54 -4
- 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 +736 -953
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +736 -953
- package/resources/webhooks.d.ts.map +1 -1
- package/src/client.ts +32 -0
- package/src/resources/account-holders.ts +1701 -1282
- package/src/resources/account-programs.ts +2 -2
- package/src/resources/accounts.ts +236 -44
- 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 +54 -269
- package/src/resources/index.ts +13 -0
- package/src/resources/payouts.ts +2089 -367
- 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 +363 -0
- package/src/resources/simulations/accounts.ts +340 -0
- package/src/resources/simulations/deposits.ts +530 -0
- package/src/resources/simulations/index.ts +32 -0
- package/src/resources/simulations/payouts.ts +98 -0
- package/src/resources/simulations/simulations.ts +82 -0
- package/src/resources/simulations.ts +3 -0
- package/src/resources/transactions.ts +910 -232
- package/src/resources/webhook-subscriptions.ts +54 -4
- package/src/resources/webhooks.ts +948 -1126
- 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
|
@@ -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.UnionMember0 | Payload.UnionMember1 | Payload.UnionMember2 | Payload.UnionMember3;
|
|
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,37 @@ 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
|
+
* Identifier used to track the payout through the payment network where supported.
|
|
83
|
+
*/
|
|
84
|
+
tracking_id: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* Transaction hash for crypto payouts, or null when not known. Only blockchain
|
|
87
|
+
* rails support this field.
|
|
88
|
+
*/
|
|
89
|
+
tx_hash: string | null;
|
|
77
90
|
/**
|
|
78
91
|
* Resource type discriminator.
|
|
79
92
|
*/
|
|
80
93
|
type: 'payout';
|
|
81
94
|
/**
|
|
82
|
-
*
|
|
95
|
+
* Unstructured remittance information attached to the transfer. Not all rails
|
|
96
|
+
* support this field.
|
|
83
97
|
*/
|
|
84
|
-
|
|
98
|
+
unstructured_remittance_information: string | null;
|
|
85
99
|
}
|
|
86
100
|
namespace Payload {
|
|
87
|
-
interface UnionMember0 {
|
|
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 UnionMember1 {
|
|
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 UnionMember2 {
|
|
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 UnionMember3 {
|
|
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
101
|
/**
|
|
156
102
|
* Failure details when status is failed, otherwise null.
|
|
157
103
|
*/
|
|
@@ -159,7 +105,7 @@ export declare namespace PayoutCreatedWebhookEvent {
|
|
|
159
105
|
/**
|
|
160
106
|
* Failure code.
|
|
161
107
|
*/
|
|
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';
|
|
108
|
+
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
109
|
/**
|
|
164
110
|
* Human-readable description of the failure.
|
|
165
111
|
*/
|
|
@@ -202,26 +148,30 @@ export declare namespace PayoutInitiatedWebhookEvent {
|
|
|
202
148
|
* Unique identifier of the payout.
|
|
203
149
|
*/
|
|
204
150
|
id: string;
|
|
151
|
+
/**
|
|
152
|
+
* ID of the account that was debited.
|
|
153
|
+
*/
|
|
154
|
+
account_id: string;
|
|
205
155
|
/**
|
|
206
156
|
* Amount as a string decimal (e.g. "100.50").
|
|
207
157
|
*/
|
|
208
158
|
amount: string;
|
|
209
159
|
/**
|
|
210
|
-
*
|
|
160
|
+
* ID of the counterparty that receives the money.
|
|
211
161
|
*/
|
|
212
|
-
|
|
162
|
+
counterparty_id: string;
|
|
213
163
|
/**
|
|
214
|
-
* Currency code (ISO 4217
|
|
164
|
+
* Currency code (ISO 4217 or crypto).
|
|
215
165
|
*/
|
|
216
166
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
217
|
-
/**
|
|
218
|
-
* Bank account or crypto wallet the payout was sent to.
|
|
219
|
-
*/
|
|
220
|
-
destination: Payload.UnionMember0 | Payload.UnionMember1 | Payload.UnionMember2 | Payload.UnionMember3;
|
|
221
167
|
/**
|
|
222
168
|
* Failure details when status is failed, otherwise null.
|
|
223
169
|
*/
|
|
224
170
|
failure: Payload.Failure | null;
|
|
171
|
+
/**
|
|
172
|
+
* ISO 8601 UTC timestamp when the payout was initiated.
|
|
173
|
+
*/
|
|
174
|
+
initiated_at: string;
|
|
225
175
|
/**
|
|
226
176
|
* Key-value pairs stored with the payout.
|
|
227
177
|
*/
|
|
@@ -229,95 +179,37 @@ export declare namespace PayoutInitiatedWebhookEvent {
|
|
|
229
179
|
[key: string]: string;
|
|
230
180
|
};
|
|
231
181
|
/**
|
|
232
|
-
* Payment
|
|
182
|
+
* Payment scheme or blockchain used for the payout, or null when unknown.
|
|
233
183
|
*/
|
|
234
|
-
|
|
184
|
+
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
185
|
/**
|
|
236
|
-
*
|
|
186
|
+
* ISO 8601 UTC timestamp when the payout was sent.
|
|
237
187
|
*/
|
|
238
|
-
|
|
188
|
+
sent_at: string | null;
|
|
239
189
|
/**
|
|
240
190
|
* Current status of the payout.
|
|
241
191
|
*/
|
|
242
|
-
status: '
|
|
192
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
193
|
+
/**
|
|
194
|
+
* Identifier used to track the payout through the payment network where supported.
|
|
195
|
+
*/
|
|
196
|
+
tracking_id: string | null;
|
|
197
|
+
/**
|
|
198
|
+
* Transaction hash for crypto payouts, or null when not known. Only blockchain
|
|
199
|
+
* rails support this field.
|
|
200
|
+
*/
|
|
201
|
+
tx_hash: string | null;
|
|
243
202
|
/**
|
|
244
203
|
* Resource type discriminator.
|
|
245
204
|
*/
|
|
246
205
|
type: 'payout';
|
|
247
206
|
/**
|
|
248
|
-
*
|
|
207
|
+
* Unstructured remittance information attached to the transfer. Not all rails
|
|
208
|
+
* support this field.
|
|
249
209
|
*/
|
|
250
|
-
|
|
210
|
+
unstructured_remittance_information: string | null;
|
|
251
211
|
}
|
|
252
212
|
namespace Payload {
|
|
253
|
-
interface UnionMember0 {
|
|
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 UnionMember1 {
|
|
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 UnionMember2 {
|
|
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 UnionMember3 {
|
|
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
213
|
/**
|
|
322
214
|
* Failure details when status is failed, otherwise null.
|
|
323
215
|
*/
|
|
@@ -325,7 +217,7 @@ export declare namespace PayoutInitiatedWebhookEvent {
|
|
|
325
217
|
/**
|
|
326
218
|
* Failure code.
|
|
327
219
|
*/
|
|
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';
|
|
220
|
+
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
221
|
/**
|
|
330
222
|
* Human-readable description of the failure.
|
|
331
223
|
*/
|
|
@@ -368,26 +260,30 @@ export declare namespace PayoutPaidWebhookEvent {
|
|
|
368
260
|
* Unique identifier of the payout.
|
|
369
261
|
*/
|
|
370
262
|
id: string;
|
|
263
|
+
/**
|
|
264
|
+
* ID of the account that was debited.
|
|
265
|
+
*/
|
|
266
|
+
account_id: string;
|
|
371
267
|
/**
|
|
372
268
|
* Amount as a string decimal (e.g. "100.50").
|
|
373
269
|
*/
|
|
374
270
|
amount: string;
|
|
375
271
|
/**
|
|
376
|
-
*
|
|
272
|
+
* ID of the counterparty that receives the money.
|
|
377
273
|
*/
|
|
378
|
-
|
|
274
|
+
counterparty_id: string;
|
|
379
275
|
/**
|
|
380
|
-
* Currency code (ISO 4217
|
|
276
|
+
* Currency code (ISO 4217 or crypto).
|
|
381
277
|
*/
|
|
382
278
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
383
|
-
/**
|
|
384
|
-
* Bank account or crypto wallet the payout was sent to.
|
|
385
|
-
*/
|
|
386
|
-
destination: Payload.UnionMember0 | Payload.UnionMember1 | Payload.UnionMember2 | Payload.UnionMember3;
|
|
387
279
|
/**
|
|
388
280
|
* Failure details when status is failed, otherwise null.
|
|
389
281
|
*/
|
|
390
282
|
failure: Payload.Failure | null;
|
|
283
|
+
/**
|
|
284
|
+
* ISO 8601 UTC timestamp when the payout was initiated.
|
|
285
|
+
*/
|
|
286
|
+
initiated_at: string;
|
|
391
287
|
/**
|
|
392
288
|
* Key-value pairs stored with the payout.
|
|
393
289
|
*/
|
|
@@ -395,95 +291,37 @@ export declare namespace PayoutPaidWebhookEvent {
|
|
|
395
291
|
[key: string]: string;
|
|
396
292
|
};
|
|
397
293
|
/**
|
|
398
|
-
* Payment
|
|
294
|
+
* Payment scheme or blockchain used for the payout, or null when unknown.
|
|
399
295
|
*/
|
|
400
|
-
|
|
296
|
+
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
297
|
/**
|
|
402
|
-
*
|
|
298
|
+
* ISO 8601 UTC timestamp when the payout was sent.
|
|
403
299
|
*/
|
|
404
|
-
|
|
300
|
+
sent_at: string | null;
|
|
405
301
|
/**
|
|
406
302
|
* Current status of the payout.
|
|
407
303
|
*/
|
|
408
|
-
status: '
|
|
304
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
305
|
+
/**
|
|
306
|
+
* Identifier used to track the payout through the payment network where supported.
|
|
307
|
+
*/
|
|
308
|
+
tracking_id: string | null;
|
|
309
|
+
/**
|
|
310
|
+
* Transaction hash for crypto payouts, or null when not known. Only blockchain
|
|
311
|
+
* rails support this field.
|
|
312
|
+
*/
|
|
313
|
+
tx_hash: string | null;
|
|
409
314
|
/**
|
|
410
315
|
* Resource type discriminator.
|
|
411
316
|
*/
|
|
412
317
|
type: 'payout';
|
|
413
318
|
/**
|
|
414
|
-
*
|
|
319
|
+
* Unstructured remittance information attached to the transfer. Not all rails
|
|
320
|
+
* support this field.
|
|
415
321
|
*/
|
|
416
|
-
|
|
322
|
+
unstructured_remittance_information: string | null;
|
|
417
323
|
}
|
|
418
324
|
namespace Payload {
|
|
419
|
-
interface UnionMember0 {
|
|
420
|
-
/**
|
|
421
|
-
* Name of the account holder.
|
|
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 UnionMember1 {
|
|
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 UnionMember2 {
|
|
456
|
-
/**
|
|
457
|
-
* Name of the account holder.
|
|
458
|
-
*/
|
|
459
|
-
account_holder_name: string;
|
|
460
|
-
/**
|
|
461
|
-
* Bank account number.
|
|
462
|
-
*/
|
|
463
|
-
account_number: string;
|
|
464
|
-
/**
|
|
465
|
-
* ABA routing number (9 digits).
|
|
466
|
-
*/
|
|
467
|
-
routing_number: string;
|
|
468
|
-
/**
|
|
469
|
-
* Discriminator for ABA wire financial address.
|
|
470
|
-
*/
|
|
471
|
-
type: 'aba';
|
|
472
|
-
}
|
|
473
|
-
interface UnionMember3 {
|
|
474
|
-
/**
|
|
475
|
-
* Wallet address on the specified blockchain.
|
|
476
|
-
*/
|
|
477
|
-
address: string;
|
|
478
|
-
/**
|
|
479
|
-
* Blockchain network for the crypto wallet.
|
|
480
|
-
*/
|
|
481
|
-
blockchain: 'bitcoin' | 'ethereum' | 'solana' | 'polygon' | 'bitcoin_testnet4' | 'ethereum_sepolia' | 'solana_devnet' | 'polygon_amoy';
|
|
482
|
-
/**
|
|
483
|
-
* Discriminator for crypto wallet financial address.
|
|
484
|
-
*/
|
|
485
|
-
type: 'crypto_wallet';
|
|
486
|
-
}
|
|
487
325
|
/**
|
|
488
326
|
* Failure details when status is failed, otherwise null.
|
|
489
327
|
*/
|
|
@@ -491,7 +329,7 @@ export declare namespace PayoutPaidWebhookEvent {
|
|
|
491
329
|
/**
|
|
492
330
|
* Failure code.
|
|
493
331
|
*/
|
|
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';
|
|
332
|
+
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
333
|
/**
|
|
496
334
|
* Human-readable description of the failure.
|
|
497
335
|
*/
|
|
@@ -534,26 +372,30 @@ export declare namespace PayoutFailedWebhookEvent {
|
|
|
534
372
|
* Unique identifier of the payout.
|
|
535
373
|
*/
|
|
536
374
|
id: string;
|
|
375
|
+
/**
|
|
376
|
+
* ID of the account that was debited.
|
|
377
|
+
*/
|
|
378
|
+
account_id: string;
|
|
537
379
|
/**
|
|
538
380
|
* Amount as a string decimal (e.g. "100.50").
|
|
539
381
|
*/
|
|
540
382
|
amount: string;
|
|
541
383
|
/**
|
|
542
|
-
*
|
|
384
|
+
* ID of the counterparty that receives the money.
|
|
543
385
|
*/
|
|
544
|
-
|
|
386
|
+
counterparty_id: string;
|
|
545
387
|
/**
|
|
546
|
-
* Currency code (ISO 4217
|
|
388
|
+
* Currency code (ISO 4217 or crypto).
|
|
547
389
|
*/
|
|
548
390
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
549
|
-
/**
|
|
550
|
-
* Bank account or crypto wallet the payout was sent to.
|
|
551
|
-
*/
|
|
552
|
-
destination: Payload.UnionMember0 | Payload.UnionMember1 | Payload.UnionMember2 | Payload.UnionMember3;
|
|
553
391
|
/**
|
|
554
392
|
* Failure details when status is failed, otherwise null.
|
|
555
393
|
*/
|
|
556
394
|
failure: Payload.Failure | null;
|
|
395
|
+
/**
|
|
396
|
+
* ISO 8601 UTC timestamp when the payout was initiated.
|
|
397
|
+
*/
|
|
398
|
+
initiated_at: string;
|
|
557
399
|
/**
|
|
558
400
|
* Key-value pairs stored with the payout.
|
|
559
401
|
*/
|
|
@@ -561,95 +403,37 @@ export declare namespace PayoutFailedWebhookEvent {
|
|
|
561
403
|
[key: string]: string;
|
|
562
404
|
};
|
|
563
405
|
/**
|
|
564
|
-
* Payment
|
|
406
|
+
* Payment scheme or blockchain used for the payout, or null when unknown.
|
|
565
407
|
*/
|
|
566
|
-
|
|
408
|
+
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
409
|
/**
|
|
568
|
-
*
|
|
410
|
+
* ISO 8601 UTC timestamp when the payout was sent.
|
|
569
411
|
*/
|
|
570
|
-
|
|
412
|
+
sent_at: string | null;
|
|
571
413
|
/**
|
|
572
414
|
* Current status of the payout.
|
|
573
415
|
*/
|
|
574
|
-
status: '
|
|
416
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
417
|
+
/**
|
|
418
|
+
* Identifier used to track the payout through the payment network where supported.
|
|
419
|
+
*/
|
|
420
|
+
tracking_id: string | null;
|
|
421
|
+
/**
|
|
422
|
+
* Transaction hash for crypto payouts, or null when not known. Only blockchain
|
|
423
|
+
* rails support this field.
|
|
424
|
+
*/
|
|
425
|
+
tx_hash: string | null;
|
|
575
426
|
/**
|
|
576
427
|
* Resource type discriminator.
|
|
577
428
|
*/
|
|
578
429
|
type: 'payout';
|
|
579
430
|
/**
|
|
580
|
-
*
|
|
431
|
+
* Unstructured remittance information attached to the transfer. Not all rails
|
|
432
|
+
* support this field.
|
|
581
433
|
*/
|
|
582
|
-
|
|
434
|
+
unstructured_remittance_information: string | null;
|
|
583
435
|
}
|
|
584
436
|
namespace Payload {
|
|
585
|
-
interface UnionMember0 {
|
|
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 UnionMember1 {
|
|
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 UnionMember2 {
|
|
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 UnionMember3 {
|
|
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
437
|
/**
|
|
654
438
|
* Failure details when status is failed, otherwise null.
|
|
655
439
|
*/
|
|
@@ -657,7 +441,7 @@ export declare namespace PayoutFailedWebhookEvent {
|
|
|
657
441
|
/**
|
|
658
442
|
* Failure code.
|
|
659
443
|
*/
|
|
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';
|
|
444
|
+
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
445
|
/**
|
|
662
446
|
* Human-readable description of the failure.
|
|
663
447
|
*/
|
|
@@ -705,11 +489,7 @@ export declare namespace ReturnInitiatedWebhookEvent {
|
|
|
705
489
|
*/
|
|
706
490
|
amount: string;
|
|
707
491
|
/**
|
|
708
|
-
*
|
|
709
|
-
*/
|
|
710
|
-
created_at: string;
|
|
711
|
-
/**
|
|
712
|
-
* Currency code (ISO 4217 currency code or crypto currency code).
|
|
492
|
+
* Currency code (ISO 4217 or crypto).
|
|
713
493
|
*/
|
|
714
494
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
715
495
|
/**
|
|
@@ -720,18 +500,31 @@ export declare namespace ReturnInitiatedWebhookEvent {
|
|
|
720
500
|
* Failure details when status is failed, otherwise null.
|
|
721
501
|
*/
|
|
722
502
|
failure: Payload.Failure | null;
|
|
503
|
+
/**
|
|
504
|
+
* ISO 8601 UTC timestamp when the return was initiated.
|
|
505
|
+
*/
|
|
506
|
+
initiated_at: string;
|
|
507
|
+
/**
|
|
508
|
+
* Payment scheme or blockchain used for the return, or null when unknown.
|
|
509
|
+
*/
|
|
510
|
+
rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
|
|
511
|
+
/**
|
|
512
|
+
* ISO 8601 UTC timestamp when the return was sent.
|
|
513
|
+
*/
|
|
514
|
+
sent_at: string | null;
|
|
723
515
|
/**
|
|
724
516
|
* Current status of the return.
|
|
725
517
|
*/
|
|
726
|
-
status: '
|
|
518
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
727
519
|
/**
|
|
728
|
-
*
|
|
520
|
+
* Transaction hash for crypto returns, or null when not known. Only blockchain
|
|
521
|
+
* rails support this field.
|
|
729
522
|
*/
|
|
730
|
-
|
|
523
|
+
tx_hash: string | null;
|
|
731
524
|
/**
|
|
732
|
-
*
|
|
525
|
+
* Resource type discriminator.
|
|
733
526
|
*/
|
|
734
|
-
|
|
527
|
+
type: 'return';
|
|
735
528
|
}
|
|
736
529
|
namespace Payload {
|
|
737
530
|
/**
|
|
@@ -741,7 +534,7 @@ export declare namespace ReturnInitiatedWebhookEvent {
|
|
|
741
534
|
/**
|
|
742
535
|
* Failure code.
|
|
743
536
|
*/
|
|
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';
|
|
537
|
+
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
538
|
/**
|
|
746
539
|
* Human-readable description of the failure.
|
|
747
540
|
*/
|
|
@@ -789,11 +582,7 @@ export declare namespace ReturnPaidWebhookEvent {
|
|
|
789
582
|
*/
|
|
790
583
|
amount: string;
|
|
791
584
|
/**
|
|
792
|
-
*
|
|
793
|
-
*/
|
|
794
|
-
created_at: string;
|
|
795
|
-
/**
|
|
796
|
-
* Currency code (ISO 4217 currency code or crypto currency code).
|
|
585
|
+
* Currency code (ISO 4217 or crypto).
|
|
797
586
|
*/
|
|
798
587
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
799
588
|
/**
|
|
@@ -804,18 +593,31 @@ export declare namespace ReturnPaidWebhookEvent {
|
|
|
804
593
|
* Failure details when status is failed, otherwise null.
|
|
805
594
|
*/
|
|
806
595
|
failure: Payload.Failure | null;
|
|
596
|
+
/**
|
|
597
|
+
* ISO 8601 UTC timestamp when the return was initiated.
|
|
598
|
+
*/
|
|
599
|
+
initiated_at: string;
|
|
600
|
+
/**
|
|
601
|
+
* Payment scheme or blockchain used for the return, or null when unknown.
|
|
602
|
+
*/
|
|
603
|
+
rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
|
|
604
|
+
/**
|
|
605
|
+
* ISO 8601 UTC timestamp when the return was sent.
|
|
606
|
+
*/
|
|
607
|
+
sent_at: string | null;
|
|
807
608
|
/**
|
|
808
609
|
* Current status of the return.
|
|
809
610
|
*/
|
|
810
|
-
status: '
|
|
611
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
811
612
|
/**
|
|
812
|
-
*
|
|
613
|
+
* Transaction hash for crypto returns, or null when not known. Only blockchain
|
|
614
|
+
* rails support this field.
|
|
813
615
|
*/
|
|
814
|
-
|
|
616
|
+
tx_hash: string | null;
|
|
815
617
|
/**
|
|
816
|
-
*
|
|
618
|
+
* Resource type discriminator.
|
|
817
619
|
*/
|
|
818
|
-
|
|
620
|
+
type: 'return';
|
|
819
621
|
}
|
|
820
622
|
namespace Payload {
|
|
821
623
|
/**
|
|
@@ -825,7 +627,7 @@ export declare namespace ReturnPaidWebhookEvent {
|
|
|
825
627
|
/**
|
|
826
628
|
* Failure code.
|
|
827
629
|
*/
|
|
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';
|
|
630
|
+
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
631
|
/**
|
|
830
632
|
* Human-readable description of the failure.
|
|
831
633
|
*/
|
|
@@ -873,11 +675,7 @@ export declare namespace ReturnFailedWebhookEvent {
|
|
|
873
675
|
*/
|
|
874
676
|
amount: string;
|
|
875
677
|
/**
|
|
876
|
-
*
|
|
877
|
-
*/
|
|
878
|
-
created_at: string;
|
|
879
|
-
/**
|
|
880
|
-
* Currency code (ISO 4217 currency code or crypto currency code).
|
|
678
|
+
* Currency code (ISO 4217 or crypto).
|
|
881
679
|
*/
|
|
882
680
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
883
681
|
/**
|
|
@@ -888,18 +686,31 @@ export declare namespace ReturnFailedWebhookEvent {
|
|
|
888
686
|
* Failure details when status is failed, otherwise null.
|
|
889
687
|
*/
|
|
890
688
|
failure: Payload.Failure | null;
|
|
689
|
+
/**
|
|
690
|
+
* ISO 8601 UTC timestamp when the return was initiated.
|
|
691
|
+
*/
|
|
692
|
+
initiated_at: string;
|
|
693
|
+
/**
|
|
694
|
+
* Payment scheme or blockchain used for the return, or null when unknown.
|
|
695
|
+
*/
|
|
696
|
+
rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
|
|
697
|
+
/**
|
|
698
|
+
* ISO 8601 UTC timestamp when the return was sent.
|
|
699
|
+
*/
|
|
700
|
+
sent_at: string | null;
|
|
891
701
|
/**
|
|
892
702
|
* Current status of the return.
|
|
893
703
|
*/
|
|
894
|
-
status: '
|
|
704
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
895
705
|
/**
|
|
896
|
-
*
|
|
706
|
+
* Transaction hash for crypto returns, or null when not known. Only blockchain
|
|
707
|
+
* rails support this field.
|
|
897
708
|
*/
|
|
898
|
-
|
|
709
|
+
tx_hash: string | null;
|
|
899
710
|
/**
|
|
900
|
-
*
|
|
711
|
+
* Resource type discriminator.
|
|
901
712
|
*/
|
|
902
|
-
|
|
713
|
+
type: 'return';
|
|
903
714
|
}
|
|
904
715
|
namespace Payload {
|
|
905
716
|
/**
|
|
@@ -909,7 +720,7 @@ export declare namespace ReturnFailedWebhookEvent {
|
|
|
909
720
|
/**
|
|
910
721
|
* Failure code.
|
|
911
722
|
*/
|
|
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';
|
|
723
|
+
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
724
|
/**
|
|
914
725
|
* Human-readable description of the failure.
|
|
915
726
|
*/
|
|
@@ -957,11 +768,7 @@ export declare namespace ReturnReturnedWebhookEvent {
|
|
|
957
768
|
*/
|
|
958
769
|
amount: string;
|
|
959
770
|
/**
|
|
960
|
-
*
|
|
961
|
-
*/
|
|
962
|
-
created_at: string;
|
|
963
|
-
/**
|
|
964
|
-
* Currency code (ISO 4217 currency code or crypto currency code).
|
|
771
|
+
* Currency code (ISO 4217 or crypto).
|
|
965
772
|
*/
|
|
966
773
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
967
774
|
/**
|
|
@@ -972,18 +779,31 @@ export declare namespace ReturnReturnedWebhookEvent {
|
|
|
972
779
|
* Failure details when status is failed, otherwise null.
|
|
973
780
|
*/
|
|
974
781
|
failure: Payload.Failure | null;
|
|
782
|
+
/**
|
|
783
|
+
* ISO 8601 UTC timestamp when the return was initiated.
|
|
784
|
+
*/
|
|
785
|
+
initiated_at: string;
|
|
786
|
+
/**
|
|
787
|
+
* Payment scheme or blockchain used for the return, or null when unknown.
|
|
788
|
+
*/
|
|
789
|
+
rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
|
|
790
|
+
/**
|
|
791
|
+
* ISO 8601 UTC timestamp when the return was sent.
|
|
792
|
+
*/
|
|
793
|
+
sent_at: string | null;
|
|
975
794
|
/**
|
|
976
795
|
* Current status of the return.
|
|
977
796
|
*/
|
|
978
|
-
status: '
|
|
797
|
+
status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
|
|
979
798
|
/**
|
|
980
|
-
*
|
|
799
|
+
* Transaction hash for crypto returns, or null when not known. Only blockchain
|
|
800
|
+
* rails support this field.
|
|
981
801
|
*/
|
|
982
|
-
|
|
802
|
+
tx_hash: string | null;
|
|
983
803
|
/**
|
|
984
|
-
*
|
|
804
|
+
* Resource type discriminator.
|
|
985
805
|
*/
|
|
986
|
-
|
|
806
|
+
type: 'return';
|
|
987
807
|
}
|
|
988
808
|
namespace Payload {
|
|
989
809
|
/**
|
|
@@ -993,7 +813,7 @@ export declare namespace ReturnReturnedWebhookEvent {
|
|
|
993
813
|
/**
|
|
994
814
|
* Failure code.
|
|
995
815
|
*/
|
|
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';
|
|
816
|
+
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
817
|
/**
|
|
998
818
|
* Human-readable description of the failure.
|
|
999
819
|
*/
|
|
@@ -1037,43 +857,40 @@ export declare namespace DepositReceivedWebhookEvent {
|
|
|
1037
857
|
*/
|
|
1038
858
|
id: string;
|
|
1039
859
|
/**
|
|
1040
|
-
*
|
|
860
|
+
* ID of the account that was credited with the deposit.
|
|
1041
861
|
*/
|
|
1042
|
-
|
|
862
|
+
account_id: string;
|
|
1043
863
|
/**
|
|
1044
|
-
*
|
|
864
|
+
* Amount as a string decimal (e.g. "100.50").
|
|
1045
865
|
*/
|
|
1046
|
-
|
|
866
|
+
amount: string;
|
|
1047
867
|
/**
|
|
1048
|
-
*
|
|
868
|
+
* ID of the counterparty that sent the money, or null when not known.
|
|
1049
869
|
*/
|
|
1050
|
-
|
|
870
|
+
counterparty_id: string | null;
|
|
1051
871
|
/**
|
|
1052
|
-
*
|
|
872
|
+
* Currency code (ISO 4217 or crypto).
|
|
1053
873
|
*/
|
|
1054
874
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
1055
875
|
/**
|
|
1056
|
-
*
|
|
1057
|
-
*/
|
|
1058
|
-
destination_account_id: string;
|
|
1059
|
-
/**
|
|
1060
|
-
* Payment rail or blockchain used for the deposit.
|
|
876
|
+
* Payment scheme or blockchain used for the deposit, or null when unknown.
|
|
1061
877
|
*/
|
|
1062
|
-
rail: '
|
|
878
|
+
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
879
|
/**
|
|
1064
880
|
* Array of deposit return IDs associated with this deposit.
|
|
1065
881
|
*/
|
|
1066
882
|
returns: Array<string>;
|
|
1067
883
|
/**
|
|
1068
|
-
*
|
|
884
|
+
* ISO 8601 UTC timestamp when the deposit was settled.
|
|
1069
885
|
*/
|
|
1070
|
-
|
|
886
|
+
settled_at: string;
|
|
1071
887
|
/**
|
|
1072
888
|
* Current status of the deposit.
|
|
1073
889
|
*/
|
|
1074
|
-
status: '
|
|
890
|
+
status: 'settled';
|
|
1075
891
|
/**
|
|
1076
|
-
* Transaction hash for crypto deposits, or null when not known.
|
|
892
|
+
* Transaction hash for crypto deposits, or null when not known. Only blockchain
|
|
893
|
+
* rails support this field.
|
|
1077
894
|
*/
|
|
1078
895
|
tx_hash: string | null;
|
|
1079
896
|
/**
|
|
@@ -1081,79 +898,10 @@ export declare namespace DepositReceivedWebhookEvent {
|
|
|
1081
898
|
*/
|
|
1082
899
|
type: 'deposit';
|
|
1083
900
|
/**
|
|
1084
|
-
*
|
|
901
|
+
* Unstructured remittance information attached to the transfer. Not all rails
|
|
902
|
+
* support this field.
|
|
1085
903
|
*/
|
|
1086
|
-
|
|
1087
|
-
}
|
|
1088
|
-
namespace Payload {
|
|
1089
|
-
interface UnionMember0 {
|
|
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 UnionMember1 {
|
|
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 UnionMember2 {
|
|
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 UnionMember3 {
|
|
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
|
-
}
|
|
904
|
+
unstructured_remittance_information: string | null;
|
|
1157
905
|
}
|
|
1158
906
|
}
|
|
1159
907
|
export interface ConversionCreatedWebhookEvent {
|
|
@@ -1195,32 +943,20 @@ export declare namespace ConversionCreatedWebhookEvent {
|
|
|
1195
943
|
* ISO 8601 UTC timestamp when the conversion was created.
|
|
1196
944
|
*/
|
|
1197
945
|
created_at: string;
|
|
1198
|
-
/**
|
|
1199
|
-
* Failure details when status is failed, otherwise null.
|
|
1200
|
-
*/
|
|
1201
|
-
failure: Payload.Failure | null;
|
|
1202
946
|
/**
|
|
1203
947
|
* Key-value pairs stored with the conversion.
|
|
1204
948
|
*/
|
|
1205
949
|
metadata: {
|
|
1206
950
|
[key: string]: string;
|
|
1207
951
|
};
|
|
1208
|
-
/**
|
|
1209
|
-
* ID of the associated quote, or null.
|
|
1210
|
-
*/
|
|
1211
|
-
quote_id: string | null;
|
|
1212
952
|
/**
|
|
1213
953
|
* ID of the source account, or null.
|
|
1214
954
|
*/
|
|
1215
955
|
source_account_id: string | null;
|
|
1216
956
|
/**
|
|
1217
|
-
*
|
|
957
|
+
* Amount as a string decimal (e.g. "100.50").
|
|
1218
958
|
*/
|
|
1219
959
|
source_amount: string;
|
|
1220
|
-
/**
|
|
1221
|
-
* Source currency code.
|
|
1222
|
-
*/
|
|
1223
|
-
source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
1224
960
|
/**
|
|
1225
961
|
* Current status of the conversion.
|
|
1226
962
|
*/
|
|
@@ -1230,9 +966,9 @@ export declare namespace ConversionCreatedWebhookEvent {
|
|
|
1230
966
|
*/
|
|
1231
967
|
target_account_id: string | null;
|
|
1232
968
|
/**
|
|
1233
|
-
*
|
|
969
|
+
* Amount as a string decimal (e.g. "100.50").
|
|
1234
970
|
*/
|
|
1235
|
-
|
|
971
|
+
target_amount: string;
|
|
1236
972
|
/**
|
|
1237
973
|
* Resource type discriminator.
|
|
1238
974
|
*/
|
|
@@ -1242,17 +978,6 @@ export declare namespace ConversionCreatedWebhookEvent {
|
|
|
1242
978
|
*/
|
|
1243
979
|
updated_at: string;
|
|
1244
980
|
}
|
|
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
981
|
}
|
|
1257
982
|
export interface ConversionCompletedWebhookEvent {
|
|
1258
983
|
/**
|
|
@@ -1293,32 +1018,20 @@ export declare namespace ConversionCompletedWebhookEvent {
|
|
|
1293
1018
|
* ISO 8601 UTC timestamp when the conversion was created.
|
|
1294
1019
|
*/
|
|
1295
1020
|
created_at: string;
|
|
1296
|
-
/**
|
|
1297
|
-
* Failure details when status is failed, otherwise null.
|
|
1298
|
-
*/
|
|
1299
|
-
failure: Payload.Failure | null;
|
|
1300
1021
|
/**
|
|
1301
1022
|
* Key-value pairs stored with the conversion.
|
|
1302
1023
|
*/
|
|
1303
1024
|
metadata: {
|
|
1304
1025
|
[key: string]: string;
|
|
1305
1026
|
};
|
|
1306
|
-
/**
|
|
1307
|
-
* ID of the associated quote, or null.
|
|
1308
|
-
*/
|
|
1309
|
-
quote_id: string | null;
|
|
1310
1027
|
/**
|
|
1311
1028
|
* ID of the source account, or null.
|
|
1312
1029
|
*/
|
|
1313
1030
|
source_account_id: string | null;
|
|
1314
1031
|
/**
|
|
1315
|
-
*
|
|
1032
|
+
* Amount as a string decimal (e.g. "100.50").
|
|
1316
1033
|
*/
|
|
1317
1034
|
source_amount: string;
|
|
1318
|
-
/**
|
|
1319
|
-
* Source currency code.
|
|
1320
|
-
*/
|
|
1321
|
-
source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
1322
1035
|
/**
|
|
1323
1036
|
* Current status of the conversion.
|
|
1324
1037
|
*/
|
|
@@ -1328,9 +1041,9 @@ export declare namespace ConversionCompletedWebhookEvent {
|
|
|
1328
1041
|
*/
|
|
1329
1042
|
target_account_id: string | null;
|
|
1330
1043
|
/**
|
|
1331
|
-
*
|
|
1044
|
+
* Amount as a string decimal (e.g. "100.50").
|
|
1332
1045
|
*/
|
|
1333
|
-
|
|
1046
|
+
target_amount: string;
|
|
1334
1047
|
/**
|
|
1335
1048
|
* Resource type discriminator.
|
|
1336
1049
|
*/
|
|
@@ -1340,17 +1053,6 @@ export declare namespace ConversionCompletedWebhookEvent {
|
|
|
1340
1053
|
*/
|
|
1341
1054
|
updated_at: string;
|
|
1342
1055
|
}
|
|
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
1056
|
}
|
|
1355
1057
|
export interface ConversionFailedWebhookEvent {
|
|
1356
1058
|
/**
|
|
@@ -1391,32 +1093,20 @@ export declare namespace ConversionFailedWebhookEvent {
|
|
|
1391
1093
|
* ISO 8601 UTC timestamp when the conversion was created.
|
|
1392
1094
|
*/
|
|
1393
1095
|
created_at: string;
|
|
1394
|
-
/**
|
|
1395
|
-
* Failure details when status is failed, otherwise null.
|
|
1396
|
-
*/
|
|
1397
|
-
failure: Payload.Failure | null;
|
|
1398
1096
|
/**
|
|
1399
1097
|
* Key-value pairs stored with the conversion.
|
|
1400
1098
|
*/
|
|
1401
1099
|
metadata: {
|
|
1402
1100
|
[key: string]: string;
|
|
1403
1101
|
};
|
|
1404
|
-
/**
|
|
1405
|
-
* ID of the associated quote, or null.
|
|
1406
|
-
*/
|
|
1407
|
-
quote_id: string | null;
|
|
1408
1102
|
/**
|
|
1409
1103
|
* ID of the source account, or null.
|
|
1410
1104
|
*/
|
|
1411
1105
|
source_account_id: string | null;
|
|
1412
1106
|
/**
|
|
1413
|
-
*
|
|
1107
|
+
* Amount as a string decimal (e.g. "100.50").
|
|
1414
1108
|
*/
|
|
1415
1109
|
source_amount: string;
|
|
1416
|
-
/**
|
|
1417
|
-
* Source currency code.
|
|
1418
|
-
*/
|
|
1419
|
-
source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
1420
1110
|
/**
|
|
1421
1111
|
* Current status of the conversion.
|
|
1422
1112
|
*/
|
|
@@ -1426,9 +1116,9 @@ export declare namespace ConversionFailedWebhookEvent {
|
|
|
1426
1116
|
*/
|
|
1427
1117
|
target_account_id: string | null;
|
|
1428
1118
|
/**
|
|
1429
|
-
*
|
|
1119
|
+
* Amount as a string decimal (e.g. "100.50").
|
|
1430
1120
|
*/
|
|
1431
|
-
|
|
1121
|
+
target_amount: string;
|
|
1432
1122
|
/**
|
|
1433
1123
|
* Resource type discriminator.
|
|
1434
1124
|
*/
|
|
@@ -1438,17 +1128,6 @@ export declare namespace ConversionFailedWebhookEvent {
|
|
|
1438
1128
|
*/
|
|
1439
1129
|
updated_at: string;
|
|
1440
1130
|
}
|
|
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
1131
|
}
|
|
1453
1132
|
export interface AccountHolderActiveWebhookEvent {
|
|
1454
1133
|
/**
|
|
@@ -1482,9 +1161,12 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1482
1161
|
*/
|
|
1483
1162
|
id: string;
|
|
1484
1163
|
/**
|
|
1485
|
-
* Beneficiary details used to create this account holder.
|
|
1164
|
+
* Beneficiary details used to create this account holder. Which shape is returned
|
|
1165
|
+
* follows `country_of_citizenship`: **US individual** when it is `US`, **Non-US
|
|
1166
|
+
* individual** for any other country, **Business** when `holder_type` is
|
|
1167
|
+
* `business`.
|
|
1486
1168
|
*/
|
|
1487
|
-
beneficiary_data: Payload.
|
|
1169
|
+
beneficiary_data: Payload.V1UsBeneficiaryDataResponse | Payload.V1NonUsBeneficiaryDataResponse | Payload.V1BusinessBeneficiaryDataResponse;
|
|
1488
1170
|
/**
|
|
1489
1171
|
* ISO 8601 UTC timestamp when the account holder was created.
|
|
1490
1172
|
*/
|
|
@@ -1503,7 +1185,7 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1503
1185
|
type: 'account_holder';
|
|
1504
1186
|
}
|
|
1505
1187
|
namespace Payload {
|
|
1506
|
-
interface
|
|
1188
|
+
interface V1UsBeneficiaryDataResponse {
|
|
1507
1189
|
/**
|
|
1508
1190
|
* ISO 3166-1 alpha-2 country code of citizenship.
|
|
1509
1191
|
*/
|
|
@@ -1516,75 +1198,81 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1516
1198
|
* Government-issued identification with type: "ssn" (Social Security Number,
|
|
1517
1199
|
* format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
|
|
1518
1200
|
*/
|
|
1519
|
-
identification:
|
|
1201
|
+
identification: V1UsBeneficiaryDataResponse.V1SsnIdentification | V1UsBeneficiaryDataResponse.V1ItinIdentification;
|
|
1520
1202
|
/**
|
|
1521
1203
|
* Full legal name of the account holder.
|
|
1522
1204
|
*/
|
|
1523
1205
|
legal_name: string;
|
|
1524
1206
|
/**
|
|
1525
|
-
* Residential address of the account holder.
|
|
1207
|
+
* Residential address of the account holder. **US address** requires
|
|
1208
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1209
|
+
* other country and allows `state` to be null.
|
|
1526
1210
|
*/
|
|
1527
|
-
residential_address:
|
|
1211
|
+
residential_address: V1UsBeneficiaryDataResponse.V1UsResidentialAddress | V1UsBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
1528
1212
|
}
|
|
1529
|
-
namespace
|
|
1530
|
-
interface
|
|
1213
|
+
namespace V1UsBeneficiaryDataResponse {
|
|
1214
|
+
interface V1SsnIdentification {
|
|
1531
1215
|
type: 'ssn';
|
|
1532
1216
|
value: string;
|
|
1533
1217
|
}
|
|
1534
|
-
interface
|
|
1218
|
+
interface V1ItinIdentification {
|
|
1535
1219
|
type: 'itin';
|
|
1536
1220
|
value: string;
|
|
1537
1221
|
}
|
|
1538
|
-
interface
|
|
1222
|
+
interface V1UsResidentialAddress {
|
|
1539
1223
|
/**
|
|
1540
|
-
* City
|
|
1224
|
+
* City or locality.
|
|
1541
1225
|
*/
|
|
1542
1226
|
city: string;
|
|
1543
1227
|
/**
|
|
1544
1228
|
* ISO 3166-1 alpha-2 country code.
|
|
1545
1229
|
*/
|
|
1546
|
-
|
|
1230
|
+
country_code: 'US';
|
|
1547
1231
|
/**
|
|
1548
|
-
*
|
|
1232
|
+
* Primary street address.
|
|
1549
1233
|
*/
|
|
1550
|
-
|
|
1234
|
+
line_1: string;
|
|
1551
1235
|
/**
|
|
1552
|
-
*
|
|
1236
|
+
* Secondary street address, or null if not recorded.
|
|
1553
1237
|
*/
|
|
1554
|
-
|
|
1238
|
+
line_2: string | null;
|
|
1555
1239
|
/**
|
|
1556
|
-
*
|
|
1240
|
+
* Postal or ZIP code.
|
|
1557
1241
|
*/
|
|
1558
|
-
|
|
1242
|
+
postal_code: string;
|
|
1559
1243
|
/**
|
|
1560
|
-
*
|
|
1244
|
+
* State, province, or region.
|
|
1561
1245
|
*/
|
|
1562
|
-
|
|
1246
|
+
state: string;
|
|
1563
1247
|
}
|
|
1564
|
-
interface
|
|
1248
|
+
interface V1NonUsResidentialAddress {
|
|
1565
1249
|
/**
|
|
1566
|
-
* City
|
|
1250
|
+
* City or locality.
|
|
1567
1251
|
*/
|
|
1568
1252
|
city: string;
|
|
1569
1253
|
/**
|
|
1570
1254
|
* ISO 3166-1 alpha-2 country code.
|
|
1571
1255
|
*/
|
|
1572
|
-
|
|
1256
|
+
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
1257
|
/**
|
|
1574
|
-
*
|
|
1258
|
+
* Primary street address.
|
|
1575
1259
|
*/
|
|
1576
|
-
|
|
1260
|
+
line_1: string;
|
|
1577
1261
|
/**
|
|
1578
|
-
*
|
|
1262
|
+
* Secondary street address, or null if not recorded.
|
|
1579
1263
|
*/
|
|
1580
|
-
|
|
1264
|
+
line_2: string | null;
|
|
1265
|
+
/**
|
|
1266
|
+
* Postal or ZIP code.
|
|
1267
|
+
*/
|
|
1268
|
+
postal_code: string;
|
|
1581
1269
|
/**
|
|
1582
|
-
*
|
|
1270
|
+
* State, province, or region, or null if not recorded.
|
|
1583
1271
|
*/
|
|
1584
|
-
|
|
1272
|
+
state: string | null;
|
|
1585
1273
|
}
|
|
1586
1274
|
}
|
|
1587
|
-
interface
|
|
1275
|
+
interface V1NonUsBeneficiaryDataResponse {
|
|
1588
1276
|
/**
|
|
1589
1277
|
* ISO 3166-1 alpha-2 country code of citizenship.
|
|
1590
1278
|
*/
|
|
@@ -1596,17 +1284,19 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1596
1284
|
/**
|
|
1597
1285
|
* Government-issued identification with type: "id" (generic government-issued ID).
|
|
1598
1286
|
*/
|
|
1599
|
-
identification:
|
|
1287
|
+
identification: V1NonUsBeneficiaryDataResponse.Identification;
|
|
1600
1288
|
/**
|
|
1601
1289
|
* Full legal name of the account holder.
|
|
1602
1290
|
*/
|
|
1603
1291
|
legal_name: string;
|
|
1604
1292
|
/**
|
|
1605
|
-
* Residential address of the account holder.
|
|
1293
|
+
* Residential address of the account holder. **US address** requires
|
|
1294
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1295
|
+
* other country and allows `state` to be null.
|
|
1606
1296
|
*/
|
|
1607
|
-
residential_address:
|
|
1297
|
+
residential_address: V1NonUsBeneficiaryDataResponse.V1UsResidentialAddress | V1NonUsBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
1608
1298
|
}
|
|
1609
|
-
namespace
|
|
1299
|
+
namespace V1NonUsBeneficiaryDataResponse {
|
|
1610
1300
|
/**
|
|
1611
1301
|
* Government-issued identification with type: "id" (generic government-issued ID).
|
|
1612
1302
|
*/
|
|
@@ -1614,65 +1304,70 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1614
1304
|
type: 'id';
|
|
1615
1305
|
value: string;
|
|
1616
1306
|
}
|
|
1617
|
-
interface
|
|
1307
|
+
interface V1UsResidentialAddress {
|
|
1618
1308
|
/**
|
|
1619
|
-
* City
|
|
1309
|
+
* City or locality.
|
|
1620
1310
|
*/
|
|
1621
1311
|
city: string;
|
|
1622
1312
|
/**
|
|
1623
1313
|
* ISO 3166-1 alpha-2 country code.
|
|
1624
1314
|
*/
|
|
1625
|
-
|
|
1315
|
+
country_code: 'US';
|
|
1626
1316
|
/**
|
|
1627
|
-
*
|
|
1317
|
+
* Primary street address.
|
|
1628
1318
|
*/
|
|
1629
|
-
|
|
1319
|
+
line_1: string;
|
|
1630
1320
|
/**
|
|
1631
|
-
*
|
|
1321
|
+
* Secondary street address, or null if not recorded.
|
|
1632
1322
|
*/
|
|
1633
|
-
|
|
1323
|
+
line_2: string | null;
|
|
1634
1324
|
/**
|
|
1635
|
-
*
|
|
1325
|
+
* Postal or ZIP code.
|
|
1636
1326
|
*/
|
|
1637
|
-
|
|
1327
|
+
postal_code: string;
|
|
1638
1328
|
/**
|
|
1639
|
-
*
|
|
1329
|
+
* State, province, or region.
|
|
1640
1330
|
*/
|
|
1641
|
-
|
|
1331
|
+
state: string;
|
|
1642
1332
|
}
|
|
1643
|
-
interface
|
|
1333
|
+
interface V1NonUsResidentialAddress {
|
|
1644
1334
|
/**
|
|
1645
|
-
* City
|
|
1335
|
+
* City or locality.
|
|
1646
1336
|
*/
|
|
1647
1337
|
city: string;
|
|
1648
1338
|
/**
|
|
1649
1339
|
* ISO 3166-1 alpha-2 country code.
|
|
1650
1340
|
*/
|
|
1651
|
-
|
|
1341
|
+
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
1342
|
/**
|
|
1653
|
-
*
|
|
1343
|
+
* Primary street address.
|
|
1654
1344
|
*/
|
|
1655
|
-
|
|
1345
|
+
line_1: string;
|
|
1656
1346
|
/**
|
|
1657
|
-
*
|
|
1347
|
+
* Secondary street address, or null if not recorded.
|
|
1658
1348
|
*/
|
|
1659
|
-
|
|
1349
|
+
line_2: string | null;
|
|
1350
|
+
/**
|
|
1351
|
+
* Postal or ZIP code.
|
|
1352
|
+
*/
|
|
1353
|
+
postal_code: string;
|
|
1660
1354
|
/**
|
|
1661
|
-
*
|
|
1355
|
+
* State, province, or region, or null if not recorded.
|
|
1662
1356
|
*/
|
|
1663
|
-
|
|
1357
|
+
state: string | null;
|
|
1664
1358
|
}
|
|
1665
1359
|
}
|
|
1666
|
-
interface
|
|
1360
|
+
interface V1BusinessBeneficiaryDataResponse {
|
|
1667
1361
|
/**
|
|
1668
1362
|
* Beneficial owners of the business. At least one required.
|
|
1669
1363
|
*/
|
|
1670
|
-
beneficial_owners: Array<
|
|
1364
|
+
beneficial_owners: Array<V1BusinessBeneficiaryDataResponse.V1UsBeneficiaryDataResponse | V1BusinessBeneficiaryDataResponse.V1NonUsBeneficiaryDataResponse>;
|
|
1671
1365
|
/**
|
|
1672
1366
|
* Individual with primary responsibility for controlling, managing, or directing
|
|
1673
|
-
* the business.
|
|
1367
|
+
* the business. Follows the same US / non-US split as `beneficiary_data`, based on
|
|
1368
|
+
* the control person's own `country_of_citizenship`.
|
|
1674
1369
|
*/
|
|
1675
|
-
control_person:
|
|
1370
|
+
control_person: V1BusinessBeneficiaryDataResponse.UnionMember0 | V1BusinessBeneficiaryDataResponse.UnionMember1;
|
|
1676
1371
|
/**
|
|
1677
1372
|
* ISO 3166-1 alpha-2 country code where the business is incorporated.
|
|
1678
1373
|
*/
|
|
@@ -1686,18 +1381,22 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1686
1381
|
*/
|
|
1687
1382
|
legal_business_name: string;
|
|
1688
1383
|
/**
|
|
1689
|
-
* Physical operating address of the business.
|
|
1384
|
+
* Physical operating address of the business. **US address** requires
|
|
1385
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1386
|
+
* other country and allows `state` to be null.
|
|
1690
1387
|
*/
|
|
1691
|
-
physical_address:
|
|
1388
|
+
physical_address: V1BusinessBeneficiaryDataResponse.V1UsResidentialAddress | V1BusinessBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
1692
1389
|
/**
|
|
1693
|
-
* Registered legal address of the business.
|
|
1390
|
+
* Registered legal address of the business. **US address** requires
|
|
1391
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1392
|
+
* other country and allows `state` to be null.
|
|
1694
1393
|
*/
|
|
1695
|
-
registered_address:
|
|
1394
|
+
registered_address: V1BusinessBeneficiaryDataResponse.V1UsResidentialAddress | V1BusinessBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
1696
1395
|
/**
|
|
1697
1396
|
* Business registration number: type "ein" (Employer Identification Number, format
|
|
1698
1397
|
* ##-#######) or "ssn" (Social Security Number, format ###-##-####).
|
|
1699
1398
|
*/
|
|
1700
|
-
registration_number:
|
|
1399
|
+
registration_number: V1BusinessBeneficiaryDataResponse.V1EinIdentification | V1BusinessBeneficiaryDataResponse.V1SsnIdentification;
|
|
1701
1400
|
/**
|
|
1702
1401
|
* State or subdivision where the business is incorporated.
|
|
1703
1402
|
*/
|
|
@@ -1707,8 +1406,8 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1707
1406
|
*/
|
|
1708
1407
|
year_of_incorporation: number;
|
|
1709
1408
|
}
|
|
1710
|
-
namespace
|
|
1711
|
-
interface
|
|
1409
|
+
namespace V1BusinessBeneficiaryDataResponse {
|
|
1410
|
+
interface V1UsBeneficiaryDataResponse {
|
|
1712
1411
|
/**
|
|
1713
1412
|
* ISO 3166-1 alpha-2 country code of citizenship.
|
|
1714
1413
|
*/
|
|
@@ -1721,75 +1420,81 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1721
1420
|
* Government-issued identification with type: "ssn" (Social Security Number,
|
|
1722
1421
|
* format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
|
|
1723
1422
|
*/
|
|
1724
|
-
identification:
|
|
1423
|
+
identification: V1UsBeneficiaryDataResponse.V1SsnIdentification | V1UsBeneficiaryDataResponse.V1ItinIdentification;
|
|
1725
1424
|
/**
|
|
1726
1425
|
* Full legal name of the account holder.
|
|
1727
1426
|
*/
|
|
1728
1427
|
legal_name: string;
|
|
1729
1428
|
/**
|
|
1730
|
-
* Residential address of the account holder.
|
|
1429
|
+
* Residential address of the account holder. **US address** requires
|
|
1430
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1431
|
+
* other country and allows `state` to be null.
|
|
1731
1432
|
*/
|
|
1732
|
-
residential_address:
|
|
1433
|
+
residential_address: V1UsBeneficiaryDataResponse.V1UsResidentialAddress | V1UsBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
1733
1434
|
}
|
|
1734
|
-
namespace
|
|
1735
|
-
interface
|
|
1435
|
+
namespace V1UsBeneficiaryDataResponse {
|
|
1436
|
+
interface V1SsnIdentification {
|
|
1736
1437
|
type: 'ssn';
|
|
1737
1438
|
value: string;
|
|
1738
1439
|
}
|
|
1739
|
-
interface
|
|
1440
|
+
interface V1ItinIdentification {
|
|
1740
1441
|
type: 'itin';
|
|
1741
1442
|
value: string;
|
|
1742
1443
|
}
|
|
1743
|
-
interface
|
|
1444
|
+
interface V1UsResidentialAddress {
|
|
1744
1445
|
/**
|
|
1745
|
-
* City
|
|
1446
|
+
* City or locality.
|
|
1746
1447
|
*/
|
|
1747
1448
|
city: string;
|
|
1748
1449
|
/**
|
|
1749
1450
|
* ISO 3166-1 alpha-2 country code.
|
|
1750
1451
|
*/
|
|
1751
|
-
|
|
1452
|
+
country_code: 'US';
|
|
1752
1453
|
/**
|
|
1753
|
-
*
|
|
1454
|
+
* Primary street address.
|
|
1754
1455
|
*/
|
|
1755
|
-
|
|
1456
|
+
line_1: string;
|
|
1756
1457
|
/**
|
|
1757
|
-
*
|
|
1458
|
+
* Secondary street address, or null if not recorded.
|
|
1758
1459
|
*/
|
|
1759
|
-
|
|
1460
|
+
line_2: string | null;
|
|
1760
1461
|
/**
|
|
1761
|
-
*
|
|
1462
|
+
* Postal or ZIP code.
|
|
1762
1463
|
*/
|
|
1763
|
-
|
|
1464
|
+
postal_code: string;
|
|
1764
1465
|
/**
|
|
1765
|
-
*
|
|
1466
|
+
* State, province, or region.
|
|
1766
1467
|
*/
|
|
1767
|
-
|
|
1468
|
+
state: string;
|
|
1768
1469
|
}
|
|
1769
|
-
interface
|
|
1470
|
+
interface V1NonUsResidentialAddress {
|
|
1770
1471
|
/**
|
|
1771
|
-
* City
|
|
1472
|
+
* City or locality.
|
|
1772
1473
|
*/
|
|
1773
1474
|
city: string;
|
|
1774
1475
|
/**
|
|
1775
1476
|
* ISO 3166-1 alpha-2 country code.
|
|
1776
1477
|
*/
|
|
1777
|
-
|
|
1478
|
+
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
1479
|
/**
|
|
1779
|
-
*
|
|
1480
|
+
* Primary street address.
|
|
1780
1481
|
*/
|
|
1781
|
-
|
|
1482
|
+
line_1: string;
|
|
1782
1483
|
/**
|
|
1783
|
-
*
|
|
1484
|
+
* Secondary street address, or null if not recorded.
|
|
1784
1485
|
*/
|
|
1785
|
-
|
|
1486
|
+
line_2: string | null;
|
|
1487
|
+
/**
|
|
1488
|
+
* Postal or ZIP code.
|
|
1489
|
+
*/
|
|
1490
|
+
postal_code: string;
|
|
1786
1491
|
/**
|
|
1787
|
-
*
|
|
1492
|
+
* State, province, or region, or null if not recorded.
|
|
1788
1493
|
*/
|
|
1789
|
-
|
|
1494
|
+
state: string | null;
|
|
1790
1495
|
}
|
|
1791
1496
|
}
|
|
1792
|
-
interface
|
|
1497
|
+
interface V1NonUsBeneficiaryDataResponse {
|
|
1793
1498
|
/**
|
|
1794
1499
|
* ISO 3166-1 alpha-2 country code of citizenship.
|
|
1795
1500
|
*/
|
|
@@ -1801,17 +1506,19 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1801
1506
|
/**
|
|
1802
1507
|
* Government-issued identification with type: "id" (generic government-issued ID).
|
|
1803
1508
|
*/
|
|
1804
|
-
identification:
|
|
1509
|
+
identification: V1NonUsBeneficiaryDataResponse.Identification;
|
|
1805
1510
|
/**
|
|
1806
1511
|
* Full legal name of the account holder.
|
|
1807
1512
|
*/
|
|
1808
1513
|
legal_name: string;
|
|
1809
1514
|
/**
|
|
1810
|
-
* Residential address of the account holder.
|
|
1515
|
+
* Residential address of the account holder. **US address** requires
|
|
1516
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1517
|
+
* other country and allows `state` to be null.
|
|
1811
1518
|
*/
|
|
1812
|
-
residential_address:
|
|
1519
|
+
residential_address: V1NonUsBeneficiaryDataResponse.V1UsResidentialAddress | V1NonUsBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
1813
1520
|
}
|
|
1814
|
-
namespace
|
|
1521
|
+
namespace V1NonUsBeneficiaryDataResponse {
|
|
1815
1522
|
/**
|
|
1816
1523
|
* Government-issued identification with type: "id" (generic government-issued ID).
|
|
1817
1524
|
*/
|
|
@@ -1819,53 +1526,57 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1819
1526
|
type: 'id';
|
|
1820
1527
|
value: string;
|
|
1821
1528
|
}
|
|
1822
|
-
interface
|
|
1529
|
+
interface V1UsResidentialAddress {
|
|
1823
1530
|
/**
|
|
1824
|
-
* City
|
|
1531
|
+
* City or locality.
|
|
1825
1532
|
*/
|
|
1826
1533
|
city: string;
|
|
1827
1534
|
/**
|
|
1828
1535
|
* ISO 3166-1 alpha-2 country code.
|
|
1829
1536
|
*/
|
|
1830
|
-
|
|
1537
|
+
country_code: 'US';
|
|
1831
1538
|
/**
|
|
1832
|
-
*
|
|
1539
|
+
* Primary street address.
|
|
1833
1540
|
*/
|
|
1834
|
-
|
|
1541
|
+
line_1: string;
|
|
1835
1542
|
/**
|
|
1836
|
-
*
|
|
1543
|
+
* Secondary street address, or null if not recorded.
|
|
1837
1544
|
*/
|
|
1838
|
-
|
|
1545
|
+
line_2: string | null;
|
|
1839
1546
|
/**
|
|
1840
|
-
*
|
|
1547
|
+
* Postal or ZIP code.
|
|
1841
1548
|
*/
|
|
1842
|
-
|
|
1549
|
+
postal_code: string;
|
|
1843
1550
|
/**
|
|
1844
|
-
*
|
|
1551
|
+
* State, province, or region.
|
|
1845
1552
|
*/
|
|
1846
|
-
|
|
1553
|
+
state: string;
|
|
1847
1554
|
}
|
|
1848
|
-
interface
|
|
1555
|
+
interface V1NonUsResidentialAddress {
|
|
1849
1556
|
/**
|
|
1850
|
-
* City
|
|
1557
|
+
* City or locality.
|
|
1851
1558
|
*/
|
|
1852
1559
|
city: string;
|
|
1853
1560
|
/**
|
|
1854
1561
|
* ISO 3166-1 alpha-2 country code.
|
|
1855
1562
|
*/
|
|
1856
|
-
|
|
1563
|
+
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
1564
|
/**
|
|
1858
|
-
*
|
|
1565
|
+
* Primary street address.
|
|
1859
1566
|
*/
|
|
1860
|
-
|
|
1567
|
+
line_1: string;
|
|
1861
1568
|
/**
|
|
1862
|
-
*
|
|
1569
|
+
* Secondary street address, or null if not recorded.
|
|
1863
1570
|
*/
|
|
1864
|
-
|
|
1571
|
+
line_2: string | null;
|
|
1572
|
+
/**
|
|
1573
|
+
* Postal or ZIP code.
|
|
1574
|
+
*/
|
|
1575
|
+
postal_code: string;
|
|
1865
1576
|
/**
|
|
1866
|
-
*
|
|
1577
|
+
* State, province, or region, or null if not recorded.
|
|
1867
1578
|
*/
|
|
1868
|
-
|
|
1579
|
+
state: string | null;
|
|
1869
1580
|
}
|
|
1870
1581
|
}
|
|
1871
1582
|
interface UnionMember0 {
|
|
@@ -1881,15 +1592,17 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1881
1592
|
* Government-issued identification with type: "ssn" (Social Security Number,
|
|
1882
1593
|
* format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
|
|
1883
1594
|
*/
|
|
1884
|
-
identification: UnionMember0.
|
|
1595
|
+
identification: UnionMember0.V1SsnIdentification | UnionMember0.V1ItinIdentification;
|
|
1885
1596
|
/**
|
|
1886
1597
|
* Full legal name of the account holder.
|
|
1887
1598
|
*/
|
|
1888
1599
|
legal_name: string;
|
|
1889
1600
|
/**
|
|
1890
|
-
* Residential address of the account holder.
|
|
1601
|
+
* Residential address of the account holder. **US address** requires
|
|
1602
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1603
|
+
* other country and allows `state` to be null.
|
|
1891
1604
|
*/
|
|
1892
|
-
residential_address: UnionMember0.
|
|
1605
|
+
residential_address: UnionMember0.V1UsResidentialAddress | UnionMember0.V1NonUsResidentialAddress;
|
|
1893
1606
|
/**
|
|
1894
1607
|
* Role of the control person at the business (e.g., "CEO", "President", "Managing
|
|
1895
1608
|
* Director").
|
|
@@ -1897,61 +1610,65 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1897
1610
|
title: string;
|
|
1898
1611
|
}
|
|
1899
1612
|
namespace UnionMember0 {
|
|
1900
|
-
interface
|
|
1613
|
+
interface V1SsnIdentification {
|
|
1901
1614
|
type: 'ssn';
|
|
1902
1615
|
value: string;
|
|
1903
1616
|
}
|
|
1904
|
-
interface
|
|
1617
|
+
interface V1ItinIdentification {
|
|
1905
1618
|
type: 'itin';
|
|
1906
1619
|
value: string;
|
|
1907
1620
|
}
|
|
1908
|
-
interface
|
|
1621
|
+
interface V1UsResidentialAddress {
|
|
1909
1622
|
/**
|
|
1910
|
-
* City
|
|
1623
|
+
* City or locality.
|
|
1911
1624
|
*/
|
|
1912
1625
|
city: string;
|
|
1913
1626
|
/**
|
|
1914
1627
|
* ISO 3166-1 alpha-2 country code.
|
|
1915
1628
|
*/
|
|
1916
|
-
|
|
1629
|
+
country_code: 'US';
|
|
1917
1630
|
/**
|
|
1918
|
-
*
|
|
1631
|
+
* Primary street address.
|
|
1919
1632
|
*/
|
|
1920
|
-
|
|
1633
|
+
line_1: string;
|
|
1921
1634
|
/**
|
|
1922
|
-
*
|
|
1635
|
+
* Secondary street address, or null if not recorded.
|
|
1923
1636
|
*/
|
|
1924
|
-
|
|
1637
|
+
line_2: string | null;
|
|
1925
1638
|
/**
|
|
1926
|
-
*
|
|
1639
|
+
* Postal or ZIP code.
|
|
1927
1640
|
*/
|
|
1928
|
-
|
|
1641
|
+
postal_code: string;
|
|
1929
1642
|
/**
|
|
1930
|
-
*
|
|
1643
|
+
* State, province, or region.
|
|
1931
1644
|
*/
|
|
1932
|
-
|
|
1645
|
+
state: string;
|
|
1933
1646
|
}
|
|
1934
|
-
interface
|
|
1647
|
+
interface V1NonUsResidentialAddress {
|
|
1935
1648
|
/**
|
|
1936
|
-
* City
|
|
1649
|
+
* City or locality.
|
|
1937
1650
|
*/
|
|
1938
1651
|
city: string;
|
|
1939
1652
|
/**
|
|
1940
1653
|
* ISO 3166-1 alpha-2 country code.
|
|
1941
1654
|
*/
|
|
1942
|
-
|
|
1655
|
+
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
1656
|
/**
|
|
1944
|
-
*
|
|
1657
|
+
* Primary street address.
|
|
1945
1658
|
*/
|
|
1946
|
-
|
|
1659
|
+
line_1: string;
|
|
1947
1660
|
/**
|
|
1948
|
-
*
|
|
1661
|
+
* Secondary street address, or null if not recorded.
|
|
1949
1662
|
*/
|
|
1950
|
-
|
|
1663
|
+
line_2: string | null;
|
|
1664
|
+
/**
|
|
1665
|
+
* Postal or ZIP code.
|
|
1666
|
+
*/
|
|
1667
|
+
postal_code: string;
|
|
1951
1668
|
/**
|
|
1952
|
-
*
|
|
1669
|
+
* State, province, or region, or null if not recorded.
|
|
1953
1670
|
*/
|
|
1954
|
-
|
|
1671
|
+
state: string | null;
|
|
1955
1672
|
}
|
|
1956
1673
|
}
|
|
1957
1674
|
interface UnionMember1 {
|
|
@@ -1972,9 +1689,11 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1972
1689
|
*/
|
|
1973
1690
|
legal_name: string;
|
|
1974
1691
|
/**
|
|
1975
|
-
* Residential address of the account holder.
|
|
1692
|
+
* Residential address of the account holder. **US address** requires
|
|
1693
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1694
|
+
* other country and allows `state` to be null.
|
|
1976
1695
|
*/
|
|
1977
|
-
residential_address: UnionMember1.
|
|
1696
|
+
residential_address: UnionMember1.V1UsResidentialAddress | UnionMember1.V1NonUsResidentialAddress;
|
|
1978
1697
|
/**
|
|
1979
1698
|
* Role of the control person at the business (e.g., "CEO", "President", "Managing
|
|
1980
1699
|
* Director").
|
|
@@ -1989,156 +1708,168 @@ export declare namespace AccountHolderActiveWebhookEvent {
|
|
|
1989
1708
|
type: 'id';
|
|
1990
1709
|
value: string;
|
|
1991
1710
|
}
|
|
1992
|
-
interface
|
|
1711
|
+
interface V1UsResidentialAddress {
|
|
1993
1712
|
/**
|
|
1994
|
-
* City
|
|
1713
|
+
* City or locality.
|
|
1995
1714
|
*/
|
|
1996
1715
|
city: string;
|
|
1997
1716
|
/**
|
|
1998
1717
|
* ISO 3166-1 alpha-2 country code.
|
|
1999
1718
|
*/
|
|
2000
|
-
|
|
1719
|
+
country_code: 'US';
|
|
2001
1720
|
/**
|
|
2002
|
-
*
|
|
1721
|
+
* Primary street address.
|
|
2003
1722
|
*/
|
|
2004
|
-
|
|
1723
|
+
line_1: string;
|
|
2005
1724
|
/**
|
|
2006
|
-
*
|
|
1725
|
+
* Secondary street address, or null if not recorded.
|
|
2007
1726
|
*/
|
|
2008
|
-
|
|
1727
|
+
line_2: string | null;
|
|
2009
1728
|
/**
|
|
2010
|
-
*
|
|
1729
|
+
* Postal or ZIP code.
|
|
2011
1730
|
*/
|
|
2012
|
-
|
|
1731
|
+
postal_code: string;
|
|
2013
1732
|
/**
|
|
2014
|
-
*
|
|
1733
|
+
* State, province, or region.
|
|
2015
1734
|
*/
|
|
2016
|
-
|
|
1735
|
+
state: string;
|
|
2017
1736
|
}
|
|
2018
|
-
interface
|
|
1737
|
+
interface V1NonUsResidentialAddress {
|
|
2019
1738
|
/**
|
|
2020
|
-
* City
|
|
1739
|
+
* City or locality.
|
|
2021
1740
|
*/
|
|
2022
1741
|
city: string;
|
|
2023
1742
|
/**
|
|
2024
1743
|
* ISO 3166-1 alpha-2 country code.
|
|
2025
1744
|
*/
|
|
2026
|
-
|
|
1745
|
+
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
1746
|
/**
|
|
2028
|
-
*
|
|
1747
|
+
* Primary street address.
|
|
2029
1748
|
*/
|
|
2030
|
-
|
|
1749
|
+
line_1: string;
|
|
2031
1750
|
/**
|
|
2032
|
-
*
|
|
1751
|
+
* Secondary street address, or null if not recorded.
|
|
2033
1752
|
*/
|
|
2034
|
-
|
|
1753
|
+
line_2: string | null;
|
|
1754
|
+
/**
|
|
1755
|
+
* Postal or ZIP code.
|
|
1756
|
+
*/
|
|
1757
|
+
postal_code: string;
|
|
2035
1758
|
/**
|
|
2036
|
-
*
|
|
1759
|
+
* State, province, or region, or null if not recorded.
|
|
2037
1760
|
*/
|
|
2038
|
-
|
|
1761
|
+
state: string | null;
|
|
2039
1762
|
}
|
|
2040
1763
|
}
|
|
2041
|
-
interface
|
|
1764
|
+
interface V1UsResidentialAddress {
|
|
2042
1765
|
/**
|
|
2043
|
-
* City
|
|
1766
|
+
* City or locality.
|
|
2044
1767
|
*/
|
|
2045
1768
|
city: string;
|
|
2046
1769
|
/**
|
|
2047
1770
|
* ISO 3166-1 alpha-2 country code.
|
|
2048
1771
|
*/
|
|
2049
|
-
|
|
1772
|
+
country_code: 'US';
|
|
2050
1773
|
/**
|
|
2051
|
-
*
|
|
1774
|
+
* Primary street address.
|
|
2052
1775
|
*/
|
|
2053
|
-
|
|
1776
|
+
line_1: string;
|
|
2054
1777
|
/**
|
|
2055
|
-
*
|
|
1778
|
+
* Secondary street address, or null if not recorded.
|
|
2056
1779
|
*/
|
|
2057
|
-
|
|
1780
|
+
line_2: string | null;
|
|
2058
1781
|
/**
|
|
2059
|
-
*
|
|
1782
|
+
* Postal or ZIP code.
|
|
2060
1783
|
*/
|
|
2061
|
-
|
|
1784
|
+
postal_code: string;
|
|
2062
1785
|
/**
|
|
2063
|
-
*
|
|
1786
|
+
* State, province, or region.
|
|
2064
1787
|
*/
|
|
2065
|
-
|
|
1788
|
+
state: string;
|
|
2066
1789
|
}
|
|
2067
|
-
interface
|
|
1790
|
+
interface V1NonUsResidentialAddress {
|
|
2068
1791
|
/**
|
|
2069
|
-
* City
|
|
1792
|
+
* City or locality.
|
|
2070
1793
|
*/
|
|
2071
1794
|
city: string;
|
|
2072
1795
|
/**
|
|
2073
1796
|
* ISO 3166-1 alpha-2 country code.
|
|
2074
1797
|
*/
|
|
2075
|
-
|
|
1798
|
+
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
1799
|
/**
|
|
2077
|
-
*
|
|
1800
|
+
* Primary street address.
|
|
2078
1801
|
*/
|
|
2079
|
-
|
|
1802
|
+
line_1: string;
|
|
2080
1803
|
/**
|
|
2081
|
-
*
|
|
1804
|
+
* Secondary street address, or null if not recorded.
|
|
2082
1805
|
*/
|
|
2083
|
-
|
|
1806
|
+
line_2: string | null;
|
|
1807
|
+
/**
|
|
1808
|
+
* Postal or ZIP code.
|
|
1809
|
+
*/
|
|
1810
|
+
postal_code: string;
|
|
2084
1811
|
/**
|
|
2085
|
-
*
|
|
1812
|
+
* State, province, or region, or null if not recorded.
|
|
2086
1813
|
*/
|
|
2087
|
-
|
|
1814
|
+
state: string | null;
|
|
2088
1815
|
}
|
|
2089
|
-
interface
|
|
1816
|
+
interface V1UsResidentialAddress {
|
|
2090
1817
|
/**
|
|
2091
|
-
* City
|
|
1818
|
+
* City or locality.
|
|
2092
1819
|
*/
|
|
2093
1820
|
city: string;
|
|
2094
1821
|
/**
|
|
2095
1822
|
* ISO 3166-1 alpha-2 country code.
|
|
2096
1823
|
*/
|
|
2097
|
-
|
|
1824
|
+
country_code: 'US';
|
|
2098
1825
|
/**
|
|
2099
|
-
*
|
|
1826
|
+
* Primary street address.
|
|
2100
1827
|
*/
|
|
2101
|
-
|
|
1828
|
+
line_1: string;
|
|
2102
1829
|
/**
|
|
2103
|
-
*
|
|
1830
|
+
* Secondary street address, or null if not recorded.
|
|
2104
1831
|
*/
|
|
2105
|
-
|
|
1832
|
+
line_2: string | null;
|
|
2106
1833
|
/**
|
|
2107
|
-
*
|
|
1834
|
+
* Postal or ZIP code.
|
|
2108
1835
|
*/
|
|
2109
|
-
|
|
1836
|
+
postal_code: string;
|
|
2110
1837
|
/**
|
|
2111
|
-
*
|
|
1838
|
+
* State, province, or region.
|
|
2112
1839
|
*/
|
|
2113
|
-
|
|
1840
|
+
state: string;
|
|
2114
1841
|
}
|
|
2115
|
-
interface
|
|
1842
|
+
interface V1NonUsResidentialAddress {
|
|
2116
1843
|
/**
|
|
2117
|
-
* City
|
|
1844
|
+
* City or locality.
|
|
2118
1845
|
*/
|
|
2119
1846
|
city: string;
|
|
2120
1847
|
/**
|
|
2121
1848
|
* ISO 3166-1 alpha-2 country code.
|
|
2122
1849
|
*/
|
|
2123
|
-
|
|
1850
|
+
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
1851
|
/**
|
|
2125
|
-
*
|
|
1852
|
+
* Primary street address.
|
|
2126
1853
|
*/
|
|
2127
|
-
|
|
1854
|
+
line_1: string;
|
|
2128
1855
|
/**
|
|
2129
|
-
*
|
|
1856
|
+
* Secondary street address, or null if not recorded.
|
|
2130
1857
|
*/
|
|
2131
|
-
|
|
1858
|
+
line_2: string | null;
|
|
1859
|
+
/**
|
|
1860
|
+
* Postal or ZIP code.
|
|
1861
|
+
*/
|
|
1862
|
+
postal_code: string;
|
|
2132
1863
|
/**
|
|
2133
|
-
*
|
|
1864
|
+
* State, province, or region, or null if not recorded.
|
|
2134
1865
|
*/
|
|
2135
|
-
|
|
1866
|
+
state: string | null;
|
|
2136
1867
|
}
|
|
2137
|
-
interface
|
|
1868
|
+
interface V1EinIdentification {
|
|
2138
1869
|
type: 'ein';
|
|
2139
1870
|
value: string;
|
|
2140
1871
|
}
|
|
2141
|
-
interface
|
|
1872
|
+
interface V1SsnIdentification {
|
|
2142
1873
|
type: 'ssn';
|
|
2143
1874
|
value: string;
|
|
2144
1875
|
}
|
|
@@ -2177,9 +1908,12 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2177
1908
|
*/
|
|
2178
1909
|
id: string;
|
|
2179
1910
|
/**
|
|
2180
|
-
* Beneficiary details used to create this account holder.
|
|
1911
|
+
* Beneficiary details used to create this account holder. Which shape is returned
|
|
1912
|
+
* follows `country_of_citizenship`: **US individual** when it is `US`, **Non-US
|
|
1913
|
+
* individual** for any other country, **Business** when `holder_type` is
|
|
1914
|
+
* `business`.
|
|
2181
1915
|
*/
|
|
2182
|
-
beneficiary_data: Payload.
|
|
1916
|
+
beneficiary_data: Payload.V1UsBeneficiaryDataResponse | Payload.V1NonUsBeneficiaryDataResponse | Payload.V1BusinessBeneficiaryDataResponse;
|
|
2183
1917
|
/**
|
|
2184
1918
|
* ISO 8601 UTC timestamp when the account holder was created.
|
|
2185
1919
|
*/
|
|
@@ -2198,7 +1932,7 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2198
1932
|
type: 'account_holder';
|
|
2199
1933
|
}
|
|
2200
1934
|
namespace Payload {
|
|
2201
|
-
interface
|
|
1935
|
+
interface V1UsBeneficiaryDataResponse {
|
|
2202
1936
|
/**
|
|
2203
1937
|
* ISO 3166-1 alpha-2 country code of citizenship.
|
|
2204
1938
|
*/
|
|
@@ -2211,75 +1945,81 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2211
1945
|
* Government-issued identification with type: "ssn" (Social Security Number,
|
|
2212
1946
|
* format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
|
|
2213
1947
|
*/
|
|
2214
|
-
identification:
|
|
1948
|
+
identification: V1UsBeneficiaryDataResponse.V1SsnIdentification | V1UsBeneficiaryDataResponse.V1ItinIdentification;
|
|
2215
1949
|
/**
|
|
2216
1950
|
* Full legal name of the account holder.
|
|
2217
1951
|
*/
|
|
2218
1952
|
legal_name: string;
|
|
2219
1953
|
/**
|
|
2220
|
-
* Residential address of the account holder.
|
|
1954
|
+
* Residential address of the account holder. **US address** requires
|
|
1955
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
1956
|
+
* other country and allows `state` to be null.
|
|
2221
1957
|
*/
|
|
2222
|
-
residential_address:
|
|
1958
|
+
residential_address: V1UsBeneficiaryDataResponse.V1UsResidentialAddress | V1UsBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
2223
1959
|
}
|
|
2224
|
-
namespace
|
|
2225
|
-
interface
|
|
1960
|
+
namespace V1UsBeneficiaryDataResponse {
|
|
1961
|
+
interface V1SsnIdentification {
|
|
2226
1962
|
type: 'ssn';
|
|
2227
1963
|
value: string;
|
|
2228
1964
|
}
|
|
2229
|
-
interface
|
|
1965
|
+
interface V1ItinIdentification {
|
|
2230
1966
|
type: 'itin';
|
|
2231
1967
|
value: string;
|
|
2232
1968
|
}
|
|
2233
|
-
interface
|
|
1969
|
+
interface V1UsResidentialAddress {
|
|
2234
1970
|
/**
|
|
2235
|
-
* City
|
|
1971
|
+
* City or locality.
|
|
2236
1972
|
*/
|
|
2237
1973
|
city: string;
|
|
2238
1974
|
/**
|
|
2239
1975
|
* ISO 3166-1 alpha-2 country code.
|
|
2240
1976
|
*/
|
|
2241
|
-
|
|
1977
|
+
country_code: 'US';
|
|
2242
1978
|
/**
|
|
2243
|
-
*
|
|
1979
|
+
* Primary street address.
|
|
2244
1980
|
*/
|
|
2245
|
-
|
|
1981
|
+
line_1: string;
|
|
2246
1982
|
/**
|
|
2247
|
-
*
|
|
1983
|
+
* Secondary street address, or null if not recorded.
|
|
2248
1984
|
*/
|
|
2249
|
-
|
|
1985
|
+
line_2: string | null;
|
|
2250
1986
|
/**
|
|
2251
|
-
*
|
|
1987
|
+
* Postal or ZIP code.
|
|
2252
1988
|
*/
|
|
2253
|
-
|
|
1989
|
+
postal_code: string;
|
|
2254
1990
|
/**
|
|
2255
|
-
*
|
|
1991
|
+
* State, province, or region.
|
|
2256
1992
|
*/
|
|
2257
|
-
|
|
1993
|
+
state: string;
|
|
2258
1994
|
}
|
|
2259
|
-
interface
|
|
1995
|
+
interface V1NonUsResidentialAddress {
|
|
2260
1996
|
/**
|
|
2261
|
-
* City
|
|
1997
|
+
* City or locality.
|
|
2262
1998
|
*/
|
|
2263
1999
|
city: string;
|
|
2264
2000
|
/**
|
|
2265
2001
|
* ISO 3166-1 alpha-2 country code.
|
|
2266
2002
|
*/
|
|
2267
|
-
|
|
2003
|
+
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
2004
|
/**
|
|
2269
|
-
*
|
|
2005
|
+
* Primary street address.
|
|
2270
2006
|
*/
|
|
2271
|
-
|
|
2007
|
+
line_1: string;
|
|
2272
2008
|
/**
|
|
2273
|
-
*
|
|
2009
|
+
* Secondary street address, or null if not recorded.
|
|
2274
2010
|
*/
|
|
2275
|
-
|
|
2011
|
+
line_2: string | null;
|
|
2012
|
+
/**
|
|
2013
|
+
* Postal or ZIP code.
|
|
2014
|
+
*/
|
|
2015
|
+
postal_code: string;
|
|
2276
2016
|
/**
|
|
2277
|
-
*
|
|
2017
|
+
* State, province, or region, or null if not recorded.
|
|
2278
2018
|
*/
|
|
2279
|
-
|
|
2019
|
+
state: string | null;
|
|
2280
2020
|
}
|
|
2281
2021
|
}
|
|
2282
|
-
interface
|
|
2022
|
+
interface V1NonUsBeneficiaryDataResponse {
|
|
2283
2023
|
/**
|
|
2284
2024
|
* ISO 3166-1 alpha-2 country code of citizenship.
|
|
2285
2025
|
*/
|
|
@@ -2291,17 +2031,19 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2291
2031
|
/**
|
|
2292
2032
|
* Government-issued identification with type: "id" (generic government-issued ID).
|
|
2293
2033
|
*/
|
|
2294
|
-
identification:
|
|
2034
|
+
identification: V1NonUsBeneficiaryDataResponse.Identification;
|
|
2295
2035
|
/**
|
|
2296
2036
|
* Full legal name of the account holder.
|
|
2297
2037
|
*/
|
|
2298
2038
|
legal_name: string;
|
|
2299
2039
|
/**
|
|
2300
|
-
* Residential address of the account holder.
|
|
2040
|
+
* Residential address of the account holder. **US address** requires
|
|
2041
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
2042
|
+
* other country and allows `state` to be null.
|
|
2301
2043
|
*/
|
|
2302
|
-
residential_address:
|
|
2044
|
+
residential_address: V1NonUsBeneficiaryDataResponse.V1UsResidentialAddress | V1NonUsBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
2303
2045
|
}
|
|
2304
|
-
namespace
|
|
2046
|
+
namespace V1NonUsBeneficiaryDataResponse {
|
|
2305
2047
|
/**
|
|
2306
2048
|
* Government-issued identification with type: "id" (generic government-issued ID).
|
|
2307
2049
|
*/
|
|
@@ -2309,65 +2051,70 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2309
2051
|
type: 'id';
|
|
2310
2052
|
value: string;
|
|
2311
2053
|
}
|
|
2312
|
-
interface
|
|
2054
|
+
interface V1UsResidentialAddress {
|
|
2313
2055
|
/**
|
|
2314
|
-
* City
|
|
2056
|
+
* City or locality.
|
|
2315
2057
|
*/
|
|
2316
2058
|
city: string;
|
|
2317
2059
|
/**
|
|
2318
2060
|
* ISO 3166-1 alpha-2 country code.
|
|
2319
2061
|
*/
|
|
2320
|
-
|
|
2062
|
+
country_code: 'US';
|
|
2321
2063
|
/**
|
|
2322
|
-
*
|
|
2064
|
+
* Primary street address.
|
|
2323
2065
|
*/
|
|
2324
|
-
|
|
2066
|
+
line_1: string;
|
|
2325
2067
|
/**
|
|
2326
|
-
*
|
|
2068
|
+
* Secondary street address, or null if not recorded.
|
|
2327
2069
|
*/
|
|
2328
|
-
|
|
2070
|
+
line_2: string | null;
|
|
2329
2071
|
/**
|
|
2330
|
-
*
|
|
2072
|
+
* Postal or ZIP code.
|
|
2331
2073
|
*/
|
|
2332
|
-
|
|
2074
|
+
postal_code: string;
|
|
2333
2075
|
/**
|
|
2334
|
-
*
|
|
2076
|
+
* State, province, or region.
|
|
2335
2077
|
*/
|
|
2336
|
-
|
|
2078
|
+
state: string;
|
|
2337
2079
|
}
|
|
2338
|
-
interface
|
|
2080
|
+
interface V1NonUsResidentialAddress {
|
|
2339
2081
|
/**
|
|
2340
|
-
* City
|
|
2082
|
+
* City or locality.
|
|
2341
2083
|
*/
|
|
2342
2084
|
city: string;
|
|
2343
2085
|
/**
|
|
2344
2086
|
* ISO 3166-1 alpha-2 country code.
|
|
2345
2087
|
*/
|
|
2346
|
-
|
|
2088
|
+
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
2089
|
/**
|
|
2348
|
-
*
|
|
2090
|
+
* Primary street address.
|
|
2349
2091
|
*/
|
|
2350
|
-
|
|
2092
|
+
line_1: string;
|
|
2351
2093
|
/**
|
|
2352
|
-
*
|
|
2094
|
+
* Secondary street address, or null if not recorded.
|
|
2353
2095
|
*/
|
|
2354
|
-
|
|
2096
|
+
line_2: string | null;
|
|
2097
|
+
/**
|
|
2098
|
+
* Postal or ZIP code.
|
|
2099
|
+
*/
|
|
2100
|
+
postal_code: string;
|
|
2355
2101
|
/**
|
|
2356
|
-
*
|
|
2102
|
+
* State, province, or region, or null if not recorded.
|
|
2357
2103
|
*/
|
|
2358
|
-
|
|
2104
|
+
state: string | null;
|
|
2359
2105
|
}
|
|
2360
2106
|
}
|
|
2361
|
-
interface
|
|
2107
|
+
interface V1BusinessBeneficiaryDataResponse {
|
|
2362
2108
|
/**
|
|
2363
2109
|
* Beneficial owners of the business. At least one required.
|
|
2364
2110
|
*/
|
|
2365
|
-
beneficial_owners: Array<
|
|
2111
|
+
beneficial_owners: Array<V1BusinessBeneficiaryDataResponse.V1UsBeneficiaryDataResponse | V1BusinessBeneficiaryDataResponse.V1NonUsBeneficiaryDataResponse>;
|
|
2366
2112
|
/**
|
|
2367
2113
|
* Individual with primary responsibility for controlling, managing, or directing
|
|
2368
|
-
* the business.
|
|
2114
|
+
* the business. Follows the same US / non-US split as `beneficiary_data`, based on
|
|
2115
|
+
* the control person's own `country_of_citizenship`.
|
|
2369
2116
|
*/
|
|
2370
|
-
control_person:
|
|
2117
|
+
control_person: V1BusinessBeneficiaryDataResponse.UnionMember0 | V1BusinessBeneficiaryDataResponse.UnionMember1;
|
|
2371
2118
|
/**
|
|
2372
2119
|
* ISO 3166-1 alpha-2 country code where the business is incorporated.
|
|
2373
2120
|
*/
|
|
@@ -2381,18 +2128,22 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2381
2128
|
*/
|
|
2382
2129
|
legal_business_name: string;
|
|
2383
2130
|
/**
|
|
2384
|
-
* Physical operating address of the business.
|
|
2131
|
+
* Physical operating address of the business. **US address** requires
|
|
2132
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
2133
|
+
* other country and allows `state` to be null.
|
|
2385
2134
|
*/
|
|
2386
|
-
physical_address:
|
|
2135
|
+
physical_address: V1BusinessBeneficiaryDataResponse.V1UsResidentialAddress | V1BusinessBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
2387
2136
|
/**
|
|
2388
|
-
* Registered legal address of the business.
|
|
2137
|
+
* Registered legal address of the business. **US address** requires
|
|
2138
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
2139
|
+
* other country and allows `state` to be null.
|
|
2389
2140
|
*/
|
|
2390
|
-
registered_address:
|
|
2141
|
+
registered_address: V1BusinessBeneficiaryDataResponse.V1UsResidentialAddress | V1BusinessBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
2391
2142
|
/**
|
|
2392
2143
|
* Business registration number: type "ein" (Employer Identification Number, format
|
|
2393
2144
|
* ##-#######) or "ssn" (Social Security Number, format ###-##-####).
|
|
2394
2145
|
*/
|
|
2395
|
-
registration_number:
|
|
2146
|
+
registration_number: V1BusinessBeneficiaryDataResponse.V1EinIdentification | V1BusinessBeneficiaryDataResponse.V1SsnIdentification;
|
|
2396
2147
|
/**
|
|
2397
2148
|
* State or subdivision where the business is incorporated.
|
|
2398
2149
|
*/
|
|
@@ -2402,8 +2153,8 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2402
2153
|
*/
|
|
2403
2154
|
year_of_incorporation: number;
|
|
2404
2155
|
}
|
|
2405
|
-
namespace
|
|
2406
|
-
interface
|
|
2156
|
+
namespace V1BusinessBeneficiaryDataResponse {
|
|
2157
|
+
interface V1UsBeneficiaryDataResponse {
|
|
2407
2158
|
/**
|
|
2408
2159
|
* ISO 3166-1 alpha-2 country code of citizenship.
|
|
2409
2160
|
*/
|
|
@@ -2416,75 +2167,81 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2416
2167
|
* Government-issued identification with type: "ssn" (Social Security Number,
|
|
2417
2168
|
* format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
|
|
2418
2169
|
*/
|
|
2419
|
-
identification:
|
|
2170
|
+
identification: V1UsBeneficiaryDataResponse.V1SsnIdentification | V1UsBeneficiaryDataResponse.V1ItinIdentification;
|
|
2420
2171
|
/**
|
|
2421
2172
|
* Full legal name of the account holder.
|
|
2422
2173
|
*/
|
|
2423
2174
|
legal_name: string;
|
|
2424
2175
|
/**
|
|
2425
|
-
* Residential address of the account holder.
|
|
2176
|
+
* Residential address of the account holder. **US address** requires
|
|
2177
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
2178
|
+
* other country and allows `state` to be null.
|
|
2426
2179
|
*/
|
|
2427
|
-
residential_address:
|
|
2180
|
+
residential_address: V1UsBeneficiaryDataResponse.V1UsResidentialAddress | V1UsBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
2428
2181
|
}
|
|
2429
|
-
namespace
|
|
2430
|
-
interface
|
|
2182
|
+
namespace V1UsBeneficiaryDataResponse {
|
|
2183
|
+
interface V1SsnIdentification {
|
|
2431
2184
|
type: 'ssn';
|
|
2432
2185
|
value: string;
|
|
2433
2186
|
}
|
|
2434
|
-
interface
|
|
2187
|
+
interface V1ItinIdentification {
|
|
2435
2188
|
type: 'itin';
|
|
2436
2189
|
value: string;
|
|
2437
2190
|
}
|
|
2438
|
-
interface
|
|
2191
|
+
interface V1UsResidentialAddress {
|
|
2439
2192
|
/**
|
|
2440
|
-
* City
|
|
2193
|
+
* City or locality.
|
|
2441
2194
|
*/
|
|
2442
2195
|
city: string;
|
|
2443
2196
|
/**
|
|
2444
2197
|
* ISO 3166-1 alpha-2 country code.
|
|
2445
2198
|
*/
|
|
2446
|
-
|
|
2199
|
+
country_code: 'US';
|
|
2447
2200
|
/**
|
|
2448
|
-
*
|
|
2201
|
+
* Primary street address.
|
|
2449
2202
|
*/
|
|
2450
|
-
|
|
2203
|
+
line_1: string;
|
|
2451
2204
|
/**
|
|
2452
|
-
*
|
|
2205
|
+
* Secondary street address, or null if not recorded.
|
|
2453
2206
|
*/
|
|
2454
|
-
|
|
2207
|
+
line_2: string | null;
|
|
2455
2208
|
/**
|
|
2456
|
-
*
|
|
2209
|
+
* Postal or ZIP code.
|
|
2457
2210
|
*/
|
|
2458
|
-
|
|
2211
|
+
postal_code: string;
|
|
2459
2212
|
/**
|
|
2460
|
-
*
|
|
2213
|
+
* State, province, or region.
|
|
2461
2214
|
*/
|
|
2462
|
-
|
|
2215
|
+
state: string;
|
|
2463
2216
|
}
|
|
2464
|
-
interface
|
|
2217
|
+
interface V1NonUsResidentialAddress {
|
|
2465
2218
|
/**
|
|
2466
|
-
* City
|
|
2219
|
+
* City or locality.
|
|
2467
2220
|
*/
|
|
2468
2221
|
city: string;
|
|
2469
2222
|
/**
|
|
2470
2223
|
* ISO 3166-1 alpha-2 country code.
|
|
2471
2224
|
*/
|
|
2472
|
-
|
|
2225
|
+
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
2226
|
/**
|
|
2474
|
-
*
|
|
2227
|
+
* Primary street address.
|
|
2475
2228
|
*/
|
|
2476
|
-
|
|
2229
|
+
line_1: string;
|
|
2477
2230
|
/**
|
|
2478
|
-
*
|
|
2231
|
+
* Secondary street address, or null if not recorded.
|
|
2479
2232
|
*/
|
|
2480
|
-
|
|
2233
|
+
line_2: string | null;
|
|
2234
|
+
/**
|
|
2235
|
+
* Postal or ZIP code.
|
|
2236
|
+
*/
|
|
2237
|
+
postal_code: string;
|
|
2481
2238
|
/**
|
|
2482
|
-
*
|
|
2239
|
+
* State, province, or region, or null if not recorded.
|
|
2483
2240
|
*/
|
|
2484
|
-
|
|
2241
|
+
state: string | null;
|
|
2485
2242
|
}
|
|
2486
2243
|
}
|
|
2487
|
-
interface
|
|
2244
|
+
interface V1NonUsBeneficiaryDataResponse {
|
|
2488
2245
|
/**
|
|
2489
2246
|
* ISO 3166-1 alpha-2 country code of citizenship.
|
|
2490
2247
|
*/
|
|
@@ -2496,17 +2253,19 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2496
2253
|
/**
|
|
2497
2254
|
* Government-issued identification with type: "id" (generic government-issued ID).
|
|
2498
2255
|
*/
|
|
2499
|
-
identification:
|
|
2256
|
+
identification: V1NonUsBeneficiaryDataResponse.Identification;
|
|
2500
2257
|
/**
|
|
2501
2258
|
* Full legal name of the account holder.
|
|
2502
2259
|
*/
|
|
2503
2260
|
legal_name: string;
|
|
2504
2261
|
/**
|
|
2505
|
-
* Residential address of the account holder.
|
|
2262
|
+
* Residential address of the account holder. **US address** requires
|
|
2263
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
2264
|
+
* other country and allows `state` to be null.
|
|
2506
2265
|
*/
|
|
2507
|
-
residential_address:
|
|
2266
|
+
residential_address: V1NonUsBeneficiaryDataResponse.V1UsResidentialAddress | V1NonUsBeneficiaryDataResponse.V1NonUsResidentialAddress;
|
|
2508
2267
|
}
|
|
2509
|
-
namespace
|
|
2268
|
+
namespace V1NonUsBeneficiaryDataResponse {
|
|
2510
2269
|
/**
|
|
2511
2270
|
* Government-issued identification with type: "id" (generic government-issued ID).
|
|
2512
2271
|
*/
|
|
@@ -2514,53 +2273,57 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2514
2273
|
type: 'id';
|
|
2515
2274
|
value: string;
|
|
2516
2275
|
}
|
|
2517
|
-
interface
|
|
2276
|
+
interface V1UsResidentialAddress {
|
|
2518
2277
|
/**
|
|
2519
|
-
* City
|
|
2278
|
+
* City or locality.
|
|
2520
2279
|
*/
|
|
2521
2280
|
city: string;
|
|
2522
2281
|
/**
|
|
2523
2282
|
* ISO 3166-1 alpha-2 country code.
|
|
2524
2283
|
*/
|
|
2525
|
-
|
|
2284
|
+
country_code: 'US';
|
|
2526
2285
|
/**
|
|
2527
|
-
*
|
|
2286
|
+
* Primary street address.
|
|
2528
2287
|
*/
|
|
2529
|
-
|
|
2288
|
+
line_1: string;
|
|
2530
2289
|
/**
|
|
2531
|
-
*
|
|
2290
|
+
* Secondary street address, or null if not recorded.
|
|
2532
2291
|
*/
|
|
2533
|
-
|
|
2292
|
+
line_2: string | null;
|
|
2534
2293
|
/**
|
|
2535
|
-
*
|
|
2294
|
+
* Postal or ZIP code.
|
|
2536
2295
|
*/
|
|
2537
|
-
|
|
2296
|
+
postal_code: string;
|
|
2538
2297
|
/**
|
|
2539
|
-
*
|
|
2298
|
+
* State, province, or region.
|
|
2540
2299
|
*/
|
|
2541
|
-
|
|
2300
|
+
state: string;
|
|
2542
2301
|
}
|
|
2543
|
-
interface
|
|
2302
|
+
interface V1NonUsResidentialAddress {
|
|
2544
2303
|
/**
|
|
2545
|
-
* City
|
|
2304
|
+
* City or locality.
|
|
2546
2305
|
*/
|
|
2547
2306
|
city: string;
|
|
2548
2307
|
/**
|
|
2549
2308
|
* ISO 3166-1 alpha-2 country code.
|
|
2550
2309
|
*/
|
|
2551
|
-
|
|
2310
|
+
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
2311
|
/**
|
|
2553
|
-
*
|
|
2312
|
+
* Primary street address.
|
|
2554
2313
|
*/
|
|
2555
|
-
|
|
2314
|
+
line_1: string;
|
|
2556
2315
|
/**
|
|
2557
|
-
*
|
|
2316
|
+
* Secondary street address, or null if not recorded.
|
|
2558
2317
|
*/
|
|
2559
|
-
|
|
2318
|
+
line_2: string | null;
|
|
2319
|
+
/**
|
|
2320
|
+
* Postal or ZIP code.
|
|
2321
|
+
*/
|
|
2322
|
+
postal_code: string;
|
|
2560
2323
|
/**
|
|
2561
|
-
*
|
|
2324
|
+
* State, province, or region, or null if not recorded.
|
|
2562
2325
|
*/
|
|
2563
|
-
|
|
2326
|
+
state: string | null;
|
|
2564
2327
|
}
|
|
2565
2328
|
}
|
|
2566
2329
|
interface UnionMember0 {
|
|
@@ -2576,15 +2339,17 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2576
2339
|
* Government-issued identification with type: "ssn" (Social Security Number,
|
|
2577
2340
|
* format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
|
|
2578
2341
|
*/
|
|
2579
|
-
identification: UnionMember0.
|
|
2342
|
+
identification: UnionMember0.V1SsnIdentification | UnionMember0.V1ItinIdentification;
|
|
2580
2343
|
/**
|
|
2581
2344
|
* Full legal name of the account holder.
|
|
2582
2345
|
*/
|
|
2583
2346
|
legal_name: string;
|
|
2584
2347
|
/**
|
|
2585
|
-
* Residential address of the account holder.
|
|
2348
|
+
* Residential address of the account holder. **US address** requires
|
|
2349
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
2350
|
+
* other country and allows `state` to be null.
|
|
2586
2351
|
*/
|
|
2587
|
-
residential_address: UnionMember0.
|
|
2352
|
+
residential_address: UnionMember0.V1UsResidentialAddress | UnionMember0.V1NonUsResidentialAddress;
|
|
2588
2353
|
/**
|
|
2589
2354
|
* Role of the control person at the business (e.g., "CEO", "President", "Managing
|
|
2590
2355
|
* Director").
|
|
@@ -2592,61 +2357,65 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2592
2357
|
title: string;
|
|
2593
2358
|
}
|
|
2594
2359
|
namespace UnionMember0 {
|
|
2595
|
-
interface
|
|
2360
|
+
interface V1SsnIdentification {
|
|
2596
2361
|
type: 'ssn';
|
|
2597
2362
|
value: string;
|
|
2598
2363
|
}
|
|
2599
|
-
interface
|
|
2364
|
+
interface V1ItinIdentification {
|
|
2600
2365
|
type: 'itin';
|
|
2601
2366
|
value: string;
|
|
2602
2367
|
}
|
|
2603
|
-
interface
|
|
2368
|
+
interface V1UsResidentialAddress {
|
|
2604
2369
|
/**
|
|
2605
|
-
* City
|
|
2370
|
+
* City or locality.
|
|
2606
2371
|
*/
|
|
2607
2372
|
city: string;
|
|
2608
2373
|
/**
|
|
2609
2374
|
* ISO 3166-1 alpha-2 country code.
|
|
2610
2375
|
*/
|
|
2611
|
-
|
|
2376
|
+
country_code: 'US';
|
|
2612
2377
|
/**
|
|
2613
|
-
*
|
|
2378
|
+
* Primary street address.
|
|
2614
2379
|
*/
|
|
2615
|
-
|
|
2380
|
+
line_1: string;
|
|
2616
2381
|
/**
|
|
2617
|
-
*
|
|
2382
|
+
* Secondary street address, or null if not recorded.
|
|
2618
2383
|
*/
|
|
2619
|
-
|
|
2384
|
+
line_2: string | null;
|
|
2620
2385
|
/**
|
|
2621
|
-
*
|
|
2386
|
+
* Postal or ZIP code.
|
|
2622
2387
|
*/
|
|
2623
|
-
|
|
2388
|
+
postal_code: string;
|
|
2624
2389
|
/**
|
|
2625
|
-
*
|
|
2390
|
+
* State, province, or region.
|
|
2626
2391
|
*/
|
|
2627
|
-
|
|
2392
|
+
state: string;
|
|
2628
2393
|
}
|
|
2629
|
-
interface
|
|
2394
|
+
interface V1NonUsResidentialAddress {
|
|
2630
2395
|
/**
|
|
2631
|
-
* City
|
|
2396
|
+
* City or locality.
|
|
2632
2397
|
*/
|
|
2633
2398
|
city: string;
|
|
2634
2399
|
/**
|
|
2635
2400
|
* ISO 3166-1 alpha-2 country code.
|
|
2636
2401
|
*/
|
|
2637
|
-
|
|
2402
|
+
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
2403
|
/**
|
|
2639
|
-
*
|
|
2404
|
+
* Primary street address.
|
|
2640
2405
|
*/
|
|
2641
|
-
|
|
2406
|
+
line_1: string;
|
|
2642
2407
|
/**
|
|
2643
|
-
*
|
|
2408
|
+
* Secondary street address, or null if not recorded.
|
|
2644
2409
|
*/
|
|
2645
|
-
|
|
2410
|
+
line_2: string | null;
|
|
2411
|
+
/**
|
|
2412
|
+
* Postal or ZIP code.
|
|
2413
|
+
*/
|
|
2414
|
+
postal_code: string;
|
|
2646
2415
|
/**
|
|
2647
|
-
*
|
|
2416
|
+
* State, province, or region, or null if not recorded.
|
|
2648
2417
|
*/
|
|
2649
|
-
|
|
2418
|
+
state: string | null;
|
|
2650
2419
|
}
|
|
2651
2420
|
}
|
|
2652
2421
|
interface UnionMember1 {
|
|
@@ -2667,9 +2436,11 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2667
2436
|
*/
|
|
2668
2437
|
legal_name: string;
|
|
2669
2438
|
/**
|
|
2670
|
-
* Residential address of the account holder.
|
|
2439
|
+
* Residential address of the account holder. **US address** requires
|
|
2440
|
+
* `country_code: US` and a two-letter `state`. **Non-US address** accepts any
|
|
2441
|
+
* other country and allows `state` to be null.
|
|
2671
2442
|
*/
|
|
2672
|
-
residential_address: UnionMember1.
|
|
2443
|
+
residential_address: UnionMember1.V1UsResidentialAddress | UnionMember1.V1NonUsResidentialAddress;
|
|
2673
2444
|
/**
|
|
2674
2445
|
* Role of the control person at the business (e.g., "CEO", "President", "Managing
|
|
2675
2446
|
* Director").
|
|
@@ -2684,156 +2455,168 @@ export declare namespace AccountHolderClosedWebhookEvent {
|
|
|
2684
2455
|
type: 'id';
|
|
2685
2456
|
value: string;
|
|
2686
2457
|
}
|
|
2687
|
-
interface
|
|
2458
|
+
interface V1UsResidentialAddress {
|
|
2688
2459
|
/**
|
|
2689
|
-
* City
|
|
2460
|
+
* City or locality.
|
|
2690
2461
|
*/
|
|
2691
2462
|
city: string;
|
|
2692
2463
|
/**
|
|
2693
2464
|
* ISO 3166-1 alpha-2 country code.
|
|
2694
2465
|
*/
|
|
2695
|
-
|
|
2466
|
+
country_code: 'US';
|
|
2696
2467
|
/**
|
|
2697
|
-
*
|
|
2468
|
+
* Primary street address.
|
|
2698
2469
|
*/
|
|
2699
|
-
|
|
2470
|
+
line_1: string;
|
|
2700
2471
|
/**
|
|
2701
|
-
*
|
|
2472
|
+
* Secondary street address, or null if not recorded.
|
|
2702
2473
|
*/
|
|
2703
|
-
|
|
2474
|
+
line_2: string | null;
|
|
2704
2475
|
/**
|
|
2705
|
-
*
|
|
2476
|
+
* Postal or ZIP code.
|
|
2706
2477
|
*/
|
|
2707
|
-
|
|
2478
|
+
postal_code: string;
|
|
2708
2479
|
/**
|
|
2709
|
-
*
|
|
2480
|
+
* State, province, or region.
|
|
2710
2481
|
*/
|
|
2711
|
-
|
|
2482
|
+
state: string;
|
|
2712
2483
|
}
|
|
2713
|
-
interface
|
|
2484
|
+
interface V1NonUsResidentialAddress {
|
|
2714
2485
|
/**
|
|
2715
|
-
* City
|
|
2486
|
+
* City or locality.
|
|
2716
2487
|
*/
|
|
2717
2488
|
city: string;
|
|
2718
2489
|
/**
|
|
2719
2490
|
* ISO 3166-1 alpha-2 country code.
|
|
2720
2491
|
*/
|
|
2721
|
-
|
|
2492
|
+
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
2493
|
/**
|
|
2723
|
-
*
|
|
2494
|
+
* Primary street address.
|
|
2724
2495
|
*/
|
|
2725
|
-
|
|
2496
|
+
line_1: string;
|
|
2726
2497
|
/**
|
|
2727
|
-
*
|
|
2498
|
+
* Secondary street address, or null if not recorded.
|
|
2728
2499
|
*/
|
|
2729
|
-
|
|
2500
|
+
line_2: string | null;
|
|
2501
|
+
/**
|
|
2502
|
+
* Postal or ZIP code.
|
|
2503
|
+
*/
|
|
2504
|
+
postal_code: string;
|
|
2730
2505
|
/**
|
|
2731
|
-
*
|
|
2506
|
+
* State, province, or region, or null if not recorded.
|
|
2732
2507
|
*/
|
|
2733
|
-
|
|
2508
|
+
state: string | null;
|
|
2734
2509
|
}
|
|
2735
2510
|
}
|
|
2736
|
-
interface
|
|
2511
|
+
interface V1UsResidentialAddress {
|
|
2737
2512
|
/**
|
|
2738
|
-
* City
|
|
2513
|
+
* City or locality.
|
|
2739
2514
|
*/
|
|
2740
2515
|
city: string;
|
|
2741
2516
|
/**
|
|
2742
2517
|
* ISO 3166-1 alpha-2 country code.
|
|
2743
2518
|
*/
|
|
2744
|
-
|
|
2519
|
+
country_code: 'US';
|
|
2745
2520
|
/**
|
|
2746
|
-
*
|
|
2521
|
+
* Primary street address.
|
|
2747
2522
|
*/
|
|
2748
|
-
|
|
2523
|
+
line_1: string;
|
|
2749
2524
|
/**
|
|
2750
|
-
*
|
|
2525
|
+
* Secondary street address, or null if not recorded.
|
|
2751
2526
|
*/
|
|
2752
|
-
|
|
2527
|
+
line_2: string | null;
|
|
2753
2528
|
/**
|
|
2754
|
-
*
|
|
2529
|
+
* Postal or ZIP code.
|
|
2755
2530
|
*/
|
|
2756
|
-
|
|
2531
|
+
postal_code: string;
|
|
2757
2532
|
/**
|
|
2758
|
-
*
|
|
2533
|
+
* State, province, or region.
|
|
2759
2534
|
*/
|
|
2760
|
-
|
|
2535
|
+
state: string;
|
|
2761
2536
|
}
|
|
2762
|
-
interface
|
|
2537
|
+
interface V1NonUsResidentialAddress {
|
|
2763
2538
|
/**
|
|
2764
|
-
* City
|
|
2539
|
+
* City or locality.
|
|
2765
2540
|
*/
|
|
2766
2541
|
city: string;
|
|
2767
2542
|
/**
|
|
2768
2543
|
* ISO 3166-1 alpha-2 country code.
|
|
2769
2544
|
*/
|
|
2770
|
-
|
|
2545
|
+
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
2546
|
/**
|
|
2772
|
-
*
|
|
2547
|
+
* Primary street address.
|
|
2773
2548
|
*/
|
|
2774
|
-
|
|
2549
|
+
line_1: string;
|
|
2775
2550
|
/**
|
|
2776
|
-
*
|
|
2551
|
+
* Secondary street address, or null if not recorded.
|
|
2777
2552
|
*/
|
|
2778
|
-
|
|
2553
|
+
line_2: string | null;
|
|
2554
|
+
/**
|
|
2555
|
+
* Postal or ZIP code.
|
|
2556
|
+
*/
|
|
2557
|
+
postal_code: string;
|
|
2779
2558
|
/**
|
|
2780
|
-
*
|
|
2559
|
+
* State, province, or region, or null if not recorded.
|
|
2781
2560
|
*/
|
|
2782
|
-
|
|
2561
|
+
state: string | null;
|
|
2783
2562
|
}
|
|
2784
|
-
interface
|
|
2563
|
+
interface V1UsResidentialAddress {
|
|
2785
2564
|
/**
|
|
2786
|
-
* City
|
|
2565
|
+
* City or locality.
|
|
2787
2566
|
*/
|
|
2788
2567
|
city: string;
|
|
2789
2568
|
/**
|
|
2790
2569
|
* ISO 3166-1 alpha-2 country code.
|
|
2791
2570
|
*/
|
|
2792
|
-
|
|
2571
|
+
country_code: 'US';
|
|
2793
2572
|
/**
|
|
2794
|
-
*
|
|
2573
|
+
* Primary street address.
|
|
2795
2574
|
*/
|
|
2796
|
-
|
|
2575
|
+
line_1: string;
|
|
2797
2576
|
/**
|
|
2798
|
-
*
|
|
2577
|
+
* Secondary street address, or null if not recorded.
|
|
2799
2578
|
*/
|
|
2800
|
-
|
|
2579
|
+
line_2: string | null;
|
|
2801
2580
|
/**
|
|
2802
|
-
*
|
|
2581
|
+
* Postal or ZIP code.
|
|
2803
2582
|
*/
|
|
2804
|
-
|
|
2583
|
+
postal_code: string;
|
|
2805
2584
|
/**
|
|
2806
|
-
*
|
|
2585
|
+
* State, province, or region.
|
|
2807
2586
|
*/
|
|
2808
|
-
|
|
2587
|
+
state: string;
|
|
2809
2588
|
}
|
|
2810
|
-
interface
|
|
2589
|
+
interface V1NonUsResidentialAddress {
|
|
2811
2590
|
/**
|
|
2812
|
-
* City
|
|
2591
|
+
* City or locality.
|
|
2813
2592
|
*/
|
|
2814
2593
|
city: string;
|
|
2815
2594
|
/**
|
|
2816
2595
|
* ISO 3166-1 alpha-2 country code.
|
|
2817
2596
|
*/
|
|
2818
|
-
|
|
2597
|
+
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
2598
|
/**
|
|
2820
|
-
*
|
|
2599
|
+
* Primary street address.
|
|
2821
2600
|
*/
|
|
2822
|
-
|
|
2601
|
+
line_1: string;
|
|
2823
2602
|
/**
|
|
2824
|
-
*
|
|
2603
|
+
* Secondary street address, or null if not recorded.
|
|
2825
2604
|
*/
|
|
2826
|
-
|
|
2605
|
+
line_2: string | null;
|
|
2606
|
+
/**
|
|
2607
|
+
* Postal or ZIP code.
|
|
2608
|
+
*/
|
|
2609
|
+
postal_code: string;
|
|
2827
2610
|
/**
|
|
2828
|
-
*
|
|
2611
|
+
* State, province, or region, or null if not recorded.
|
|
2829
2612
|
*/
|
|
2830
|
-
|
|
2613
|
+
state: string | null;
|
|
2831
2614
|
}
|
|
2832
|
-
interface
|
|
2615
|
+
interface V1EinIdentification {
|
|
2833
2616
|
type: 'ein';
|
|
2834
2617
|
value: string;
|
|
2835
2618
|
}
|
|
2836
|
-
interface
|
|
2619
|
+
interface V1SsnIdentification {
|
|
2837
2620
|
type: 'ssn';
|
|
2838
2621
|
value: string;
|
|
2839
2622
|
}
|