@privy-io/api-types 0.22.0 → 0.23.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.
Files changed (65) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/client.d.mts +6 -6
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +6 -6
  5. package/client.d.ts.map +1 -1
  6. package/client.js.map +1 -1
  7. package/client.mjs.map +1 -1
  8. package/package.json +1 -1
  9. package/resources/accounts.d.mts +0 -8
  10. package/resources/accounts.d.mts.map +1 -1
  11. package/resources/accounts.d.ts +0 -8
  12. package/resources/accounts.d.ts.map +1 -1
  13. package/resources/cards.d.mts +4 -0
  14. package/resources/cards.d.mts.map +1 -1
  15. package/resources/cards.d.ts +4 -0
  16. package/resources/cards.d.ts.map +1 -1
  17. package/resources/fiat.d.mts +525 -61
  18. package/resources/fiat.d.mts.map +1 -1
  19. package/resources/fiat.d.ts +525 -61
  20. package/resources/fiat.d.ts.map +1 -1
  21. package/resources/index.d.mts +3 -3
  22. package/resources/index.d.mts.map +1 -1
  23. package/resources/index.d.ts +3 -3
  24. package/resources/index.d.ts.map +1 -1
  25. package/resources/index.js.map +1 -1
  26. package/resources/index.mjs.map +1 -1
  27. package/resources/wallet-automations.d.mts +10 -8
  28. package/resources/wallet-automations.d.mts.map +1 -1
  29. package/resources/wallet-automations.d.ts +10 -8
  30. package/resources/wallet-automations.d.ts.map +1 -1
  31. package/resources/wallets/actions.d.mts +7 -0
  32. package/resources/wallets/actions.d.mts.map +1 -1
  33. package/resources/wallets/actions.d.ts +7 -0
  34. package/resources/wallets/actions.d.ts.map +1 -1
  35. package/resources/wallets/index.d.mts +1 -1
  36. package/resources/wallets/index.d.mts.map +1 -1
  37. package/resources/wallets/index.d.ts +1 -1
  38. package/resources/wallets/index.d.ts.map +1 -1
  39. package/resources/wallets/index.js.map +1 -1
  40. package/resources/wallets/index.mjs.map +1 -1
  41. package/resources/wallets/wallets.d.mts +228 -9
  42. package/resources/wallets/wallets.d.mts.map +1 -1
  43. package/resources/wallets/wallets.d.ts +228 -9
  44. package/resources/wallets/wallets.d.ts.map +1 -1
  45. package/resources/wallets/wallets.js.map +1 -1
  46. package/resources/wallets/wallets.mjs.map +1 -1
  47. package/resources/webhooks.d.mts +14 -14
  48. package/resources/webhooks.d.mts.map +1 -1
  49. package/resources/webhooks.d.ts +14 -14
  50. package/resources/webhooks.d.ts.map +1 -1
  51. package/src/client.ts +64 -6
  52. package/src/resources/accounts.ts +0 -10
  53. package/src/resources/cards.ts +5 -0
  54. package/src/resources/fiat.ts +637 -63
  55. package/src/resources/index.ts +32 -3
  56. package/src/resources/wallet-automations.ts +11 -9
  57. package/src/resources/wallets/actions.ts +8 -0
  58. package/src/resources/wallets/index.ts +14 -0
  59. package/src/resources/wallets/wallets.ts +287 -10
  60. package/src/resources/webhooks.ts +15 -15
  61. package/src/version.ts +1 -1
  62. package/version.d.mts +1 -1
  63. package/version.d.ts +1 -1
  64. package/version.js +1 -1
  65. package/version.mjs +1 -1
