@privy-io/api-types 0.19.0 → 0.21.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 +48 -0
- package/client.d.mts +25 -16
- package/client.d.mts.map +1 -1
- package/client.d.ts +25 -16
- package/client.d.ts.map +1 -1
- package/client.js +9 -0
- package/client.js.map +1 -1
- package/client.mjs +9 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/actions.d.mts +14 -0
- package/resources/actions.d.mts.map +1 -0
- package/resources/actions.d.ts +14 -0
- package/resources/actions.d.ts.map +1 -0
- package/resources/actions.js +9 -0
- package/resources/actions.js.map +1 -0
- package/resources/actions.mjs +5 -0
- package/resources/actions.mjs.map +1 -0
- package/resources/apps.d.mts +4 -0
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +4 -0
- package/resources/apps.d.ts.map +1 -1
- package/resources/cards.d.mts +436 -0
- package/resources/cards.d.mts.map +1 -0
- package/resources/cards.d.ts +436 -0
- package/resources/cards.d.ts.map +1 -0
- package/resources/cards.js +9 -0
- package/resources/cards.js.map +1 -0
- package/resources/cards.mjs +5 -0
- package/resources/cards.mjs.map +1 -0
- package/resources/client-auth.d.mts +22 -5
- package/resources/client-auth.d.mts.map +1 -1
- package/resources/client-auth.d.ts +22 -5
- package/resources/client-auth.d.ts.map +1 -1
- package/resources/fiat.d.mts +921 -2
- package/resources/fiat.d.mts.map +1 -1
- package/resources/fiat.d.ts +921 -2
- package/resources/fiat.d.ts.map +1 -1
- package/resources/fiat.js.map +1 -1
- package/resources/fiat.mjs.map +1 -1
- package/resources/index.d.mts +11 -8
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +11 -8
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +7 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +3 -0
- package/resources/index.mjs.map +1 -1
- package/resources/intents.d.mts +1 -0
- package/resources/intents.d.mts.map +1 -1
- package/resources/intents.d.ts +1 -0
- package/resources/intents.d.ts.map +1 -1
- package/resources/onramps.d.mts +39 -1
- package/resources/onramps.d.mts.map +1 -1
- package/resources/onramps.d.ts +39 -1
- package/resources/onramps.d.ts.map +1 -1
- package/resources/onramps.js.map +1 -1
- package/resources/onramps.mjs.map +1 -1
- package/resources/organizations.d.mts +54 -1
- package/resources/organizations.d.mts.map +1 -1
- package/resources/organizations.d.ts +54 -1
- package/resources/organizations.d.ts.map +1 -1
- package/resources/organizations.js.map +1 -1
- package/resources/organizations.mjs.map +1 -1
- package/resources/policies.d.mts +26 -3
- package/resources/policies.d.mts.map +1 -1
- package/resources/policies.d.ts +26 -3
- package/resources/policies.d.ts.map +1 -1
- package/resources/shared.d.mts +9 -1
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +9 -1
- package/resources/shared.d.ts.map +1 -1
- package/resources/swaps.d.mts +9 -0
- package/resources/swaps.d.mts.map +1 -1
- package/resources/swaps.d.ts +9 -0
- package/resources/swaps.d.ts.map +1 -1
- package/resources/transactions.d.mts +3 -0
- package/resources/transactions.d.mts.map +1 -1
- package/resources/transactions.d.ts +3 -0
- package/resources/transactions.d.ts.map +1 -1
- package/resources/users.d.mts +20 -0
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +20 -0
- package/resources/users.d.ts.map +1 -1
- package/resources/wallet-automations.d.mts +295 -0
- package/resources/wallet-automations.d.mts.map +1 -0
- package/resources/wallet-automations.d.ts +295 -0
- package/resources/wallet-automations.d.ts.map +1 -0
- package/resources/wallet-automations.js +9 -0
- package/resources/wallet-automations.js.map +1 -0
- package/resources/wallet-automations.mjs +5 -0
- package/resources/wallet-automations.mjs.map +1 -0
- package/resources/wallets/actions.d.mts +171 -5
- package/resources/wallets/actions.d.mts.map +1 -1
- package/resources/wallets/actions.d.ts +171 -5
- package/resources/wallets/actions.d.ts.map +1 -1
- package/resources/wallets/actions.js.map +1 -1
- package/resources/wallets/actions.mjs.map +1 -1
- package/resources/wallets/balance.d.mts +3 -3
- package/resources/wallets/balance.d.mts.map +1 -1
- package/resources/wallets/balance.d.ts +3 -3
- package/resources/wallets/balance.d.ts.map +1 -1
- package/resources/wallets/index.d.mts +2 -2
- package/resources/wallets/index.d.mts.map +1 -1
- package/resources/wallets/index.d.ts +2 -2
- package/resources/wallets/index.d.ts.map +1 -1
- package/resources/wallets/index.js.map +1 -1
- package/resources/wallets/index.mjs.map +1 -1
- package/resources/wallets/transactions.d.mts +11 -2
- package/resources/wallets/transactions.d.mts.map +1 -1
- package/resources/wallets/transactions.d.ts +11 -2
- package/resources/wallets/transactions.d.ts.map +1 -1
- package/resources/wallets/wallets.d.mts +530 -41
- package/resources/wallets/wallets.d.mts.map +1 -1
- package/resources/wallets/wallets.d.ts +530 -41
- package/resources/wallets/wallets.d.ts.map +1 -1
- package/resources/wallets/wallets.js.map +1 -1
- package/resources/wallets/wallets.mjs.map +1 -1
- package/resources/webhooks.d.mts +686 -3
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +686 -3
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs.map +1 -1
- package/src/client.ts +439 -0
- package/src/resources/actions.ts +17 -0
- package/src/resources/apps.ts +5 -0
- package/src/resources/cards.ts +570 -0
- package/src/resources/client-auth.ts +29 -4
- package/src/resources/fiat.ts +1226 -3
- package/src/resources/index.ts +215 -0
- package/src/resources/intents.ts +2 -0
- package/src/resources/onramps.ts +43 -0
- package/src/resources/organizations.ts +68 -0
- package/src/resources/policies.ts +61 -0
- package/src/resources/shared.ts +12 -0
- package/src/resources/swaps.ts +11 -0
- package/src/resources/transactions.ts +3 -0
- package/src/resources/users.ts +25 -0
- package/src/resources/wallet-automations.ts +417 -0
- package/src/resources/wallets/actions.ts +216 -4
- package/src/resources/wallets/balance.ts +32 -1
- package/src/resources/wallets/index.ts +43 -0
- package/src/resources/wallets/transactions.ts +11 -1
- package/src/resources/wallets/wallets.ts +696 -31
- package/src/resources/webhooks.ts +878 -9
- 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
|
@@ -2,7 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
import { APIResource } from '../core/resource';
|
|
4
4
|
import * as AppsAPI from './apps';
|
|
5
|
+
import * as FiatAPI from './fiat';
|
|
5
6
|
import * as IntentsAPI from './intents';
|
|
7
|
+
import * as SharedAPI from './shared';
|
|
6
8
|
import * as UsersAPI from './users';
|
|
7
9
|
import * as ActionsAPI from './wallets/actions';
|
|
8
10
|
import * as WalletsAPI from './wallets/wallets';
|
|
@@ -146,6 +148,135 @@ export interface BridgeTransferRefundMetadata {
|
|
|
146
148
|
original_transaction_hash?: string;
|
|
147
149
|
}
|
|
148
150
|
|
|
151
|
+
/**
|
|
152
|
+
* Details of a fiat deposit that has finished converting and been delivered to the
|
|
153
|
+
* wallet.
|
|
154
|
+
*/
|
|
155
|
+
export interface DepositCompletedData {
|
|
156
|
+
created_at: string;
|
|
157
|
+
|
|
158
|
+
/**
|
|
159
|
+
* The crypto asset, chain, delivered amount, and settlement transaction for a
|
|
160
|
+
* completed deposit.
|
|
161
|
+
*/
|
|
162
|
+
destination: DepositCompletedDestination;
|
|
163
|
+
|
|
164
|
+
/**
|
|
165
|
+
* The fiat deposit that was received, including amount, currency, and originator.
|
|
166
|
+
*/
|
|
167
|
+
source: DepositStartedSource;
|
|
168
|
+
}
|
|
169
|
+
|
|
170
|
+
/**
|
|
171
|
+
* The crypto asset, chain, delivered amount, and settlement transaction for a
|
|
172
|
+
* completed deposit.
|
|
173
|
+
*/
|
|
174
|
+
export interface DepositCompletedDestination {
|
|
175
|
+
/**
|
|
176
|
+
* The crypto amount delivered to the wallet, after conversion and fees.
|
|
177
|
+
*/
|
|
178
|
+
amount: string;
|
|
179
|
+
|
|
180
|
+
/**
|
|
181
|
+
* The crypto asset the deposit was converted into (e.g. "usdc").
|
|
182
|
+
*/
|
|
183
|
+
asset: string;
|
|
184
|
+
|
|
185
|
+
/**
|
|
186
|
+
* The chain the converted crypto was delivered on (e.g. "base").
|
|
187
|
+
*/
|
|
188
|
+
chain: string;
|
|
189
|
+
|
|
190
|
+
/**
|
|
191
|
+
* The on-chain settlement transaction for the delivered crypto.
|
|
192
|
+
*/
|
|
193
|
+
transaction_hash: string;
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
/**
|
|
197
|
+
* Details of a fiat deposit that failed to convert and was refunded to the sender.
|
|
198
|
+
*/
|
|
199
|
+
export interface DepositFailedData {
|
|
200
|
+
created_at: string;
|
|
201
|
+
|
|
202
|
+
/**
|
|
203
|
+
* The crypto asset and chain the fiat deposit is being converted into.
|
|
204
|
+
*/
|
|
205
|
+
destination: DepositStartedDestination;
|
|
206
|
+
|
|
207
|
+
reason: string;
|
|
208
|
+
|
|
209
|
+
reason_code: string;
|
|
210
|
+
|
|
211
|
+
refunded_at: string;
|
|
212
|
+
|
|
213
|
+
/**
|
|
214
|
+
* The fiat deposit that was received, including amount, currency, and originator.
|
|
215
|
+
*/
|
|
216
|
+
source: DepositStartedSource;
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
/**
|
|
220
|
+
* Details of a fiat deposit that has begun processing into a deposit account.
|
|
221
|
+
*/
|
|
222
|
+
export interface DepositStartedData {
|
|
223
|
+
created_at: string;
|
|
224
|
+
|
|
225
|
+
/**
|
|
226
|
+
* The crypto asset and chain the fiat deposit is being converted into.
|
|
227
|
+
*/
|
|
228
|
+
destination: DepositStartedDestination;
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* The fiat deposit that was received, including amount, currency, and originator.
|
|
232
|
+
*/
|
|
233
|
+
source: DepositStartedSource;
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
/**
|
|
237
|
+
* The crypto asset and chain the fiat deposit is being converted into.
|
|
238
|
+
*/
|
|
239
|
+
export interface DepositStartedDestination {
|
|
240
|
+
/**
|
|
241
|
+
* The crypto asset the deposit is converted into (e.g. "usdc").
|
|
242
|
+
*/
|
|
243
|
+
asset: string;
|
|
244
|
+
|
|
245
|
+
/**
|
|
246
|
+
* The chain the converted crypto is delivered on (e.g. "base").
|
|
247
|
+
*/
|
|
248
|
+
chain: string;
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
/**
|
|
252
|
+
* The fiat deposit that was received, including amount, currency, and originator.
|
|
253
|
+
*/
|
|
254
|
+
export interface DepositStartedSource {
|
|
255
|
+
/**
|
|
256
|
+
* The fiat amount deposited.
|
|
257
|
+
*/
|
|
258
|
+
amount: string;
|
|
259
|
+
|
|
260
|
+
/**
|
|
261
|
+
* Fiat currencies a deposit account can receive deposits in.
|
|
262
|
+
*/
|
|
263
|
+
currency: FiatDepositCurrency;
|
|
264
|
+
|
|
265
|
+
/**
|
|
266
|
+
* The payment rail the deposit arrived on. Known values include "sepa",
|
|
267
|
+
* "ach_push", "wire", "fednow", "faster_payments", "pix", "spei", but the provider
|
|
268
|
+
* may return others.
|
|
269
|
+
*/
|
|
270
|
+
payment_rail?: string;
|
|
271
|
+
|
|
272
|
+
sender_name?: string;
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* Fiat currencies a deposit account can receive deposits in.
|
|
277
|
+
*/
|
|
278
|
+
export type FiatDepositCurrency = 'usd' | 'eur' | 'gbp' | 'brl' | 'mxn' | 'cop';
|
|
279
|
+
|
|
149
280
|
/**
|
|
150
281
|
* Payload for the wallet.funds_deposited webhook event.
|
|
151
282
|
*/
|
|
@@ -800,6 +931,53 @@ export interface MfaEnabledWebhookPayload {
|
|
|
800
931
|
user_id: string;
|
|
801
932
|
}
|
|
802
933
|
|
|
934
|
+
/**
|
|
935
|
+
* Full KYB state snapshot in a KYB update event.
|
|
936
|
+
*/
|
|
937
|
+
export interface OrganizationKYBUpdatedData {
|
|
938
|
+
/**
|
|
939
|
+
* Capability statuses for the customer.
|
|
940
|
+
*/
|
|
941
|
+
capabilities: FiatAPI.KyxCapabilities;
|
|
942
|
+
|
|
943
|
+
endorsements: Array<FiatAPI.KyxEndorsement>;
|
|
944
|
+
|
|
945
|
+
/**
|
|
946
|
+
* KYB verification status in a KYB update event.
|
|
947
|
+
*/
|
|
948
|
+
kyb: OrganizationKYBUpdatedKYBData;
|
|
949
|
+
|
|
950
|
+
/**
|
|
951
|
+
* KYC/KYB status for the user.
|
|
952
|
+
*/
|
|
953
|
+
status: FiatAPI.KyxProviderStatus;
|
|
954
|
+
|
|
955
|
+
/**
|
|
956
|
+
* Terms of service status in a KYB update event.
|
|
957
|
+
*/
|
|
958
|
+
tos: OrganizationKYBUpdatedTosData;
|
|
959
|
+
}
|
|
960
|
+
|
|
961
|
+
/**
|
|
962
|
+
* KYB verification status in a KYB update event.
|
|
963
|
+
*/
|
|
964
|
+
export interface OrganizationKYBUpdatedKYBData {
|
|
965
|
+
/**
|
|
966
|
+
* Status of KYC/KYB verification. Passthrough from the provider.
|
|
967
|
+
*/
|
|
968
|
+
status: FiatAPI.KyxVerificationStatus;
|
|
969
|
+
}
|
|
970
|
+
|
|
971
|
+
/**
|
|
972
|
+
* Terms of service status in a KYB update event.
|
|
973
|
+
*/
|
|
974
|
+
export interface OrganizationKYBUpdatedTosData {
|
|
975
|
+
/**
|
|
976
|
+
* Status of Terms of Service acceptance. Passthrough from the provider.
|
|
977
|
+
*/
|
|
978
|
+
status: FiatAPI.KyxTosStatus;
|
|
979
|
+
}
|
|
980
|
+
|
|
803
981
|
/**
|
|
804
982
|
* Payload for the wallet.private_key_export webhook event.
|
|
805
983
|
*/
|
|
@@ -1127,6 +1305,67 @@ export interface TransactionStillPendingWebhookPayload {
|
|
|
1127
1305
|
reference_id?: string | null;
|
|
1128
1306
|
}
|
|
1129
1307
|
|
|
1308
|
+
/**
|
|
1309
|
+
* Payload for the usage.cross_chain_fee.recorded webhook event (Privy fee on a
|
|
1310
|
+
* cross-chain transfer or swap).
|
|
1311
|
+
*/
|
|
1312
|
+
export interface UsageCrossChainFeeRecordedWebhookPayload {
|
|
1313
|
+
amount_usd: string;
|
|
1314
|
+
|
|
1315
|
+
/**
|
|
1316
|
+
* An opaque, stable identifier for this charge. Use it to deduplicate webhook
|
|
1317
|
+
* deliveries.
|
|
1318
|
+
*/
|
|
1319
|
+
event_id: string;
|
|
1320
|
+
|
|
1321
|
+
recorded_at: number;
|
|
1322
|
+
|
|
1323
|
+
source_id: string;
|
|
1324
|
+
|
|
1325
|
+
/**
|
|
1326
|
+
* The type of operation that incurred a usage charge.
|
|
1327
|
+
*/
|
|
1328
|
+
source_type: UsageSourceType;
|
|
1329
|
+
|
|
1330
|
+
/**
|
|
1331
|
+
* The type of webhook event.
|
|
1332
|
+
*/
|
|
1333
|
+
type: 'usage.cross_chain_fee.recorded';
|
|
1334
|
+
}
|
|
1335
|
+
|
|
1336
|
+
/**
|
|
1337
|
+
* Payload for the usage.gas_sponsorship.recorded webhook event (sponsored network
|
|
1338
|
+
* gas).
|
|
1339
|
+
*/
|
|
1340
|
+
export interface UsageGasSponsorshipRecordedWebhookPayload {
|
|
1341
|
+
amount_usd: string;
|
|
1342
|
+
|
|
1343
|
+
/**
|
|
1344
|
+
* An opaque, stable identifier for this charge. Use it to deduplicate webhook
|
|
1345
|
+
* deliveries.
|
|
1346
|
+
*/
|
|
1347
|
+
event_id: string;
|
|
1348
|
+
|
|
1349
|
+
recorded_at: number;
|
|
1350
|
+
|
|
1351
|
+
source_id: string;
|
|
1352
|
+
|
|
1353
|
+
/**
|
|
1354
|
+
* The type of operation that incurred a usage charge.
|
|
1355
|
+
*/
|
|
1356
|
+
source_type: UsageSourceType;
|
|
1357
|
+
|
|
1358
|
+
/**
|
|
1359
|
+
* The type of webhook event.
|
|
1360
|
+
*/
|
|
1361
|
+
type: 'usage.gas_sponsorship.recorded';
|
|
1362
|
+
}
|
|
1363
|
+
|
|
1364
|
+
/**
|
|
1365
|
+
* The type of operation that incurred a usage charge.
|
|
1366
|
+
*/
|
|
1367
|
+
export type UsageSourceType = 'wallet-action-transfer' | 'wallet-action-swap' | 'rpc';
|
|
1368
|
+
|
|
1130
1369
|
/**
|
|
1131
1370
|
* Payload for the user.authenticated webhook event.
|
|
1132
1371
|
*/
|
|
@@ -1162,6 +1401,68 @@ export interface UserCreatedWebhookPayload {
|
|
|
1162
1401
|
user: UsersAPI.User;
|
|
1163
1402
|
}
|
|
1164
1403
|
|
|
1404
|
+
/**
|
|
1405
|
+
* Payload for the user.deleted webhook event.
|
|
1406
|
+
*/
|
|
1407
|
+
export interface UserDeletedWebhookPayload {
|
|
1408
|
+
/**
|
|
1409
|
+
* The type of webhook event.
|
|
1410
|
+
*/
|
|
1411
|
+
type: 'user.deleted';
|
|
1412
|
+
|
|
1413
|
+
/**
|
|
1414
|
+
* A Privy user object.
|
|
1415
|
+
*/
|
|
1416
|
+
user: UsersAPI.User;
|
|
1417
|
+
}
|
|
1418
|
+
|
|
1419
|
+
/**
|
|
1420
|
+
* Full KYC state snapshot in a KYC update event.
|
|
1421
|
+
*/
|
|
1422
|
+
export interface UserKYCUpdatedData {
|
|
1423
|
+
/**
|
|
1424
|
+
* Capability statuses for the customer.
|
|
1425
|
+
*/
|
|
1426
|
+
capabilities: FiatAPI.KyxCapabilities;
|
|
1427
|
+
|
|
1428
|
+
endorsements: Array<FiatAPI.KyxEndorsement>;
|
|
1429
|
+
|
|
1430
|
+
/**
|
|
1431
|
+
* KYC verification status in a KYC update event.
|
|
1432
|
+
*/
|
|
1433
|
+
kyc: UserKYCUpdatedKYCData;
|
|
1434
|
+
|
|
1435
|
+
/**
|
|
1436
|
+
* KYC/KYB status for the user.
|
|
1437
|
+
*/
|
|
1438
|
+
status: FiatAPI.KyxProviderStatus;
|
|
1439
|
+
|
|
1440
|
+
/**
|
|
1441
|
+
* Terms of service status in a KYC update event.
|
|
1442
|
+
*/
|
|
1443
|
+
tos: UserKYCUpdatedTosData;
|
|
1444
|
+
}
|
|
1445
|
+
|
|
1446
|
+
/**
|
|
1447
|
+
* KYC verification status in a KYC update event.
|
|
1448
|
+
*/
|
|
1449
|
+
export interface UserKYCUpdatedKYCData {
|
|
1450
|
+
/**
|
|
1451
|
+
* Status of KYC/KYB verification. Passthrough from the provider.
|
|
1452
|
+
*/
|
|
1453
|
+
status: FiatAPI.KyxVerificationStatus;
|
|
1454
|
+
}
|
|
1455
|
+
|
|
1456
|
+
/**
|
|
1457
|
+
* Terms of service status in a KYC update event.
|
|
1458
|
+
*/
|
|
1459
|
+
export interface UserKYCUpdatedTosData {
|
|
1460
|
+
/**
|
|
1461
|
+
* Status of Terms of Service acceptance. Passthrough from the provider.
|
|
1462
|
+
*/
|
|
1463
|
+
status: FiatAPI.KyxTosStatus;
|
|
1464
|
+
}
|
|
1465
|
+
|
|
1165
1466
|
/**
|
|
1166
1467
|
* Payload for the user.linked_account webhook event.
|
|
1167
1468
|
*/
|
|
@@ -1384,6 +1685,11 @@ export interface WalletActionEarnDepositCreatedWebhookPayload {
|
|
|
1384
1685
|
* present when the token is known in the asset registry.
|
|
1385
1686
|
*/
|
|
1386
1687
|
decimals?: number;
|
|
1688
|
+
|
|
1689
|
+
/**
|
|
1690
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
1691
|
+
*/
|
|
1692
|
+
reference_id?: string | null;
|
|
1387
1693
|
}
|
|
1388
1694
|
|
|
1389
1695
|
/**
|
|
@@ -1478,6 +1784,11 @@ export interface WalletActionEarnDepositFailedWebhookPayload {
|
|
|
1478
1784
|
* present when the token is known in the asset registry.
|
|
1479
1785
|
*/
|
|
1480
1786
|
decimals?: number;
|
|
1787
|
+
|
|
1788
|
+
/**
|
|
1789
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
1790
|
+
*/
|
|
1791
|
+
reference_id?: string | null;
|
|
1481
1792
|
}
|
|
1482
1793
|
|
|
1483
1794
|
/**
|
|
@@ -1571,6 +1882,11 @@ export interface WalletActionEarnDepositRejectedWebhookPayload {
|
|
|
1571
1882
|
* present when the token is known in the asset registry.
|
|
1572
1883
|
*/
|
|
1573
1884
|
decimals?: number;
|
|
1885
|
+
|
|
1886
|
+
/**
|
|
1887
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
1888
|
+
*/
|
|
1889
|
+
reference_id?: string | null;
|
|
1574
1890
|
}
|
|
1575
1891
|
|
|
1576
1892
|
/**
|
|
@@ -1664,6 +1980,11 @@ export interface WalletActionEarnDepositSucceededWebhookPayload {
|
|
|
1664
1980
|
* present when the token is known in the asset registry.
|
|
1665
1981
|
*/
|
|
1666
1982
|
decimals?: number;
|
|
1983
|
+
|
|
1984
|
+
/**
|
|
1985
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
1986
|
+
*/
|
|
1987
|
+
reference_id?: string | null;
|
|
1667
1988
|
}
|
|
1668
1989
|
|
|
1669
1990
|
/**
|
|
@@ -1742,6 +2063,11 @@ export interface WalletActionEarnFeeCollectCreatedWebhookPayload {
|
|
|
1742
2063
|
* present when the token is known in the asset registry.
|
|
1743
2064
|
*/
|
|
1744
2065
|
decimals?: number;
|
|
2066
|
+
|
|
2067
|
+
/**
|
|
2068
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
2069
|
+
*/
|
|
2070
|
+
reference_id?: string | null;
|
|
1745
2071
|
}
|
|
1746
2072
|
|
|
1747
2073
|
/**
|
|
@@ -1836,6 +2162,11 @@ export interface WalletActionEarnFeeCollectFailedWebhookPayload {
|
|
|
1836
2162
|
* present when the token is known in the asset registry.
|
|
1837
2163
|
*/
|
|
1838
2164
|
decimals?: number;
|
|
2165
|
+
|
|
2166
|
+
/**
|
|
2167
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
2168
|
+
*/
|
|
2169
|
+
reference_id?: string | null;
|
|
1839
2170
|
}
|
|
1840
2171
|
|
|
1841
2172
|
/**
|
|
@@ -1929,6 +2260,11 @@ export interface WalletActionEarnFeeCollectRejectedWebhookPayload {
|
|
|
1929
2260
|
* present when the token is known in the asset registry.
|
|
1930
2261
|
*/
|
|
1931
2262
|
decimals?: number;
|
|
2263
|
+
|
|
2264
|
+
/**
|
|
2265
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
2266
|
+
*/
|
|
2267
|
+
reference_id?: string | null;
|
|
1932
2268
|
}
|
|
1933
2269
|
|
|
1934
2270
|
/**
|
|
@@ -2017,6 +2353,11 @@ export interface WalletActionEarnFeeCollectSucceededWebhookPayload {
|
|
|
2017
2353
|
* present when the token is known in the asset registry.
|
|
2018
2354
|
*/
|
|
2019
2355
|
decimals?: number;
|
|
2356
|
+
|
|
2357
|
+
/**
|
|
2358
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
2359
|
+
*/
|
|
2360
|
+
reference_id?: string | null;
|
|
2020
2361
|
}
|
|
2021
2362
|
|
|
2022
2363
|
/**
|
|
@@ -2062,6 +2403,11 @@ export interface WalletActionEarnIncentiveClaimCreatedWebhookPayload {
|
|
|
2062
2403
|
* The ID of the wallet involved in the action.
|
|
2063
2404
|
*/
|
|
2064
2405
|
wallet_id: string;
|
|
2406
|
+
|
|
2407
|
+
/**
|
|
2408
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
2409
|
+
*/
|
|
2410
|
+
reference_id?: string | null;
|
|
2065
2411
|
}
|
|
2066
2412
|
|
|
2067
2413
|
/**
|
|
@@ -2123,6 +2469,11 @@ export interface WalletActionEarnIncentiveClaimFailedWebhookPayload {
|
|
|
2123
2469
|
* The ID of the wallet involved in the action.
|
|
2124
2470
|
*/
|
|
2125
2471
|
wallet_id: string;
|
|
2472
|
+
|
|
2473
|
+
/**
|
|
2474
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
2475
|
+
*/
|
|
2476
|
+
reference_id?: string | null;
|
|
2126
2477
|
}
|
|
2127
2478
|
|
|
2128
2479
|
/**
|
|
@@ -2183,6 +2534,11 @@ export interface WalletActionEarnIncentiveClaimRejectedWebhookPayload {
|
|
|
2183
2534
|
* The ID of the wallet involved in the action.
|
|
2184
2535
|
*/
|
|
2185
2536
|
wallet_id: string;
|
|
2537
|
+
|
|
2538
|
+
/**
|
|
2539
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
2540
|
+
*/
|
|
2541
|
+
reference_id?: string | null;
|
|
2186
2542
|
}
|
|
2187
2543
|
|
|
2188
2544
|
/**
|
|
@@ -2238,6 +2594,11 @@ export interface WalletActionEarnIncentiveClaimSucceededWebhookPayload {
|
|
|
2238
2594
|
* The ID of the wallet involved in the action.
|
|
2239
2595
|
*/
|
|
2240
2596
|
wallet_id: string;
|
|
2597
|
+
|
|
2598
|
+
/**
|
|
2599
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
2600
|
+
*/
|
|
2601
|
+
reference_id?: string | null;
|
|
2241
2602
|
}
|
|
2242
2603
|
|
|
2243
2604
|
/**
|
|
@@ -2316,6 +2677,11 @@ export interface WalletActionEarnWithdrawCreatedWebhookPayload {
|
|
|
2316
2677
|
* present when the token is known in the asset registry.
|
|
2317
2678
|
*/
|
|
2318
2679
|
decimals?: number;
|
|
2680
|
+
|
|
2681
|
+
/**
|
|
2682
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
2683
|
+
*/
|
|
2684
|
+
reference_id?: string | null;
|
|
2319
2685
|
}
|
|
2320
2686
|
|
|
2321
2687
|
/**
|
|
@@ -2410,6 +2776,11 @@ export interface WalletActionEarnWithdrawFailedWebhookPayload {
|
|
|
2410
2776
|
* present when the token is known in the asset registry.
|
|
2411
2777
|
*/
|
|
2412
2778
|
decimals?: number;
|
|
2779
|
+
|
|
2780
|
+
/**
|
|
2781
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
2782
|
+
*/
|
|
2783
|
+
reference_id?: string | null;
|
|
2413
2784
|
}
|
|
2414
2785
|
|
|
2415
2786
|
/**
|
|
@@ -2503,6 +2874,11 @@ export interface WalletActionEarnWithdrawRejectedWebhookPayload {
|
|
|
2503
2874
|
* present when the token is known in the asset registry.
|
|
2504
2875
|
*/
|
|
2505
2876
|
decimals?: number;
|
|
2877
|
+
|
|
2878
|
+
/**
|
|
2879
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
2880
|
+
*/
|
|
2881
|
+
reference_id?: string | null;
|
|
2506
2882
|
}
|
|
2507
2883
|
|
|
2508
2884
|
/**
|
|
@@ -2596,22 +2972,388 @@ export interface WalletActionEarnWithdrawSucceededWebhookPayload {
|
|
|
2596
2972
|
* present when the token is known in the asset registry.
|
|
2597
2973
|
*/
|
|
2598
2974
|
decimals?: number;
|
|
2975
|
+
|
|
2976
|
+
/**
|
|
2977
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
2978
|
+
*/
|
|
2979
|
+
reference_id?: string | null;
|
|
2599
2980
|
}
|
|
2600
2981
|
|
|
2601
2982
|
/**
|
|
2602
|
-
* Payload for the wallet_action.
|
|
2983
|
+
* Payload for the wallet_action.payout.created webhook event.
|
|
2603
2984
|
*/
|
|
2604
|
-
export interface
|
|
2985
|
+
export interface WalletActionPayoutCreatedWebhookPayload {
|
|
2605
2986
|
/**
|
|
2606
2987
|
* Type of wallet action
|
|
2607
2988
|
*/
|
|
2608
2989
|
action_type: ActionsAPI.WalletActionType;
|
|
2609
2990
|
|
|
2610
|
-
/**
|
|
2611
|
-
*
|
|
2612
|
-
*/
|
|
2613
|
-
|
|
2614
|
-
|
|
2991
|
+
/**
|
|
2992
|
+
* ISO 8601 timestamp of when the wallet action was created.
|
|
2993
|
+
*/
|
|
2994
|
+
created_at: string;
|
|
2995
|
+
|
|
2996
|
+
/**
|
|
2997
|
+
* The fiat currency the payout settles in (e.g. "usd").
|
|
2998
|
+
*/
|
|
2999
|
+
destination_currency: string;
|
|
3000
|
+
|
|
3001
|
+
/**
|
|
3002
|
+
* The registered external fiat account the payout settles to.
|
|
3003
|
+
*/
|
|
3004
|
+
destination_fiat_account_id: string;
|
|
3005
|
+
|
|
3006
|
+
/**
|
|
3007
|
+
* The fiat payment rail the payout settles over (e.g. "ach", "sepa", "wire").
|
|
3008
|
+
*/
|
|
3009
|
+
destination_payment_rail: string;
|
|
3010
|
+
|
|
3011
|
+
/**
|
|
3012
|
+
* The Privy API environment.
|
|
3013
|
+
*/
|
|
3014
|
+
environment: SharedAPI.IntegrationEnvironment;
|
|
3015
|
+
|
|
3016
|
+
/**
|
|
3017
|
+
* Supported fiat orchestration providers.
|
|
3018
|
+
*/
|
|
3019
|
+
provider: SharedAPI.OrchestrationProvider;
|
|
3020
|
+
|
|
3021
|
+
/**
|
|
3022
|
+
* Decimal amount offramped, in the asset's standard units (e.g. "100.00").
|
|
3023
|
+
*/
|
|
3024
|
+
source_amount: string;
|
|
3025
|
+
|
|
3026
|
+
/**
|
|
3027
|
+
* Source crypto asset sent on-chain (e.g. "usdc").
|
|
3028
|
+
*/
|
|
3029
|
+
source_asset: string;
|
|
3030
|
+
|
|
3031
|
+
/**
|
|
3032
|
+
* Source chain the crypto was sent from (e.g. "base").
|
|
3033
|
+
*/
|
|
3034
|
+
source_chain: string;
|
|
3035
|
+
|
|
3036
|
+
/**
|
|
3037
|
+
* The status of the wallet action.
|
|
3038
|
+
*/
|
|
3039
|
+
status: 'pending';
|
|
3040
|
+
|
|
3041
|
+
/**
|
|
3042
|
+
* The type of webhook event.
|
|
3043
|
+
*/
|
|
3044
|
+
type: 'wallet_action.payout.created';
|
|
3045
|
+
|
|
3046
|
+
/**
|
|
3047
|
+
* The ID of the wallet action.
|
|
3048
|
+
*/
|
|
3049
|
+
wallet_action_id: string;
|
|
3050
|
+
|
|
3051
|
+
/**
|
|
3052
|
+
* The ID of the wallet involved in the action.
|
|
3053
|
+
*/
|
|
3054
|
+
wallet_id: string;
|
|
3055
|
+
|
|
3056
|
+
/**
|
|
3057
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
3058
|
+
*/
|
|
3059
|
+
reference_id?: string | null;
|
|
3060
|
+
}
|
|
3061
|
+
|
|
3062
|
+
/**
|
|
3063
|
+
* Payload for the wallet_action.payout.failed webhook event.
|
|
3064
|
+
*/
|
|
3065
|
+
export interface WalletActionPayoutFailedWebhookPayload {
|
|
3066
|
+
/**
|
|
3067
|
+
* Type of wallet action
|
|
3068
|
+
*/
|
|
3069
|
+
action_type: ActionsAPI.WalletActionType;
|
|
3070
|
+
|
|
3071
|
+
/**
|
|
3072
|
+
* ISO 8601 timestamp of when the wallet action was created.
|
|
3073
|
+
*/
|
|
3074
|
+
created_at: string;
|
|
3075
|
+
|
|
3076
|
+
/**
|
|
3077
|
+
* The fiat currency the payout settles in (e.g. "usd").
|
|
3078
|
+
*/
|
|
3079
|
+
destination_currency: string;
|
|
3080
|
+
|
|
3081
|
+
/**
|
|
3082
|
+
* The registered external fiat account the payout settles to.
|
|
3083
|
+
*/
|
|
3084
|
+
destination_fiat_account_id: string;
|
|
3085
|
+
|
|
3086
|
+
/**
|
|
3087
|
+
* The fiat payment rail the payout settles over (e.g. "ach", "sepa", "wire").
|
|
3088
|
+
*/
|
|
3089
|
+
destination_payment_rail: string;
|
|
3090
|
+
|
|
3091
|
+
/**
|
|
3092
|
+
* The Privy API environment.
|
|
3093
|
+
*/
|
|
3094
|
+
environment: SharedAPI.IntegrationEnvironment;
|
|
3095
|
+
|
|
3096
|
+
/**
|
|
3097
|
+
* ISO 8601 timestamp of when the wallet action failed.
|
|
3098
|
+
*/
|
|
3099
|
+
failed_at: string;
|
|
3100
|
+
|
|
3101
|
+
/**
|
|
3102
|
+
* A description of why a wallet action (or a step within a wallet action) failed.
|
|
3103
|
+
*/
|
|
3104
|
+
failure_reason: ActionsAPI.FailureReason;
|
|
3105
|
+
|
|
3106
|
+
/**
|
|
3107
|
+
* Supported fiat orchestration providers.
|
|
3108
|
+
*/
|
|
3109
|
+
provider: SharedAPI.OrchestrationProvider;
|
|
3110
|
+
|
|
3111
|
+
/**
|
|
3112
|
+
* Decimal amount offramped, in the asset's standard units (e.g. "100.00").
|
|
3113
|
+
*/
|
|
3114
|
+
source_amount: string;
|
|
3115
|
+
|
|
3116
|
+
/**
|
|
3117
|
+
* Source crypto asset sent on-chain (e.g. "usdc").
|
|
3118
|
+
*/
|
|
3119
|
+
source_asset: string;
|
|
3120
|
+
|
|
3121
|
+
/**
|
|
3122
|
+
* Source chain the crypto was sent from (e.g. "base").
|
|
3123
|
+
*/
|
|
3124
|
+
source_chain: string;
|
|
3125
|
+
|
|
3126
|
+
/**
|
|
3127
|
+
* The status of the wallet action.
|
|
3128
|
+
*/
|
|
3129
|
+
status: 'failed';
|
|
3130
|
+
|
|
3131
|
+
/**
|
|
3132
|
+
* The steps of the wallet action. Completed steps will have transaction hashes;
|
|
3133
|
+
* the failing step will have a failure_reason.
|
|
3134
|
+
*/
|
|
3135
|
+
steps: Array<ActionsAPI.WalletActionStep>;
|
|
3136
|
+
|
|
3137
|
+
/**
|
|
3138
|
+
* The type of webhook event.
|
|
3139
|
+
*/
|
|
3140
|
+
type: 'wallet_action.payout.failed';
|
|
3141
|
+
|
|
3142
|
+
/**
|
|
3143
|
+
* The ID of the wallet action.
|
|
3144
|
+
*/
|
|
3145
|
+
wallet_action_id: string;
|
|
3146
|
+
|
|
3147
|
+
/**
|
|
3148
|
+
* The ID of the wallet involved in the action.
|
|
3149
|
+
*/
|
|
3150
|
+
wallet_id: string;
|
|
3151
|
+
|
|
3152
|
+
/**
|
|
3153
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
3154
|
+
*/
|
|
3155
|
+
reference_id?: string | null;
|
|
3156
|
+
}
|
|
3157
|
+
|
|
3158
|
+
/**
|
|
3159
|
+
* Payload for the wallet_action.payout.rejected webhook event.
|
|
3160
|
+
*/
|
|
3161
|
+
export interface WalletActionPayoutRejectedWebhookPayload {
|
|
3162
|
+
/**
|
|
3163
|
+
* Type of wallet action
|
|
3164
|
+
*/
|
|
3165
|
+
action_type: ActionsAPI.WalletActionType;
|
|
3166
|
+
|
|
3167
|
+
/**
|
|
3168
|
+
* ISO 8601 timestamp of when the wallet action was created.
|
|
3169
|
+
*/
|
|
3170
|
+
created_at: string;
|
|
3171
|
+
|
|
3172
|
+
/**
|
|
3173
|
+
* The fiat currency the payout settles in (e.g. "usd").
|
|
3174
|
+
*/
|
|
3175
|
+
destination_currency: string;
|
|
3176
|
+
|
|
3177
|
+
/**
|
|
3178
|
+
* The registered external fiat account the payout settles to.
|
|
3179
|
+
*/
|
|
3180
|
+
destination_fiat_account_id: string;
|
|
3181
|
+
|
|
3182
|
+
/**
|
|
3183
|
+
* The fiat payment rail the payout settles over (e.g. "ach", "sepa", "wire").
|
|
3184
|
+
*/
|
|
3185
|
+
destination_payment_rail: string;
|
|
3186
|
+
|
|
3187
|
+
/**
|
|
3188
|
+
* The Privy API environment.
|
|
3189
|
+
*/
|
|
3190
|
+
environment: SharedAPI.IntegrationEnvironment;
|
|
3191
|
+
|
|
3192
|
+
/**
|
|
3193
|
+
* A description of why a wallet action (or a step within a wallet action) failed.
|
|
3194
|
+
*/
|
|
3195
|
+
failure_reason: ActionsAPI.FailureReason;
|
|
3196
|
+
|
|
3197
|
+
/**
|
|
3198
|
+
* Supported fiat orchestration providers.
|
|
3199
|
+
*/
|
|
3200
|
+
provider: SharedAPI.OrchestrationProvider;
|
|
3201
|
+
|
|
3202
|
+
/**
|
|
3203
|
+
* ISO 8601 timestamp of when the wallet action was rejected.
|
|
3204
|
+
*/
|
|
3205
|
+
rejected_at: string;
|
|
3206
|
+
|
|
3207
|
+
/**
|
|
3208
|
+
* Decimal amount offramped, in the asset's standard units (e.g. "100.00").
|
|
3209
|
+
*/
|
|
3210
|
+
source_amount: string;
|
|
3211
|
+
|
|
3212
|
+
/**
|
|
3213
|
+
* Source crypto asset sent on-chain (e.g. "usdc").
|
|
3214
|
+
*/
|
|
3215
|
+
source_asset: string;
|
|
3216
|
+
|
|
3217
|
+
/**
|
|
3218
|
+
* Source chain the crypto was sent from (e.g. "base").
|
|
3219
|
+
*/
|
|
3220
|
+
source_chain: string;
|
|
3221
|
+
|
|
3222
|
+
/**
|
|
3223
|
+
* The status of the wallet action.
|
|
3224
|
+
*/
|
|
3225
|
+
status: 'rejected';
|
|
3226
|
+
|
|
3227
|
+
/**
|
|
3228
|
+
* The steps of the wallet action at the time of rejection.
|
|
3229
|
+
*/
|
|
3230
|
+
steps: Array<ActionsAPI.WalletActionStep>;
|
|
3231
|
+
|
|
3232
|
+
/**
|
|
3233
|
+
* The type of webhook event.
|
|
3234
|
+
*/
|
|
3235
|
+
type: 'wallet_action.payout.rejected';
|
|
3236
|
+
|
|
3237
|
+
/**
|
|
3238
|
+
* The ID of the wallet action.
|
|
3239
|
+
*/
|
|
3240
|
+
wallet_action_id: string;
|
|
3241
|
+
|
|
3242
|
+
/**
|
|
3243
|
+
* The ID of the wallet involved in the action.
|
|
3244
|
+
*/
|
|
3245
|
+
wallet_id: string;
|
|
3246
|
+
|
|
3247
|
+
/**
|
|
3248
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
3249
|
+
*/
|
|
3250
|
+
reference_id?: string | null;
|
|
3251
|
+
}
|
|
3252
|
+
|
|
3253
|
+
/**
|
|
3254
|
+
* Payload for the wallet_action.payout.succeeded webhook event.
|
|
3255
|
+
*/
|
|
3256
|
+
export interface WalletActionPayoutSucceededWebhookPayload {
|
|
3257
|
+
/**
|
|
3258
|
+
* Type of wallet action
|
|
3259
|
+
*/
|
|
3260
|
+
action_type: ActionsAPI.WalletActionType;
|
|
3261
|
+
|
|
3262
|
+
/**
|
|
3263
|
+
* ISO 8601 timestamp of when the wallet action completed successfully.
|
|
3264
|
+
*/
|
|
3265
|
+
completed_at: string;
|
|
3266
|
+
|
|
3267
|
+
/**
|
|
3268
|
+
* ISO 8601 timestamp of when the wallet action was created.
|
|
3269
|
+
*/
|
|
3270
|
+
created_at: string;
|
|
3271
|
+
|
|
3272
|
+
/**
|
|
3273
|
+
* The fiat currency the payout settles in (e.g. "usd").
|
|
3274
|
+
*/
|
|
3275
|
+
destination_currency: string;
|
|
3276
|
+
|
|
3277
|
+
/**
|
|
3278
|
+
* The registered external fiat account the payout settles to.
|
|
3279
|
+
*/
|
|
3280
|
+
destination_fiat_account_id: string;
|
|
3281
|
+
|
|
3282
|
+
/**
|
|
3283
|
+
* The fiat payment rail the payout settles over (e.g. "ach", "sepa", "wire").
|
|
3284
|
+
*/
|
|
3285
|
+
destination_payment_rail: string;
|
|
3286
|
+
|
|
3287
|
+
/**
|
|
3288
|
+
* The Privy API environment.
|
|
3289
|
+
*/
|
|
3290
|
+
environment: SharedAPI.IntegrationEnvironment;
|
|
3291
|
+
|
|
3292
|
+
/**
|
|
3293
|
+
* Supported fiat orchestration providers.
|
|
3294
|
+
*/
|
|
3295
|
+
provider: SharedAPI.OrchestrationProvider;
|
|
3296
|
+
|
|
3297
|
+
/**
|
|
3298
|
+
* Decimal amount offramped, in the asset's standard units (e.g. "100.00").
|
|
3299
|
+
*/
|
|
3300
|
+
source_amount: string;
|
|
3301
|
+
|
|
3302
|
+
/**
|
|
3303
|
+
* Source crypto asset sent on-chain (e.g. "usdc").
|
|
3304
|
+
*/
|
|
3305
|
+
source_asset: string;
|
|
3306
|
+
|
|
3307
|
+
/**
|
|
3308
|
+
* Source chain the crypto was sent from (e.g. "base").
|
|
3309
|
+
*/
|
|
3310
|
+
source_chain: string;
|
|
3311
|
+
|
|
3312
|
+
/**
|
|
3313
|
+
* The status of the wallet action.
|
|
3314
|
+
*/
|
|
3315
|
+
status: 'succeeded';
|
|
3316
|
+
|
|
3317
|
+
/**
|
|
3318
|
+
* The steps of the wallet action, including transaction hashes.
|
|
3319
|
+
*/
|
|
3320
|
+
steps: Array<ActionsAPI.WalletActionStep>;
|
|
3321
|
+
|
|
3322
|
+
/**
|
|
3323
|
+
* The type of webhook event.
|
|
3324
|
+
*/
|
|
3325
|
+
type: 'wallet_action.payout.succeeded';
|
|
3326
|
+
|
|
3327
|
+
/**
|
|
3328
|
+
* The ID of the wallet action.
|
|
3329
|
+
*/
|
|
3330
|
+
wallet_action_id: string;
|
|
3331
|
+
|
|
3332
|
+
/**
|
|
3333
|
+
* The ID of the wallet involved in the action.
|
|
3334
|
+
*/
|
|
3335
|
+
wallet_id: string;
|
|
3336
|
+
|
|
3337
|
+
/**
|
|
3338
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
3339
|
+
*/
|
|
3340
|
+
reference_id?: string | null;
|
|
3341
|
+
}
|
|
3342
|
+
|
|
3343
|
+
/**
|
|
3344
|
+
* Payload for the wallet_action.swap.created webhook event.
|
|
3345
|
+
*/
|
|
3346
|
+
export interface WalletActionSwapCreatedWebhookPayload {
|
|
3347
|
+
/**
|
|
3348
|
+
* Type of wallet action
|
|
3349
|
+
*/
|
|
3350
|
+
action_type: ActionsAPI.WalletActionType;
|
|
3351
|
+
|
|
3352
|
+
/**
|
|
3353
|
+
* Chain identifier.
|
|
3354
|
+
*/
|
|
3355
|
+
caip2: string;
|
|
3356
|
+
|
|
2615
3357
|
/**
|
|
2616
3358
|
* ISO 8601 timestamp of when the wallet action was created.
|
|
2617
3359
|
*/
|
|
@@ -2651,6 +3393,11 @@ export interface WalletActionSwapCreatedWebhookPayload {
|
|
|
2651
3393
|
* The ID of the wallet involved in the action.
|
|
2652
3394
|
*/
|
|
2653
3395
|
wallet_id: string;
|
|
3396
|
+
|
|
3397
|
+
/**
|
|
3398
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
3399
|
+
*/
|
|
3400
|
+
reference_id?: string | null;
|
|
2654
3401
|
}
|
|
2655
3402
|
|
|
2656
3403
|
/**
|
|
@@ -2722,6 +3469,11 @@ export interface WalletActionSwapFailedWebhookPayload {
|
|
|
2722
3469
|
* The ID of the wallet involved in the action.
|
|
2723
3470
|
*/
|
|
2724
3471
|
wallet_id: string;
|
|
3472
|
+
|
|
3473
|
+
/**
|
|
3474
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
3475
|
+
*/
|
|
3476
|
+
reference_id?: string | null;
|
|
2725
3477
|
}
|
|
2726
3478
|
|
|
2727
3479
|
/**
|
|
@@ -2792,6 +3544,11 @@ export interface WalletActionSwapRejectedWebhookPayload {
|
|
|
2792
3544
|
* The ID of the wallet involved in the action.
|
|
2793
3545
|
*/
|
|
2794
3546
|
wallet_id: string;
|
|
3547
|
+
|
|
3548
|
+
/**
|
|
3549
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
3550
|
+
*/
|
|
3551
|
+
reference_id?: string | null;
|
|
2795
3552
|
}
|
|
2796
3553
|
|
|
2797
3554
|
/**
|
|
@@ -2863,6 +3620,11 @@ export interface WalletActionSwapSucceededWebhookPayload {
|
|
|
2863
3620
|
* The ID of the wallet involved in the action.
|
|
2864
3621
|
*/
|
|
2865
3622
|
wallet_id: string;
|
|
3623
|
+
|
|
3624
|
+
/**
|
|
3625
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
3626
|
+
*/
|
|
3627
|
+
reference_id?: string | null;
|
|
2866
3628
|
}
|
|
2867
3629
|
|
|
2868
3630
|
/**
|
|
@@ -2909,6 +3671,11 @@ export interface WalletActionTransferCreatedWebhookPayload {
|
|
|
2909
3671
|
*/
|
|
2910
3672
|
wallet_id: string;
|
|
2911
3673
|
|
|
3674
|
+
/**
|
|
3675
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
3676
|
+
*/
|
|
3677
|
+
reference_id?: string | null;
|
|
3678
|
+
|
|
2912
3679
|
/**
|
|
2913
3680
|
* Decimal amount sent on the source chain (e.g. "1.5"). Omitted for exact_output
|
|
2914
3681
|
* cross-chain transfers until the source amount is determined.
|
|
@@ -2994,6 +3761,11 @@ export interface WalletActionTransferFailedWebhookPayload {
|
|
|
2994
3761
|
*/
|
|
2995
3762
|
wallet_id: string;
|
|
2996
3763
|
|
|
3764
|
+
/**
|
|
3765
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
3766
|
+
*/
|
|
3767
|
+
reference_id?: string | null;
|
|
3768
|
+
|
|
2997
3769
|
/**
|
|
2998
3770
|
* Decimal amount sent on the source chain (e.g. "1.5"). Omitted for exact_output
|
|
2999
3771
|
* cross-chain transfers until the source amount is determined.
|
|
@@ -3078,6 +3850,11 @@ export interface WalletActionTransferRejectedWebhookPayload {
|
|
|
3078
3850
|
*/
|
|
3079
3851
|
wallet_id: string;
|
|
3080
3852
|
|
|
3853
|
+
/**
|
|
3854
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
3855
|
+
*/
|
|
3856
|
+
reference_id?: string | null;
|
|
3857
|
+
|
|
3081
3858
|
/**
|
|
3082
3859
|
* Decimal amount sent on the source chain (e.g. "1.5"). Omitted for exact_output
|
|
3083
3860
|
* cross-chain transfers until the source amount is determined.
|
|
@@ -3157,6 +3934,11 @@ export interface WalletActionTransferSucceededWebhookPayload {
|
|
|
3157
3934
|
*/
|
|
3158
3935
|
wallet_id: string;
|
|
3159
3936
|
|
|
3937
|
+
/**
|
|
3938
|
+
* Developer-provided reference ID, if one was included in the request.
|
|
3939
|
+
*/
|
|
3940
|
+
reference_id?: string | null;
|
|
3941
|
+
|
|
3160
3942
|
/**
|
|
3161
3943
|
* Decimal amount sent on the source chain (e.g. "1.5"). Omitted for exact_output
|
|
3162
3944
|
* cross-chain transfers until the source amount is determined.
|
|
@@ -3212,6 +3994,52 @@ export interface WalletArchivedWebhookPayload {
|
|
|
3212
3994
|
wallet_id: string;
|
|
3213
3995
|
}
|
|
3214
3996
|
|
|
3997
|
+
/**
|
|
3998
|
+
* Payload for the wallet_automation.submitted webhook event.
|
|
3999
|
+
*/
|
|
4000
|
+
export interface WalletAutomationSubmittedWebhookPayload {
|
|
4001
|
+
/**
|
|
4002
|
+
* The ID of the wallet action created to fulfill the automation.
|
|
4003
|
+
*/
|
|
4004
|
+
action_id: string;
|
|
4005
|
+
|
|
4006
|
+
/**
|
|
4007
|
+
* The ID of the automation that fired.
|
|
4008
|
+
*/
|
|
4009
|
+
automation_id: string;
|
|
4010
|
+
|
|
4011
|
+
/**
|
|
4012
|
+
* ISO 8601 timestamp of when the automation was submitted.
|
|
4013
|
+
*/
|
|
4014
|
+
created_at: string;
|
|
4015
|
+
|
|
4016
|
+
/**
|
|
4017
|
+
* Contract address of the triggering deposit's asset, or 'native-token' for the
|
|
4018
|
+
* native asset.
|
|
4019
|
+
*/
|
|
4020
|
+
trigger_asset_address: string;
|
|
4021
|
+
|
|
4022
|
+
/**
|
|
4023
|
+
* CAIP-2 chain identifier of the triggering deposit (e.g., 'eip155:8453').
|
|
4024
|
+
*/
|
|
4025
|
+
trigger_caip2: string;
|
|
4026
|
+
|
|
4027
|
+
/**
|
|
4028
|
+
* The ID of the automation execution that fired.
|
|
4029
|
+
*/
|
|
4030
|
+
trigger_id: string;
|
|
4031
|
+
|
|
4032
|
+
/**
|
|
4033
|
+
* The type of webhook event.
|
|
4034
|
+
*/
|
|
4035
|
+
type: 'wallet_automation.submitted';
|
|
4036
|
+
|
|
4037
|
+
/**
|
|
4038
|
+
* The ID of the wallet the automation fired for.
|
|
4039
|
+
*/
|
|
4040
|
+
wallet_id: string;
|
|
4041
|
+
}
|
|
4042
|
+
|
|
3215
4043
|
/**
|
|
3216
4044
|
* An asset involved in a wallet transfer.
|
|
3217
4045
|
*/
|
|
@@ -3219,7 +4047,8 @@ export type WalletFundsAsset =
|
|
|
3219
4047
|
| WalletFundsNativeTokenAsset
|
|
3220
4048
|
| WalletFundsErc20Asset
|
|
3221
4049
|
| WalletFundsSplAsset
|
|
3222
|
-
| WalletFundsSacAsset
|
|
4050
|
+
| WalletFundsSacAsset
|
|
4051
|
+
| WalletFundsTrc20Asset;
|
|
3223
4052
|
|
|
3224
4053
|
/**
|
|
3225
4054
|
* An ERC-20 token asset.
|
|
@@ -3257,6 +4086,15 @@ export interface WalletFundsSplAsset {
|
|
|
3257
4086
|
type: 'spl';
|
|
3258
4087
|
}
|
|
3259
4088
|
|
|
4089
|
+
/**
|
|
4090
|
+
* A Tron TRC-20 token asset.
|
|
4091
|
+
*/
|
|
4092
|
+
export interface WalletFundsTrc20Asset {
|
|
4093
|
+
address: string;
|
|
4094
|
+
|
|
4095
|
+
type: 'trc20';
|
|
4096
|
+
}
|
|
4097
|
+
|
|
3260
4098
|
/**
|
|
3261
4099
|
* Payload for the wallet.recovered webhook event.
|
|
3262
4100
|
*/
|
|
@@ -3353,6 +4191,7 @@ export interface WalletRestoredWebhookPayload {
|
|
|
3353
4191
|
*/
|
|
3354
4192
|
export type WebhookPayload =
|
|
3355
4193
|
| UserCreatedWebhookPayload
|
|
4194
|
+
| UserDeletedWebhookPayload
|
|
3356
4195
|
| UserAuthenticatedWebhookPayload
|
|
3357
4196
|
| UserLinkedAccountWebhookPayload
|
|
3358
4197
|
| UserUnlinkedAccountWebhookPayload
|
|
@@ -3380,6 +4219,8 @@ export type WebhookPayload =
|
|
|
3380
4219
|
| YieldWithdrawConfirmedWebhookPayload
|
|
3381
4220
|
| YieldClaimConfirmedWebhookPayload
|
|
3382
4221
|
| UserOperationCompletedWebhookPayload
|
|
4222
|
+
| UsageGasSponsorshipRecordedWebhookPayload
|
|
4223
|
+
| UsageCrossChainFeeRecordedWebhookPayload
|
|
3383
4224
|
| IntentCreatedWebhookPayload
|
|
3384
4225
|
| IntentAuthorizedWebhookPayload
|
|
3385
4226
|
| IntentRejectedWebhookPayload
|
|
@@ -3408,7 +4249,12 @@ export type WebhookPayload =
|
|
|
3408
4249
|
| WalletActionEarnFeeCollectCreatedWebhookPayload
|
|
3409
4250
|
| WalletActionEarnFeeCollectSucceededWebhookPayload
|
|
3410
4251
|
| WalletActionEarnFeeCollectRejectedWebhookPayload
|
|
3411
|
-
| WalletActionEarnFeeCollectFailedWebhookPayload
|
|
4252
|
+
| WalletActionEarnFeeCollectFailedWebhookPayload
|
|
4253
|
+
| WalletActionPayoutCreatedWebhookPayload
|
|
4254
|
+
| WalletActionPayoutSucceededWebhookPayload
|
|
4255
|
+
| WalletActionPayoutRejectedWebhookPayload
|
|
4256
|
+
| WalletActionPayoutFailedWebhookPayload
|
|
4257
|
+
| WalletAutomationSubmittedWebhookPayload;
|
|
3412
4258
|
|
|
3413
4259
|
/**
|
|
3414
4260
|
* Payload for the yield.claim.confirmed webhook event.
|
|
@@ -3496,6 +4342,13 @@ export declare namespace Webhooks {
|
|
|
3496
4342
|
type BridgeRefundMetadata as BridgeRefundMetadata,
|
|
3497
4343
|
type BridgeStaticMemoDepositMetadata as BridgeStaticMemoDepositMetadata,
|
|
3498
4344
|
type BridgeTransferRefundMetadata as BridgeTransferRefundMetadata,
|
|
4345
|
+
type DepositCompletedData as DepositCompletedData,
|
|
4346
|
+
type DepositCompletedDestination as DepositCompletedDestination,
|
|
4347
|
+
type DepositFailedData as DepositFailedData,
|
|
4348
|
+
type DepositStartedData as DepositStartedData,
|
|
4349
|
+
type DepositStartedDestination as DepositStartedDestination,
|
|
4350
|
+
type DepositStartedSource as DepositStartedSource,
|
|
4351
|
+
type FiatDepositCurrency as FiatDepositCurrency,
|
|
3499
4352
|
type FundsDepositedWebhookPayload as FundsDepositedWebhookPayload,
|
|
3500
4353
|
type FundsWithdrawnWebhookPayload as FundsWithdrawnWebhookPayload,
|
|
3501
4354
|
type IntentAuthorizedWebhookPayload as IntentAuthorizedWebhookPayload,
|
|
@@ -3514,6 +4367,9 @@ export declare namespace Webhooks {
|
|
|
3514
4367
|
type KrakenEmbedUserVerifiedWebhookPayload as KrakenEmbedUserVerifiedWebhookPayload,
|
|
3515
4368
|
type MfaDisabledWebhookPayload as MfaDisabledWebhookPayload,
|
|
3516
4369
|
type MfaEnabledWebhookPayload as MfaEnabledWebhookPayload,
|
|
4370
|
+
type OrganizationKYBUpdatedData as OrganizationKYBUpdatedData,
|
|
4371
|
+
type OrganizationKYBUpdatedKYBData as OrganizationKYBUpdatedKYBData,
|
|
4372
|
+
type OrganizationKYBUpdatedTosData as OrganizationKYBUpdatedTosData,
|
|
3517
4373
|
type PrivateKeyExportWebhookPayload as PrivateKeyExportWebhookPayload,
|
|
3518
4374
|
type SeedPhraseExportWebhookPayload as SeedPhraseExportWebhookPayload,
|
|
3519
4375
|
type TransactionBroadcastedWebhookPayload as TransactionBroadcastedWebhookPayload,
|
|
@@ -3523,8 +4379,15 @@ export declare namespace Webhooks {
|
|
|
3523
4379
|
type TransactionProviderErrorWebhookPayload as TransactionProviderErrorWebhookPayload,
|
|
3524
4380
|
type TransactionReplacedWebhookPayload as TransactionReplacedWebhookPayload,
|
|
3525
4381
|
type TransactionStillPendingWebhookPayload as TransactionStillPendingWebhookPayload,
|
|
4382
|
+
type UsageCrossChainFeeRecordedWebhookPayload as UsageCrossChainFeeRecordedWebhookPayload,
|
|
4383
|
+
type UsageGasSponsorshipRecordedWebhookPayload as UsageGasSponsorshipRecordedWebhookPayload,
|
|
4384
|
+
type UsageSourceType as UsageSourceType,
|
|
3526
4385
|
type UserAuthenticatedWebhookPayload as UserAuthenticatedWebhookPayload,
|
|
3527
4386
|
type UserCreatedWebhookPayload as UserCreatedWebhookPayload,
|
|
4387
|
+
type UserDeletedWebhookPayload as UserDeletedWebhookPayload,
|
|
4388
|
+
type UserKYCUpdatedData as UserKYCUpdatedData,
|
|
4389
|
+
type UserKYCUpdatedKYCData as UserKYCUpdatedKYCData,
|
|
4390
|
+
type UserKYCUpdatedTosData as UserKYCUpdatedTosData,
|
|
3528
4391
|
type UserLinkedAccountWebhookPayload as UserLinkedAccountWebhookPayload,
|
|
3529
4392
|
type UserOperationCompletedWebhookPayload as UserOperationCompletedWebhookPayload,
|
|
3530
4393
|
type UserReference as UserReference,
|
|
@@ -3548,6 +4411,10 @@ export declare namespace Webhooks {
|
|
|
3548
4411
|
type WalletActionEarnWithdrawFailedWebhookPayload as WalletActionEarnWithdrawFailedWebhookPayload,
|
|
3549
4412
|
type WalletActionEarnWithdrawRejectedWebhookPayload as WalletActionEarnWithdrawRejectedWebhookPayload,
|
|
3550
4413
|
type WalletActionEarnWithdrawSucceededWebhookPayload as WalletActionEarnWithdrawSucceededWebhookPayload,
|
|
4414
|
+
type WalletActionPayoutCreatedWebhookPayload as WalletActionPayoutCreatedWebhookPayload,
|
|
4415
|
+
type WalletActionPayoutFailedWebhookPayload as WalletActionPayoutFailedWebhookPayload,
|
|
4416
|
+
type WalletActionPayoutRejectedWebhookPayload as WalletActionPayoutRejectedWebhookPayload,
|
|
4417
|
+
type WalletActionPayoutSucceededWebhookPayload as WalletActionPayoutSucceededWebhookPayload,
|
|
3551
4418
|
type WalletActionSwapCreatedWebhookPayload as WalletActionSwapCreatedWebhookPayload,
|
|
3552
4419
|
type WalletActionSwapFailedWebhookPayload as WalletActionSwapFailedWebhookPayload,
|
|
3553
4420
|
type WalletActionSwapRejectedWebhookPayload as WalletActionSwapRejectedWebhookPayload,
|
|
@@ -3557,11 +4424,13 @@ export declare namespace Webhooks {
|
|
|
3557
4424
|
type WalletActionTransferRejectedWebhookPayload as WalletActionTransferRejectedWebhookPayload,
|
|
3558
4425
|
type WalletActionTransferSucceededWebhookPayload as WalletActionTransferSucceededWebhookPayload,
|
|
3559
4426
|
type WalletArchivedWebhookPayload as WalletArchivedWebhookPayload,
|
|
4427
|
+
type WalletAutomationSubmittedWebhookPayload as WalletAutomationSubmittedWebhookPayload,
|
|
3560
4428
|
type WalletFundsAsset as WalletFundsAsset,
|
|
3561
4429
|
type WalletFundsErc20Asset as WalletFundsErc20Asset,
|
|
3562
4430
|
type WalletFundsNativeTokenAsset as WalletFundsNativeTokenAsset,
|
|
3563
4431
|
type WalletFundsSacAsset as WalletFundsSacAsset,
|
|
3564
4432
|
type WalletFundsSplAsset as WalletFundsSplAsset,
|
|
4433
|
+
type WalletFundsTrc20Asset as WalletFundsTrc20Asset,
|
|
3565
4434
|
type WalletRecoveredWebhookPayload as WalletRecoveredWebhookPayload,
|
|
3566
4435
|
type WalletRecoverySetupMethod as WalletRecoverySetupMethod,
|
|
3567
4436
|
type WalletRecoverySetupWebhookPayload as WalletRecoverySetupWebhookPayload,
|