@privy-io/api-types 0.21.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.
- package/CHANGELOG.md +41 -0
- package/client.d.mts +12 -12
- package/client.d.mts.map +1 -1
- package/client.d.ts +12 -12
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/accounts.d.mts +0 -8
- package/resources/accounts.d.mts.map +1 -1
- package/resources/accounts.d.ts +0 -8
- package/resources/accounts.d.ts.map +1 -1
- package/resources/cards.d.mts +26 -9
- package/resources/cards.d.mts.map +1 -1
- package/resources/cards.d.ts +26 -9
- package/resources/cards.d.ts.map +1 -1
- package/resources/fiat.d.mts +525 -61
- package/resources/fiat.d.mts.map +1 -1
- package/resources/fiat.d.ts +525 -61
- package/resources/fiat.d.ts.map +1 -1
- package/resources/index.d.mts +6 -6
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +6 -6
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/shared.d.mts +23 -1
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +23 -1
- package/resources/shared.d.ts.map +1 -1
- package/resources/swaps.d.mts +2 -1
- package/resources/swaps.d.mts.map +1 -1
- package/resources/swaps.d.ts +2 -1
- package/resources/swaps.d.ts.map +1 -1
- package/resources/wallet-automations.d.mts +100 -6
- package/resources/wallet-automations.d.mts.map +1 -1
- package/resources/wallet-automations.d.ts +100 -6
- package/resources/wallet-automations.d.ts.map +1 -1
- package/resources/wallet-automations.js.map +1 -1
- package/resources/wallet-automations.mjs.map +1 -1
- package/resources/wallets/actions.d.mts +44 -4
- package/resources/wallets/actions.d.mts.map +1 -1
- package/resources/wallets/actions.d.ts +44 -4
- package/resources/wallets/actions.d.ts.map +1 -1
- package/resources/wallets/balance.d.mts +1 -1
- package/resources/wallets/balance.d.mts.map +1 -1
- package/resources/wallets/balance.d.ts +1 -1
- 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/wallets.d.mts +367 -13
- package/resources/wallets/wallets.d.mts.map +1 -1
- package/resources/wallets/wallets.d.ts +367 -13
- 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 +22 -15
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +22 -15
- package/resources/webhooks.d.ts.map +1 -1
- package/src/client.ts +108 -6
- package/src/resources/accounts.ts +0 -10
- package/src/resources/cards.ts +29 -8
- package/src/resources/fiat.ts +637 -63
- package/src/resources/index.ts +54 -3
- package/src/resources/shared.ts +32 -0
- package/src/resources/swaps.ts +2 -1
- package/src/resources/wallet-automations.ts +120 -6
- package/src/resources/wallets/actions.ts +53 -3
- package/src/resources/wallets/balance.ts +9 -0
- package/src/resources/wallets/index.ts +26 -0
- package/src/resources/wallets/wallets.ts +469 -8
- package/src/resources/webhooks.ts +27 -16
- 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
|
@@ -22,6 +22,8 @@ import {
|
|
|
22
22
|
EarnIncentiveRewardsQuery,
|
|
23
23
|
EarnIncentiveRewardsResponse,
|
|
24
24
|
EarnIncetiveClaimRewardEntry,
|
|
25
|
+
EarnPositionApyAllocation,
|
|
26
|
+
EarnPositionApyType,
|
|
25
27
|
EarnWithdrawActionResponse,
|
|
26
28
|
EarnWithdrawRequestBody,
|
|
27
29
|
EthereumEarnPositionQuery,
|
|
@@ -571,6 +573,22 @@ export interface AttachWalletAutomationRequestBody {
|
|
|
571
573
|
params?: WalletAutomationsAPI.SwapAttachmentParams;
|
|
572
574
|
}
|
|
573
575
|
|
|
576
|
+
/**
|
|
577
|
+
* A summary of an automation attached to a wallet.
|
|
578
|
+
*/
|
|
579
|
+
export interface AttachedWalletAutomation {
|
|
580
|
+
/**
|
|
581
|
+
* ID of the automation.
|
|
582
|
+
*/
|
|
583
|
+
id: string;
|
|
584
|
+
|
|
585
|
+
/**
|
|
586
|
+
* Whether this attachment is currently active — true only if both the attachment
|
|
587
|
+
* and the underlying automation are enabled.
|
|
588
|
+
*/
|
|
589
|
+
enabled: boolean;
|
|
590
|
+
}
|
|
591
|
+
|
|
574
592
|
/**
|
|
575
593
|
* Dashboard response for a wallet authorization key (includes role, which is an
|
|
576
594
|
* internal-only concept).
|
|
@@ -631,6 +649,12 @@ export interface CreateCryptoDepositAccountWithConfigRequestBody {
|
|
|
631
649
|
deposit_config_id: string;
|
|
632
650
|
|
|
633
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;
|
|
634
658
|
}
|
|
635
659
|
|
|
636
660
|
/**
|
|
@@ -638,7 +662,7 @@ export interface CreateCryptoDepositAccountWithConfigRequestBody {
|
|
|
638
662
|
*/
|
|
639
663
|
export interface CreateCryptoDepositAccountWithRouteRequestBody {
|
|
640
664
|
/**
|
|
641
|
-
* An asset on a chain. Uses a human-readable alias (usdc,
|
|
665
|
+
* An asset on a chain. Uses a human-readable alias (usdc, tempo) when one is on
|
|
642
666
|
* file, otherwise the raw asset address and CAIP-2.
|
|
643
667
|
*/
|
|
644
668
|
destination: CryptoDepositAsset;
|
|
@@ -650,6 +674,94 @@ export interface CreateCryptoDepositAccountWithRouteRequestBody {
|
|
|
650
674
|
source: CryptoDepositAssetFilter;
|
|
651
675
|
|
|
652
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;
|
|
683
|
+
}
|
|
684
|
+
|
|
685
|
+
/**
|
|
686
|
+
* EVM CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:1" for
|
|
687
|
+
* Ethereum).
|
|
688
|
+
*/
|
|
689
|
+
export type CryptoDepositAccountCaip2 = string;
|
|
690
|
+
|
|
691
|
+
/**
|
|
692
|
+
* Chain metadata for rendering the crypto deposit-account source picker.
|
|
693
|
+
*/
|
|
694
|
+
export interface CryptoDepositAccountChain {
|
|
695
|
+
/**
|
|
696
|
+
* EVM CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:1" for
|
|
697
|
+
* Ethereum).
|
|
698
|
+
*/
|
|
699
|
+
caip2: CryptoDepositAccountCaip2;
|
|
700
|
+
|
|
701
|
+
/**
|
|
702
|
+
* Numeric chain id used by some clients as an alias.
|
|
703
|
+
*/
|
|
704
|
+
chain_id: number;
|
|
705
|
+
|
|
706
|
+
display_name: string;
|
|
707
|
+
|
|
708
|
+
/**
|
|
709
|
+
* URL of the chain icon.
|
|
710
|
+
*/
|
|
711
|
+
icon_url: string;
|
|
712
|
+
|
|
713
|
+
/**
|
|
714
|
+
* Execution VM, e.g. evm or svm.
|
|
715
|
+
*/
|
|
716
|
+
vm_type: string;
|
|
717
|
+
}
|
|
718
|
+
|
|
719
|
+
/**
|
|
720
|
+
* Source-token catalog for crypto deposit accounts. Only automation-sweepable,
|
|
721
|
+
* gas-sponsored mainnets.
|
|
722
|
+
*/
|
|
723
|
+
export interface CryptoDepositAccountConfigResponse {
|
|
724
|
+
chains: { [key: string]: CryptoDepositAccountChain };
|
|
725
|
+
|
|
726
|
+
currencies: Array<CryptoDepositAccountSourceCurrency>;
|
|
727
|
+
}
|
|
728
|
+
|
|
729
|
+
/**
|
|
730
|
+
* A token contract on one source chain in the crypto deposit-account catalog.
|
|
731
|
+
*/
|
|
732
|
+
export interface CryptoDepositAccountSourceChain {
|
|
733
|
+
/**
|
|
734
|
+
* Token contract or native asset address on this chain.
|
|
735
|
+
*/
|
|
736
|
+
address: string;
|
|
737
|
+
|
|
738
|
+
/**
|
|
739
|
+
* EVM CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:1" for
|
|
740
|
+
* Ethereum).
|
|
741
|
+
*/
|
|
742
|
+
caip2: CryptoDepositAccountCaip2;
|
|
743
|
+
|
|
744
|
+
/**
|
|
745
|
+
* Token decimals on this chain.
|
|
746
|
+
*/
|
|
747
|
+
decimals: number;
|
|
748
|
+
}
|
|
749
|
+
|
|
750
|
+
/**
|
|
751
|
+
* A source token in the crypto deposit-account catalog, with the chains it can be
|
|
752
|
+
* sent from.
|
|
753
|
+
*/
|
|
754
|
+
export interface CryptoDepositAccountSourceCurrency {
|
|
755
|
+
chains: Array<CryptoDepositAccountSourceChain>;
|
|
756
|
+
|
|
757
|
+
/**
|
|
758
|
+
* URL of the token logo.
|
|
759
|
+
*/
|
|
760
|
+
logo_uri: string;
|
|
761
|
+
|
|
762
|
+
name: string;
|
|
763
|
+
|
|
764
|
+
symbol: string;
|
|
653
765
|
}
|
|
654
766
|
|
|
655
767
|
/**
|
|
@@ -659,7 +771,7 @@ export interface CryptoDepositAddressRoute {
|
|
|
659
771
|
deposit_address: string;
|
|
660
772
|
|
|
661
773
|
/**
|
|
662
|
-
* An asset on a chain. Uses a human-readable alias (usdc,
|
|
774
|
+
* An asset on a chain. Uses a human-readable alias (usdc, tempo) when one is on
|
|
663
775
|
* file, otherwise the raw asset address and CAIP-2.
|
|
664
776
|
*/
|
|
665
777
|
destination: CryptoDepositAsset;
|
|
@@ -674,7 +786,13 @@ export interface CryptoDepositAddressRoute {
|
|
|
674
786
|
}
|
|
675
787
|
|
|
676
788
|
/**
|
|
677
|
-
*
|
|
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
|
+
|
|
794
|
+
/**
|
|
795
|
+
* An asset on a chain. Uses a human-readable alias (usdc, tempo) when one is on
|
|
678
796
|
* file, otherwise the raw asset address and CAIP-2.
|
|
679
797
|
*/
|
|
680
798
|
export interface CryptoDepositAsset {
|
|
@@ -757,9 +875,9 @@ export interface CustodialWallet {
|
|
|
757
875
|
address: string;
|
|
758
876
|
|
|
759
877
|
/**
|
|
760
|
-
* The chain
|
|
878
|
+
* The chain of the custodial wallet.
|
|
761
879
|
*/
|
|
762
|
-
|
|
880
|
+
chain: CustodialWalletChain;
|
|
763
881
|
|
|
764
882
|
/**
|
|
765
883
|
* Information about the custodian managing this wallet.
|
|
@@ -776,11 +894,21 @@ export interface CustodialWallet {
|
|
|
776
894
|
*/
|
|
777
895
|
additional_signers?: WalletAdditionalSigner;
|
|
778
896
|
|
|
897
|
+
/**
|
|
898
|
+
* @deprecated The chain type of the custodial wallet (deprecated).
|
|
899
|
+
*/
|
|
900
|
+
chain_type?: CustodialWalletChainType;
|
|
901
|
+
|
|
779
902
|
policy_ids?: Array<string>;
|
|
780
903
|
}
|
|
781
904
|
|
|
782
905
|
/**
|
|
783
|
-
* The chain
|
|
906
|
+
* The chain of the custodial wallet.
|
|
907
|
+
*/
|
|
908
|
+
export type CustodialWalletChain = 'base' | 'solana' | 'tempo';
|
|
909
|
+
|
|
910
|
+
/**
|
|
911
|
+
* The chain type of the custodial wallet (deprecated).
|
|
784
912
|
*/
|
|
785
913
|
export type CustodialWalletChainType = 'ethereum' | 'solana';
|
|
786
914
|
|
|
@@ -789,9 +917,9 @@ export type CustodialWalletChainType = 'ethereum' | 'solana';
|
|
|
789
917
|
*/
|
|
790
918
|
export interface CustodialWalletCreateInput {
|
|
791
919
|
/**
|
|
792
|
-
* The chain
|
|
920
|
+
* The chain of the custodial wallet.
|
|
793
921
|
*/
|
|
794
|
-
|
|
922
|
+
chain: CustodialWalletChain;
|
|
795
923
|
|
|
796
924
|
/**
|
|
797
925
|
* The provider of the custodial wallet.
|
|
@@ -853,6 +981,73 @@ export interface CustomTokenTransferSource {
|
|
|
853
981
|
amount?: string;
|
|
854
982
|
}
|
|
855
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
|
+
|
|
856
1051
|
/**
|
|
857
1052
|
* Request body for detaching automations from a wallet (wallet ID comes from the
|
|
858
1053
|
* URL).
|
|
@@ -1679,6 +1874,34 @@ export interface GetByWalletAddressRequestBody {
|
|
|
1679
1874
|
include_archived?: boolean;
|
|
1680
1875
|
}
|
|
1681
1876
|
|
|
1877
|
+
/**
|
|
1878
|
+
* The next crypto deposit-account sweep into the path wallet after `after`, or
|
|
1879
|
+
* null if none. The order object matches GET order.
|
|
1880
|
+
*/
|
|
1881
|
+
export interface GetCryptoDepositAccountNextOrderResponse {
|
|
1882
|
+
/**
|
|
1883
|
+
* A crypto deposit-account sweep identified by its wallet action ID. Status is the
|
|
1884
|
+
* wallet-action status.
|
|
1885
|
+
*/
|
|
1886
|
+
order: GetCryptoDepositAccountOrderResponse | null;
|
|
1887
|
+
}
|
|
1888
|
+
|
|
1889
|
+
/**
|
|
1890
|
+
* A crypto deposit-account sweep identified by its wallet action ID. Status is the
|
|
1891
|
+
* wallet-action status.
|
|
1892
|
+
*/
|
|
1893
|
+
export interface GetCryptoDepositAccountOrderResponse {
|
|
1894
|
+
/**
|
|
1895
|
+
* Wallet action ID of the deposit sweep.
|
|
1896
|
+
*/
|
|
1897
|
+
id: string;
|
|
1898
|
+
|
|
1899
|
+
/**
|
|
1900
|
+
* Status of a wallet action.
|
|
1901
|
+
*/
|
|
1902
|
+
status: ActionsAPI.WalletActionStatus;
|
|
1903
|
+
}
|
|
1904
|
+
|
|
1682
1905
|
/**
|
|
1683
1906
|
* The input for HD wallets.
|
|
1684
1907
|
*/
|
|
@@ -1813,6 +2036,15 @@ export interface IntentBinding {
|
|
|
1813
2036
|
type: 'intent';
|
|
1814
2037
|
}
|
|
1815
2038
|
|
|
2039
|
+
/**
|
|
2040
|
+
* A page of active crypto deposit accounts for a destination wallet.
|
|
2041
|
+
*/
|
|
2042
|
+
export interface ListCryptoDepositAccountsResponse {
|
|
2043
|
+
data: Array<CryptoDepositAddressRoute>;
|
|
2044
|
+
|
|
2045
|
+
next_cursor: string | null;
|
|
2046
|
+
}
|
|
2047
|
+
|
|
1816
2048
|
/**
|
|
1817
2049
|
* Source for a transfer identified by a named asset (e.g. "usdc", "eth"). Use this
|
|
1818
2050
|
* variant for first-class assets maintained by Privy.
|
|
@@ -3436,6 +3668,7 @@ export type TransactionChainNameInput =
|
|
|
3436
3668
|
| 'polygon'
|
|
3437
3669
|
| 'solana'
|
|
3438
3670
|
| 'sepolia'
|
|
3671
|
+
| 'arc'
|
|
3439
3672
|
| (string & {});
|
|
3440
3673
|
|
|
3441
3674
|
/**
|
|
@@ -3449,6 +3682,78 @@ export type TransactionDetail = TransferSentTransactionDetail | TransferReceived
|
|
|
3449
3682
|
*/
|
|
3450
3683
|
export type TransactionTokenAddressInput = string;
|
|
3451
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
|
+
|
|
3452
3757
|
/**
|
|
3453
3758
|
* Request body for requesting a quote for a cross-asset or cross-chain (DADC)
|
|
3454
3759
|
* transfer.
|
|
@@ -3611,6 +3916,11 @@ export interface TransferRequestBody {
|
|
|
3611
3916
|
*/
|
|
3612
3917
|
amount_type?: AmountType;
|
|
3613
3918
|
|
|
3919
|
+
/**
|
|
3920
|
+
* Options for a transfer from a custodial wallet.
|
|
3921
|
+
*/
|
|
3922
|
+
custody_options?: TransferCustodyOptions;
|
|
3923
|
+
|
|
3614
3924
|
/**
|
|
3615
3925
|
* Total fees assessed on a transfer, in BPS
|
|
3616
3926
|
*/
|
|
@@ -3634,6 +3944,112 @@ export interface TransferRequestBody {
|
|
|
3634
3944
|
slippage_bps?: number;
|
|
3635
3945
|
}
|
|
3636
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
|
+
|
|
3637
4053
|
/**
|
|
3638
4054
|
* Details for a sent transfer transaction.
|
|
3639
4055
|
*/
|
|
@@ -4190,6 +4606,16 @@ export interface Wallet {
|
|
|
4190
4606
|
*/
|
|
4191
4607
|
authorization_threshold?: number;
|
|
4192
4608
|
|
|
4609
|
+
/**
|
|
4610
|
+
* Automations attached to the wallet, including disabled ones.
|
|
4611
|
+
*/
|
|
4612
|
+
automations?: Array<AttachedWalletAutomation>;
|
|
4613
|
+
|
|
4614
|
+
/**
|
|
4615
|
+
* The chain of the custodial wallet.
|
|
4616
|
+
*/
|
|
4617
|
+
chain?: CustodialWalletChain;
|
|
4618
|
+
|
|
4193
4619
|
/**
|
|
4194
4620
|
* Information about the custodian managing this wallet.
|
|
4195
4621
|
*/
|
|
@@ -4303,6 +4729,14 @@ export type WalletAssetChainNameInput =
|
|
|
4303
4729
|
| 'tron'
|
|
4304
4730
|
| 'zksync_era'
|
|
4305
4731
|
| 'robinhood'
|
|
4732
|
+
| 'unichain'
|
|
4733
|
+
| 'worldchain'
|
|
4734
|
+
| 'ink'
|
|
4735
|
+
| 'soneium'
|
|
4736
|
+
| 'megaeth'
|
|
4737
|
+
| 'hyperevm'
|
|
4738
|
+
| 'hypercore'
|
|
4739
|
+
| 'arc'
|
|
4306
4740
|
| 'tempo_testnet'
|
|
4307
4741
|
| 'hoodi'
|
|
4308
4742
|
| 'sepolia'
|
|
@@ -4317,6 +4751,7 @@ export type WalletAssetChainNameInput =
|
|
|
4317
4751
|
| 'solana_testnet'
|
|
4318
4752
|
| 'tron_nile'
|
|
4319
4753
|
| 'robinhood_testnet'
|
|
4754
|
+
| 'ink_sepolia'
|
|
4320
4755
|
| (string & {});
|
|
4321
4756
|
|
|
4322
4757
|
/**
|
|
@@ -6438,6 +6873,7 @@ export declare namespace Wallets {
|
|
|
6438
6873
|
type AptosSignTransactionRpcResponseData as AptosSignTransactionRpcResponseData,
|
|
6439
6874
|
type AptosSignedTransactionBcsHex as AptosSignedTransactionBcsHex,
|
|
6440
6875
|
type AttachWalletAutomationRequestBody as AttachWalletAutomationRequestBody,
|
|
6876
|
+
type AttachedWalletAutomation as AttachedWalletAutomation,
|
|
6441
6877
|
type AuthorizationKeyDashboardResponse as AuthorizationKeyDashboardResponse,
|
|
6442
6878
|
type AuthorizationKeyResponse as AuthorizationKeyResponse,
|
|
6443
6879
|
type AuthorizationKeyRole as AuthorizationKeyRole,
|
|
@@ -6445,7 +6881,13 @@ export declare namespace Wallets {
|
|
|
6445
6881
|
type CreateCryptoDepositAccountResponse as CreateCryptoDepositAccountResponse,
|
|
6446
6882
|
type CreateCryptoDepositAccountWithConfigRequestBody as CreateCryptoDepositAccountWithConfigRequestBody,
|
|
6447
6883
|
type CreateCryptoDepositAccountWithRouteRequestBody as CreateCryptoDepositAccountWithRouteRequestBody,
|
|
6884
|
+
type CryptoDepositAccountCaip2 as CryptoDepositAccountCaip2,
|
|
6885
|
+
type CryptoDepositAccountChain as CryptoDepositAccountChain,
|
|
6886
|
+
type CryptoDepositAccountConfigResponse as CryptoDepositAccountConfigResponse,
|
|
6887
|
+
type CryptoDepositAccountSourceChain as CryptoDepositAccountSourceChain,
|
|
6888
|
+
type CryptoDepositAccountSourceCurrency as CryptoDepositAccountSourceCurrency,
|
|
6448
6889
|
type CryptoDepositAddressRoute as CryptoDepositAddressRoute,
|
|
6890
|
+
type CryptoDepositAddressStrategy as CryptoDepositAddressStrategy,
|
|
6449
6891
|
type CryptoDepositAsset as CryptoDepositAsset,
|
|
6450
6892
|
type CryptoDepositAssetFilter as CryptoDepositAssetFilter,
|
|
6451
6893
|
type CryptoDepositAssetFilterAll as CryptoDepositAssetFilterAll,
|
|
@@ -6454,10 +6896,15 @@ export declare namespace Wallets {
|
|
|
6454
6896
|
type CurveSigningChainType as CurveSigningChainType,
|
|
6455
6897
|
type CurveType as CurveType,
|
|
6456
6898
|
type CustodialWallet as CustodialWallet,
|
|
6899
|
+
type CustodialWalletChain as CustodialWalletChain,
|
|
6457
6900
|
type CustodialWalletChainType as CustodialWalletChainType,
|
|
6458
6901
|
type CustodialWalletCreateInput as CustodialWalletCreateInput,
|
|
6459
6902
|
type CustodialWalletProvider as CustodialWalletProvider,
|
|
6460
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,
|
|
6461
6908
|
type DetachWalletAutomationRequestBody as DetachWalletAutomationRequestBody,
|
|
6462
6909
|
type DeveloperFee as DeveloperFee,
|
|
6463
6910
|
type EncryptedAuthorizationKey as EncryptedAuthorizationKey,
|
|
@@ -6512,6 +6959,8 @@ export declare namespace Wallets {
|
|
|
6512
6959
|
type FirstClassChainType as FirstClassChainType,
|
|
6513
6960
|
type Gas as Gas,
|
|
6514
6961
|
type GetByWalletAddressRequestBody as GetByWalletAddressRequestBody,
|
|
6962
|
+
type GetCryptoDepositAccountNextOrderResponse as GetCryptoDepositAccountNextOrderResponse,
|
|
6963
|
+
type GetCryptoDepositAccountOrderResponse as GetCryptoDepositAccountOrderResponse,
|
|
6515
6964
|
type HDInitInput as HDInitInput,
|
|
6516
6965
|
type HDPath as HDPath,
|
|
6517
6966
|
type HDSubmitInput as HDSubmitInput,
|
|
@@ -6520,6 +6969,7 @@ export declare namespace Wallets {
|
|
|
6520
6969
|
type HpkeImportConfig as HpkeImportConfig,
|
|
6521
6970
|
type Hex as Hex,
|
|
6522
6971
|
type IntentBinding as IntentBinding,
|
|
6972
|
+
type ListCryptoDepositAccountsResponse as ListCryptoDepositAccountsResponse,
|
|
6523
6973
|
type NamedTokenTransferSource as NamedTokenTransferSource,
|
|
6524
6974
|
type NearRpcRequestBody as NearRpcRequestBody,
|
|
6525
6975
|
type NearRpcResponse as NearRpcResponse,
|
|
@@ -6637,10 +7087,19 @@ export declare namespace Wallets {
|
|
|
6637
7087
|
type TransactionChainNameInput as TransactionChainNameInput,
|
|
6638
7088
|
type TransactionDetail as TransactionDetail,
|
|
6639
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,
|
|
6640
7095
|
type TransferQuoteRequestBody as TransferQuoteRequestBody,
|
|
6641
7096
|
type TransferQuoteResponse as TransferQuoteResponse,
|
|
6642
7097
|
type TransferReceivedTransactionDetail as TransferReceivedTransactionDetail,
|
|
6643
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,
|
|
6644
7103
|
type TransferSentTransactionDetail as TransferSentTransactionDetail,
|
|
6645
7104
|
type TronContract as TronContract,
|
|
6646
7105
|
type TronRawDataForSend as TronRawDataForSend,
|
|
@@ -6754,6 +7213,8 @@ export declare namespace Wallets {
|
|
|
6754
7213
|
type EarnIncentiveRewardsQuery as EarnIncentiveRewardsQuery,
|
|
6755
7214
|
type EarnIncentiveRewardsResponse as EarnIncentiveRewardsResponse,
|
|
6756
7215
|
type EarnIncetiveClaimRewardEntry as EarnIncetiveClaimRewardEntry,
|
|
7216
|
+
type EarnPositionApyAllocation as EarnPositionApyAllocation,
|
|
7217
|
+
type EarnPositionApyType as EarnPositionApyType,
|
|
6757
7218
|
type EarnWithdrawActionResponse as EarnWithdrawActionResponse,
|
|
6758
7219
|
type EarnWithdrawRequestBody as EarnWithdrawRequestBody,
|
|
6759
7220
|
type EthereumEarnPositionQuery as EthereumEarnPositionQuery,
|