@@ -343,13 +343,26 @@ export {
343
343
  type FiatDepositAccountStatus,
344
344
  type FiatDepositInstructions,
345
345
  type FiatPaymentRail,
346
+ type KYBAccountPurpose,
347
+ type KYBAssociatedPerson,
348
+ type KYBBusinessDocument,
349
+ type KYBBusinessType,
350
+ type KYBDocumentPurpose,
351
+ type KYBEstimatedAnnualRevenue,
352
+ type KYBHighRiskActivity,
353
+ type KYBIndividualDocument,
354
+ type KYBIndividualDocumentPurpose,
346
355
  type KYBLinksRequestBody,
356
+ type KYBPlaceOfBirth,
357
+ type KYBPubliclyTradedListing,
358
+ type KYBRegulatedActivity,
359
+ type KYBSourceOfFunds,
347
360
  type KYBStatusListResponse,
348
361
  type KYBStatusResponse,
362
+ type KYBSubmitData,
363
+ type KYBSubmitRequestBody,
349
364
  type KYBTosRequestBody,
350
- type KYCIdentifyingDocument,
351
365
  type KYCLinksRequestBody,
352
- type KYCResidentialAddress,
353
366
  type KYCStatusListResponse,
354
367
  type KYCStatusResponse,
355
368
  type KYCSubmitData,
@@ -384,6 +397,8 @@ export {
384
397
  type OrganizationExternalFiatAccountResponse,
385
398
  type PayoutDestination,
386
399
  type PayoutSource,
400
+ type VerificationAddress,
401
+ type VerificationDocument,
387
402
  } from './fiat';
388
403
  export {
389
404
  Funding,
@@ -865,6 +880,7 @@ export {
865
880
  type CryptoDepositAccountSourceChain,
866
881
  type CryptoDepositAccountSourceCurrency,
867
882
  type CryptoDepositAddressRoute,
883
+ type CryptoDepositAddressStrategy,
868
884
  type CryptoDepositAsset,
869
885
  type CryptoDepositAssetFilter,
870
886
  type CryptoDepositAssetFilterAll,
@@ -878,6 +894,10 @@ export {
878
894
  type CustodialWalletCreateInput,
879
895
  type CustodialWalletProvider,
880
896
  type CustomTokenTransferSource,
897
+ type DepositAccountCryptoQuoteAmount,
898
+ type DepositAccountCryptoQuoteAsset,
899
+ type DepositAccountCryptoQuoteRequestBody,
900
+ type DepositAccountCryptoQuoteResponse,
881
901
  type DetachWalletAutomationRequestBody,
882
902
  type DeveloperFee,
883
903
  type EncryptedAuthorizationKey,
@@ -1060,10 +1080,19 @@ export {
1060
1080
  type TransactionChainNameInput,
1061
1081
  type TransactionDetail,
1062
1082
  type TransactionTokenAddressInput,
1083
+ type TransferCustodyOptions,
1084
+ type TransferInitiation,
1085
+ type TransferInitiationAttestations,
1086
+ type TransferInitiationChannel,
1087
+ type TransferInitiationSubchannel,
1063
1088
  type TransferQuoteRequestBody,
1064
1089
  type TransferQuoteResponse,
1065
1090
  type TransferReceivedTransactionDetail,
1066
1091
  type TransferRequestBody,
1092
+ type TransferScaAttestation,
1093
+ type TransferScaAuthFactor,
1094
+ type TransferScaAuthFactorCategory,
1095
+ type TransferScaOutcome,
1067
1096
  type TransferSentTransactionDetail,
1068
1097
  type TronContract,
1069
1098
  type TronRawDataForSend,
@@ -1192,9 +1221,9 @@ export {
1192
1221
  type TransactionProviderErrorWebhookPayload,
1193
1222
  type TransactionReplacedWebhookPayload,
1194
1223
  type TransactionStillPendingWebhookPayload,
1195
- type UsageCrossChainFeeRecordedWebhookPayload,
1196
1224
  type UsageGasSponsorshipRecordedWebhookPayload,
1197
1225
  type UsageSourceType,
1226
+ type UsageSwapProviderFeeRecordedWebhookPayload,
1198
1227
  type UserAuthenticatedWebhookPayload,
1199
1228
  type UserCreatedWebhookPayload,
1200
1229
  type UserDeletedWebhookPayload,
@@ -300,7 +300,7 @@ export interface WalletAutomationExecutionListResponse {
300
300
  }
301
301
 
302
302
  /**
303
- * A record of a single automation execution triggered by a deposit.
303
+ * A record of a single automation execution created by a deposit.
304
304
  */
305
305
  export interface WalletAutomationExecutionResponse {
306
306
  id: string;
@@ -320,6 +320,8 @@ export interface WalletAutomationExecutionResponse {
320
320
  */
321
321
  status: WalletAutomationExecutionStatus;
322
322
 
323
+ submitted_at: string | null;
324
+
323
325
  trigger_asset_address: string;
324
326
 
325
327
  trigger_block_number: string;
@@ -328,8 +330,6 @@ export interface WalletAutomationExecutionResponse {
328
330
 
329
331
  trigger_tx_hash: string;
330
332
 
331
- triggered_at: string | null;
332
-
333
333
  updated_at: string;
334
334
 
335
335
  wallet_action_id: string | null;
@@ -340,7 +340,7 @@ export interface WalletAutomationExecutionResponse {
340
340
  /**
341
341
  * Execution lifecycle status.
342
342
  */
343
- export type WalletAutomationExecutionStatus = 'pending' | 'triggered' | 'completed' | 'failed' | 'skipped';
343
+ export type WalletAutomationExecutionStatus = 'pending' | 'submitted' | 'completed' | 'failed' | 'skipped';
344
344
 
345
345
  /**
346
346
  * Paginated list of wallet automations.
@@ -373,23 +373,25 @@ export interface WalletAutomationReindexAssetResult {
373
373
  existing_execution_id: string | null;
374
374
 
375
375
  /**
376
- * On-chain balance in base units. Populated when `status` is `triggered` or
376
+ * On-chain balance in base units. Populated when `status` is `submitted` or
377
377
  * `skipped_zero_balance`; `null` otherwise. For example, 1 OUSD is `1000000`.
378
378
  */
379
379
  raw_balance: string | null;
380
380
 
381
381
  /**
382
382
  * Outcome of checking a single asset during a wallet automation reindex. One of
383
- * `triggered`, `skipped_zero_balance`, `skipped_no_match`,
384
- * `skipped_existing_execution`, or `failed`.
383
+ * `submitted`, `skipped_zero_balance`, `skipped_no_match`,
384
+ * `skipped_existing_execution`, or `failed`. `submitted` confirms that an
385
+ * execution was enqueued.
385
386
  */
386
387
  status: WalletAutomationReindexAssetStatus;
387
388
  }
388
389
 
389
390
  /**
390
391
  * Outcome of checking a single asset during a wallet automation reindex. One of
391
- * `triggered`, `skipped_zero_balance`, `skipped_no_match`,
392
- * `skipped_existing_execution`, or `failed`.
392
+ * `submitted`, `skipped_zero_balance`, `skipped_no_match`,
393
+ * `skipped_existing_execution`, or `failed`. `submitted` confirms that an
394
+ * execution was enqueued.
393
395
  */
394
396
  export type WalletAutomationReindexAssetStatus = string;
395
397
 
@@ -91,6 +91,14 @@ export interface CustodianTransactionWalletActionStep {
91
91
  */
92
92
  status: CustodianTransactionWalletActionStepStatus;
93
93
 
94
+ /**
95
+ * Identifier of the transaction the custodian last reported on the destination
96
+ * chain. Set on a settled transfer, and also on a failed one when the custodian
97
+ * had already broadcast a payout that was later returned. Null until the custodian
98
+ * reports one.
99
+ */
100
+ transaction_hash: string | null;
101
+
94
102
  type: 'custodian_transaction';
95
103
 
96
104
  /**
@@ -85,6 +85,7 @@ export {
85
85
  type CryptoDepositAccountSourceChain,
86
86
  type CryptoDepositAccountSourceCurrency,
87
87
  type CryptoDepositAddressRoute,
88
+ type CryptoDepositAddressStrategy,
88
89
  type CryptoDepositAsset,
89
90
  type CryptoDepositAssetFilter,
90
91
  type CryptoDepositAssetFilterAll,
@@ -98,6 +99,10 @@ export {
98
99
  type CustodialWalletCreateInput,
99
100
  type CustodialWalletProvider,
100
101
  type CustomTokenTransferSource,
102
+ type DepositAccountCryptoQuoteAmount,
103
+ type DepositAccountCryptoQuoteAsset,
104
+ type DepositAccountCryptoQuoteRequestBody,
105
+ type DepositAccountCryptoQuoteResponse,
101
106
  type DetachWalletAutomationRequestBody,
102
107
  type DeveloperFee,
103
108
  type EncryptedAuthorizationKey,
@@ -280,10 +285,19 @@ export {
280
285
  type TransactionChainNameInput,
281
286
  type TransactionDetail,
282
287
  type TransactionTokenAddressInput,
288
+ type TransferCustodyOptions,
289
+ type TransferInitiation,
290
+ type TransferInitiationAttestations,
291
+ type TransferInitiationChannel,
292
+ type TransferInitiationSubchannel,
283
293
  type TransferQuoteRequestBody,
284
294
  type TransferQuoteResponse,
285
295
  type TransferReceivedTransactionDetail,
286
296
  type TransferRequestBody,
297
+ type TransferScaAttestation,
298
+ type TransferScaAuthFactor,
299
+ type TransferScaAuthFactorCategory,
300
+ type TransferScaOutcome,
287
301
  type TransferSentTransactionDetail,
288
302
  type TronContract,
289
303
  type TronRawDataForSend,
@@ -649,6 +649,12 @@ export interface CreateCryptoDepositAccountWithConfigRequestBody {
649
649
  deposit_config_id: string;
650
650
 
651
651
  type: 'deposit_config';
652
+
653
+ /**
654
+ * How deposit source wallets are chosen. Omission uses `dedicated`. Destination
655
+ * reuse applies only to the destination's own chain type.
656
+ */
657
+ deposit_address_strategy?: CryptoDepositAddressStrategy;
652
658
  }
653
659
 
654
660
  /**
@@ -668,6 +674,12 @@ export interface CreateCryptoDepositAccountWithRouteRequestBody {
668
674
  source: CryptoDepositAssetFilter;
669
675
 
670
676
  type: 'inline_route';
677
+
678
+ /**
679
+ * How deposit source wallets are chosen. Omission uses `dedicated`. Destination
680
+ * reuse applies only to the destination's own chain type.
681
+ */
682
+ deposit_address_strategy?: CryptoDepositAddressStrategy;
671
683
  }
672
684
 
673
685
  /**
@@ -773,6 +785,12 @@ export interface CryptoDepositAddressRoute {
773
785
  wallet_id: string;
774
786
  }
775
787
 
788
+ /**
789
+ * How deposit source wallets are chosen. Omission uses `dedicated`. Destination
790
+ * reuse applies only to the destination's own chain type.
791
+ */
792
+ export type CryptoDepositAddressStrategy = 'dedicated' | 'prefer_destination' | 'require_destination';
793
+
776
794
  /**
777
795
  * An asset on a chain. Uses a human-readable alias (usdc, tempo) when one is on
778
796
  * file, otherwise the raw asset address and CAIP-2.
@@ -898,6 +916,11 @@ export type CustodialWalletChainType = 'ethereum' | 'solana';
898
916
  * The input for creating a custodial wallet.
899
917
  */
900
918
  export interface CustodialWalletCreateInput {
919
+ /**
920
+ * The chain of the custodial wallet.
921
+ */
922
+ chain: CustodialWalletChain;
923
+
901
924
  /**
902
925
  * The provider of the custodial wallet.
903
926
  */
@@ -914,16 +937,6 @@ export interface CustodialWalletCreateInput {
914
937
  */
915
938
  additional_signers?: AdditionalSignerInput;
916
939
 
917
- /**
918
- * The chain of the custodial wallet.
919
- */
920
- chain?: CustodialWalletChain;
921
-
922
- /**
923
- * @deprecated The chain type of the custodial wallet (deprecated).
924
- */
925
- chain_type?: CustodialWalletChainType;
926
-
927
940
  /**
928
941
  * The owner of the resource, specified as a Privy user ID, a P-256 public key, or
929
942
  * null to remove the current owner.
@@ -968,6 +981,73 @@ export interface CustomTokenTransferSource {
968
981
  amount?: string;
969
982
  }
970
983
 
984
+ /**
985
+ * A positive decimal amount in the source token’s standard unit, not its smallest
986
+ * on-chain unit.
987
+ */
988
+ export type DepositAccountCryptoQuoteAmount = string;
989
+
990
+ /**
991
+ * An asset and chain for an indicative crypto deposit-account quote.
992
+ */
993
+ export interface DepositAccountCryptoQuoteAsset {
994
+ /**
995
+ * Named asset ID (e.g. "usdc", "eth") or chain-specific token contract or mint
996
+ * address
997
+ */
998
+ asset: string;
999
+
1000
+ /**
1001
+ * Friendly chain name or CAIP-2 identifier (e.g. "base", "eip155:8453")
1002
+ */
1003
+ chain: string;
1004
+ }
1005
+
1006
+ /**
1007
+ * Request body for an indicative crypto deposit-account route quote.
1008
+ */
1009
+ export interface DepositAccountCryptoQuoteRequestBody {
1010
+ /**
1011
+ * An asset and chain for an indicative crypto deposit-account quote.
1012
+ */
1013
+ destination: DepositAccountCryptoQuoteAsset;
1014
+
1015
+ /**
1016
+ * An asset and chain for an indicative crypto deposit-account quote.
1017
+ */
1018
+ source: DepositAccountCryptoQuoteAsset;
1019
+
1020
+ /**
1021
+ * A positive decimal amount in the source token’s standard unit, not its smallest
1022
+ * on-chain unit.
1023
+ */
1024
+ input_amount?: DepositAccountCryptoQuoteAmount;
1025
+
1026
+ /**
1027
+ * Value in basis points: integer from 0 to 10000 (0% to 100%).
1028
+ */
1029
+ slippage_bps?: SharedAPI.Bps;
1030
+ }
1031
+
1032
+ /**
1033
+ * An indicative crypto deposit-account quote. Amounts are in token standard units.
1034
+ */
1035
+ export interface DepositAccountCryptoQuoteResponse {
1036
+ created_at: string;
1037
+
1038
+ /**
1039
+ * Estimated output amount as a decimal string in the destination token's standard
1040
+ * unit. Not in the smallest on-chain unit.
1041
+ */
1042
+ estimated_output_amount: string;
1043
+
1044
+ /**
1045
+ * Quoted input amount as a decimal string in the source token's standard unit
1046
+ * (e.g. "0.02" for 0.02 ETH). Not in the smallest on-chain unit.
1047
+ */
1048
+ input_amount: string;
1049
+ }
1050
+
971
1051
  /**
972
1052
  * Request body for detaching automations from a wallet (wallet ID comes from the
973
1053
  * URL).
@@ -3602,6 +3682,78 @@ export type TransactionDetail = TransferSentTransactionDetail | TransferReceived
3602
3682
  */
3603
3683
  export type TransactionTokenAddressInput = string;
3604
3684
 
3685
+ /**
3686
+ * Options for a transfer from a custodial wallet.
3687
+ */
3688
+ export interface TransferCustodyOptions {
3689
+ /**
3690
+ * Payment initiation context for transfers sourced from wallets that require
3691
+ * initiation data. Captures how the payment was initiated (channel and subchannel)
3692
+ * and whether Strong Customer Authentication was applied or which SCA exemption
3693
+ * was used.
3694
+ */
3695
+ initiation: TransferInitiation;
3696
+ }
3697
+
3698
+ /**
3699
+ * Payment initiation context for transfers sourced from wallets that require
3700
+ * initiation data. Captures how the payment was initiated (channel and subchannel)
3701
+ * and whether Strong Customer Authentication was applied or which SCA exemption
3702
+ * was used.
3703
+ */
3704
+ export interface TransferInitiation {
3705
+ /**
3706
+ * Payment initiation attestations for a transfer.
3707
+ */
3708
+ attestations: TransferInitiationAttestations;
3709
+
3710
+ /**
3711
+ * How the payment was initiated. Use `p2p_mobile_payment` for peer-to-peer
3712
+ * transfers initiated on a mobile device; `other_mobile_payment` for non-P2P
3713
+ * mobile-initiated payments (e.g. a merchant payment via a mobile app); `other`
3714
+ * for payments not relying on a mobile device.
3715
+ */
3716
+ channel: TransferInitiationChannel;
3717
+
3718
+ /**
3719
+ * Whether the payment was made remotely or in person. Use `remote` for payments
3720
+ * initiated from a distance (mobile app, online banking, or e-commerce checkout);
3721
+ * `non_remote` for payments made in person (physical card, payment terminal, or
3722
+ * contactless tap).
3723
+ */
3724
+ subchannel: TransferInitiationSubchannel;
3725
+ }
3726
+
3727
+ /**
3728
+ * Payment initiation attestations for a transfer.
3729
+ */
3730
+ export interface TransferInitiationAttestations {
3731
+ /**
3732
+ * Strong Customer Authentication attestation for a transfer.
3733
+ */
3734
+ sca: TransferScaAttestation;
3735
+ }
3736
+
3737
+ /**
3738
+ * How the payment was initiated. Use `p2p_mobile_payment` for peer-to-peer
3739
+ * transfers initiated on a mobile device; `other_mobile_payment` for non-P2P
3740
+ * mobile-initiated payments (e.g. a merchant payment via a mobile app); `other`
3741
+ * for payments not relying on a mobile device.
3742
+ */
3743
+ export type TransferInitiationChannel =
3744
+ | 'p2p_mobile_payment'
3745
+ | 'other_mobile_payment'
3746
+ | 'other'
3747
+ | (string & {});
3748
+
3749
+ /**
3750
+ * Whether the payment was made remotely or in person. Use `remote` for payments
3751
+ * initiated from a distance (mobile app, online banking, or e-commerce checkout);
3752
+ * `non_remote` for payments made in person (physical card, payment terminal, or
3753
+ * contactless tap).
3754
+ */
3755
+ export type TransferInitiationSubchannel = 'remote' | 'non_remote' | (string & {});
3756
+
3605
3757
  /**
3606
3758
  * Request body for requesting a quote for a cross-asset or cross-chain (DADC)
3607
3759
  * transfer.
@@ -3764,6 +3916,11 @@ export interface TransferRequestBody {
3764
3916
  */
3765
3917
  amount_type?: AmountType;
3766
3918
 
3919
+ /**
3920
+ * Options for a transfer from a custodial wallet.
3921
+ */
3922
+ custody_options?: TransferCustodyOptions;
3923
+
3767
3924
  /**
3768
3925
  * Total fees assessed on a transfer, in BPS
3769
3926
  */
@@ -3787,6 +3944,112 @@ export interface TransferRequestBody {
3787
3944
  slippage_bps?: number;
3788
3945
  }
3789
3946
 
3947
+ /**
3948
+ * Strong Customer Authentication attestation for a transfer.
3949
+ */
3950
+ export interface TransferScaAttestation {
3951
+ /**
3952
+ * Whether Strong Customer Authentication (SCA) was applied or which regulatory
3953
+ * exemption or non-applicability reason covers this payment. Use `sca_used` when
3954
+ * the user authenticated with SCA. Otherwise, choose the value that applies:
3955
+ * `payment_to_self` — payer and payee are the same person (remote only);
3956
+ * `trusted_beneficiaries` — payee is on the user's pre-approved list;
3957
+ * `recurring_transaction` — amount and payee match a previously SCA-authorized
3958
+ * recurring series; `contactless_low_value` — contactless card payment below the
3959
+ * low-value threshold (non-remote only); `unattended_terminal_for_transport` —
3960
+ * automated terminal for transport fares or parking (non-remote only); `low_value`
3961
+ * — remote payment below the low-value threshold (remote only);
3962
+ * `secure_corporate_payment` — dedicated corporate payment process with controls
3963
+ * equivalent to SCA (remote only); `transaction_risk_analysis` — PSP has performed
3964
+ * real-time risk analysis and the transaction falls within permitted thresholds
3965
+ * (remote only); `merchant_initiated_transaction` — payment triggered by the
3966
+ * merchant without the payer present, on a pre-authorized mandate (remote only);
3967
+ * `not_applicable` — this flow requires initiation context but SCA and SCA
3968
+ * exemptions do not apply; `other` — another recognized exemption not listed
3969
+ * above.
3970
+ */
3971
+ outcome: TransferScaOutcome;
3972
+
3973
+ /**
3974
+ * Authentication factor metadata. Optional when `outcome` is `sca_used`; if
3975
+ * provided, it must contain at least two entries from different `category` values
3976
+ * (e.g. one `possession` factor and one `knowledge` factor). Omit this field for
3977
+ * any other outcome.
3978
+ */
3979
+ auth_factors?: Array<TransferScaAuthFactor>;
3980
+ }
3981
+
3982
+ /**
3983
+ * Authentication factor metadata for a transfer.
3984
+ */
3985
+ export interface TransferScaAuthFactor {
3986
+ /**
3987
+ * The ISO 8601 timestamp when this factor was authenticated.
3988
+ */
3989
+ authenticated_at: string;
3990
+
3991
+ /**
3992
+ * The type of authentication factor used. Known values are: `knowledge` (something
3993
+ * only the user knows, e.g. a PIN or password), `possession` (something only the
3994
+ * user has, e.g. a phone receiving an OTP or a hardware token), and `inherence`
3995
+ * (something the user is, e.g. a fingerprint or face scan). When `outcome` is
3996
+ * `sca_used`, the two factors in `auth_factors` must belong to two different
3997
+ * categories.
3998
+ */
3999
+ category: TransferScaAuthFactorCategory;
4000
+
4001
+ /**
4002
+ * Your internal identifier for this authentication event (e.g. a session ID,
4003
+ * transaction ID, or audit log reference). Used for reconciliation.
4004
+ */
4005
+ reference: string;
4006
+ }
4007
+
4008
+ /**
4009
+ * The type of authentication factor used. Known values are: `knowledge` (something
4010
+ * only the user knows, e.g. a PIN or password), `possession` (something only the
4011
+ * user has, e.g. a phone receiving an OTP or a hardware token), and `inherence`
4012
+ * (something the user is, e.g. a fingerprint or face scan). When `outcome` is
4013
+ * `sca_used`, the two factors in `auth_factors` must belong to two different
4014
+ * categories.
4015
+ */
4016
+ export type TransferScaAuthFactorCategory = 'knowledge' | 'possession' | 'inherence' | (string & {});
4017
+
4018
+ /**
4019
+ * Whether Strong Customer Authentication (SCA) was applied or which regulatory
4020
+ * exemption or non-applicability reason covers this payment. Use `sca_used` when
4021
+ * the user authenticated with SCA. Otherwise, choose the value that applies:
4022
+ * `payment_to_self` — payer and payee are the same person (remote only);
4023
+ * `trusted_beneficiaries` — payee is on the user's pre-approved list;
4024
+ * `recurring_transaction` — amount and payee match a previously SCA-authorized
4025
+ * recurring series; `contactless_low_value` — contactless card payment below the
4026
+ * low-value threshold (non-remote only); `unattended_terminal_for_transport` —
4027
+ * automated terminal for transport fares or parking (non-remote only); `low_value`
4028
+ * — remote payment below the low-value threshold (remote only);
4029
+ * `secure_corporate_payment` — dedicated corporate payment process with controls
4030
+ * equivalent to SCA (remote only); `transaction_risk_analysis` — PSP has performed
4031
+ * real-time risk analysis and the transaction falls within permitted thresholds
4032
+ * (remote only); `merchant_initiated_transaction` — payment triggered by the
4033
+ * merchant without the payer present, on a pre-authorized mandate (remote only);
4034
+ * `not_applicable` — this flow requires initiation context but SCA and SCA
4035
+ * exemptions do not apply; `other` — another recognized exemption not listed
4036
+ * above.
4037
+ */
4038
+ export type TransferScaOutcome =
4039
+ | 'sca_used'
4040
+ | 'payment_to_self'
4041
+ | 'trusted_beneficiaries'
4042
+ | 'recurring_transaction'
4043
+ | 'contactless_low_value'
4044
+ | 'unattended_terminal_for_transport'
4045
+ | 'low_value'
4046
+ | 'secure_corporate_payment'
4047
+ | 'transaction_risk_analysis'
4048
+ | 'merchant_initiated_transaction'
4049
+ | 'not_applicable'
4050
+ | 'other'
4051
+ | (string & {});
4052
+
3790
4053
  /**
3791
4054
  * Details for a sent transfer transaction.
3792
4055
  */
@@ -6624,6 +6887,7 @@ export declare namespace Wallets {
6624
6887
  type CryptoDepositAccountSourceChain as CryptoDepositAccountSourceChain,
6625
6888
  type CryptoDepositAccountSourceCurrency as CryptoDepositAccountSourceCurrency,
6626
6889
  type CryptoDepositAddressRoute as CryptoDepositAddressRoute,
6890
+ type CryptoDepositAddressStrategy as CryptoDepositAddressStrategy,
6627
6891
  type CryptoDepositAsset as CryptoDepositAsset,
6628
6892
  type CryptoDepositAssetFilter as CryptoDepositAssetFilter,
6629
6893
  type CryptoDepositAssetFilterAll as CryptoDepositAssetFilterAll,
@@ -6637,6 +6901,10 @@ export declare namespace Wallets {
6637
6901
  type CustodialWalletCreateInput as CustodialWalletCreateInput,
6638
6902
  type CustodialWalletProvider as CustodialWalletProvider,
6639
6903
  type CustomTokenTransferSource as CustomTokenTransferSource,
6904
+ type DepositAccountCryptoQuoteAmount as DepositAccountCryptoQuoteAmount,
6905
+ type DepositAccountCryptoQuoteAsset as DepositAccountCryptoQuoteAsset,
6906
+ type DepositAccountCryptoQuoteRequestBody as DepositAccountCryptoQuoteRequestBody,
6907
+ type DepositAccountCryptoQuoteResponse as DepositAccountCryptoQuoteResponse,
6640
6908
  type DetachWalletAutomationRequestBody as DetachWalletAutomationRequestBody,
6641
6909
  type DeveloperFee as DeveloperFee,
6642
6910
  type EncryptedAuthorizationKey as EncryptedAuthorizationKey,
@@ -6819,10 +7087,19 @@ export declare namespace Wallets {
6819
7087
  type TransactionChainNameInput as TransactionChainNameInput,
6820
7088
  type TransactionDetail as TransactionDetail,
6821
7089
  type TransactionTokenAddressInput as TransactionTokenAddressInput,
7090
+ type TransferCustodyOptions as TransferCustodyOptions,
7091
+ type TransferInitiation as TransferInitiation,
7092
+ type TransferInitiationAttestations as TransferInitiationAttestations,
7093
+ type TransferInitiationChannel as TransferInitiationChannel,
7094
+ type TransferInitiationSubchannel as TransferInitiationSubchannel,
6822
7095
  type TransferQuoteRequestBody as TransferQuoteRequestBody,
6823
7096
  type TransferQuoteResponse as TransferQuoteResponse,
6824
7097
  type TransferReceivedTransactionDetail as TransferReceivedTransactionDetail,
6825
7098
  type TransferRequestBody as TransferRequestBody,
7099
+ type TransferScaAttestation as TransferScaAttestation,
7100
+ type TransferScaAuthFactor as TransferScaAuthFactor,
7101
+ type TransferScaAuthFactorCategory as TransferScaAuthFactorCategory,
7102
+ type TransferScaOutcome as TransferScaOutcome,
6826
7103
  type TransferSentTransactionDetail as TransferSentTransactionDetail,
6827
7104
  type TronContract as TronContract,
6828
7105
  type TronRawDataForSend as TronRawDataForSend,
@@ -1306,10 +1306,10 @@ export interface TransactionStillPendingWebhookPayload {
1306
1306
  }
1307
1307
 
1308
1308
  /**
1309
- * Payload for the usage.cross_chain_fee.recorded webhook event (Privy fee on a
1310
- * cross-chain transfer or swap).
1309
+ * Payload for the usage.gas_sponsorship.recorded webhook event (sponsored network
1310
+ * gas).
1311
1311
  */
1312
- export interface UsageCrossChainFeeRecordedWebhookPayload {
1312
+ export interface UsageGasSponsorshipRecordedWebhookPayload {
1313
1313
  amount_usd: string;
1314
1314
 
1315
1315
  /**
@@ -1330,14 +1330,19 @@ export interface UsageCrossChainFeeRecordedWebhookPayload {
1330
1330
  /**
1331
1331
  * The type of webhook event.
1332
1332
  */
1333
- type: 'usage.cross_chain_fee.recorded';
1333
+ type: 'usage.gas_sponsorship.recorded';
1334
1334
  }
1335
1335
 
1336
1336
  /**
1337
- * Payload for the usage.gas_sponsorship.recorded webhook event (sponsored network
1338
- * gas).
1337
+ * The type of operation that incurred a usage charge.
1339
1338
  */
1340
- export interface UsageGasSponsorshipRecordedWebhookPayload {
1339
+ export type UsageSourceType = 'wallet-action-transfer' | 'wallet-action-swap' | 'rpc';
1340
+
1341
+ /**
1342
+ * Payload for the usage.swap_provider_fee.recorded webhook event (swap provider
1343
+ * fee on a cross-chain transfer or swap).
1344
+ */
1345
+ export interface UsageSwapProviderFeeRecordedWebhookPayload {
1341
1346
  amount_usd: string;
1342
1347
 
1343
1348
  /**
@@ -1358,14 +1363,9 @@ export interface UsageGasSponsorshipRecordedWebhookPayload {
1358
1363
  /**
1359
1364
  * The type of webhook event.
1360
1365
  */
1361
- type: 'usage.gas_sponsorship.recorded';
1366
+ type: 'usage.swap_provider_fee.recorded';
1362
1367
  }
1363
1368
 
1364
- /**
1365
- * The type of operation that incurred a usage charge.
1366
- */
1367
- export type UsageSourceType = 'wallet-action-transfer' | 'wallet-action-swap' | 'rpc';
1368
-
1369
1369
  /**
1370
1370
  * Payload for the user.authenticated webhook event.
1371
1371
  */
@@ -4230,7 +4230,7 @@ export type WebhookPayload =
4230
4230
  | YieldClaimConfirmedWebhookPayload
4231
4231
  | UserOperationCompletedWebhookPayload
4232
4232
  | UsageGasSponsorshipRecordedWebhookPayload
4233
- | UsageCrossChainFeeRecordedWebhookPayload
4233
+ | UsageSwapProviderFeeRecordedWebhookPayload
4234
4234
  | IntentCreatedWebhookPayload
4235
4235
  | IntentAuthorizedWebhookPayload
4236
4236
  | IntentRejectedWebhookPayload
@@ -4389,9 +4389,9 @@ export declare namespace Webhooks {
4389
4389
  type TransactionProviderErrorWebhookPayload as TransactionProviderErrorWebhookPayload,
4390
4390
  type TransactionReplacedWebhookPayload as TransactionReplacedWebhookPayload,
4391
4391
  type TransactionStillPendingWebhookPayload as TransactionStillPendingWebhookPayload,
4392
- type UsageCrossChainFeeRecordedWebhookPayload as UsageCrossChainFeeRecordedWebhookPayload,
4393
4392
  type UsageGasSponsorshipRecordedWebhookPayload as UsageGasSponsorshipRecordedWebhookPayload,
4394
4393
  type UsageSourceType as UsageSourceType,
4394
+ type UsageSwapProviderFeeRecordedWebhookPayload as UsageSwapProviderFeeRecordedWebhookPayload,
4395
4395
  type UserAuthenticatedWebhookPayload as UserAuthenticatedWebhookPayload,
4396
4396
  type UserCreatedWebhookPayload as UserCreatedWebhookPayload,
4397
4397
  type UserDeletedWebhookPayload as UserDeletedWebhookPayload,
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.22.0'; // x-release-please-version
1
+ export const VERSION = '0.23.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.22.0";
1
+ export declare const VERSION = "0.23.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.22.0";
1
+ export declare const VERSION = "0.23.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.22.0'; // x-release-please-version
4
+ exports.VERSION = '0.23.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.22.0'; // x-release-please-version
1
+ export const VERSION = '0.23.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map