Module types

Source

Expand description

Types used as operation parameters and responses.

Modules§

builder: Types for composing complex structures.
defaults: Generation of default values for serde.
error: Error types.

Structs§

Abi: Contract ABI Specification following Solidity’s external JSON interface format.
AbiFunction: ABI function type for contract functions.
AbiInput: Generic ABI item type encapsulating all other types besides function.
AbiParameter: Parameter definition for ABI functions, errors, and constructors.
AccountTokenAddressesResponse: Response containing token addresses that an account has received.
AccountTokenAddressesResponseTokenAddressesItem: Token contract address.
AddEndUserEvmAccountResponse: AddEndUserEvmAccountResponse
AddEndUserEvmAccountUserId: AddEndUserEvmAccountUserId
AddEndUserEvmAccountXIdempotencyKey: AddEndUserEvmAccountXIdempotencyKey
AddEndUserEvmSmartAccountBody: AddEndUserEvmSmartAccountBody
AddEndUserEvmSmartAccountResponse: AddEndUserEvmSmartAccountResponse
AddEndUserEvmSmartAccountUserId: AddEndUserEvmSmartAccountUserId
AddEndUserEvmSmartAccountXIdempotencyKey: AddEndUserEvmSmartAccountXIdempotencyKey
AddEndUserSolanaAccountResponse: AddEndUserSolanaAccountResponse
AddEndUserSolanaAccountUserId: AddEndUserSolanaAccountUserId
AddEndUserSolanaAccountXIdempotencyKey: AddEndUserSolanaAccountXIdempotencyKey
Asset: The symbol of the asset (e.g., eth, usd, usdc, usdt).
AuthenticationMethods: The list of valid authentication methods linked to the end user.
BlockchainAddress: A blockchain address. Format varies by network (e.g., 0x-prefixed for EVM, base58 for Solana).
CommonSwapResponse: CommonSwapResponse
CommonSwapResponseBlockNumber: The block number at which the liquidity conditions were examined.
CommonSwapResponseFees: The estimated fees for the swap.
CommonSwapResponseFromAmount: The amount of the fromToken that will be sent in this swap, in atomic units of the fromToken. For example, 1000000000000000000 when sending ETH equates to 1 ETH, 1000000 when sending USDC equates to 1 USDC, etc.
CommonSwapResponseFromToken: The 0x-prefixed contract address of the token that will be sent.
CommonSwapResponseIssues: An object containing potential issues discovered during validation that could prevent the swap from being executed successfully.
CommonSwapResponseIssuesAllowance: Details of the allowances that the taker must set in order to execute the swap successfully. Null if no allowance is required.
CommonSwapResponseIssuesAllowanceCurrentAllowance: The current allowance of the fromToken by the taker.
CommonSwapResponseIssuesAllowanceSpender: The 0x-prefixed address of to set the allowance on.
CommonSwapResponseIssuesBalance: Details of the balance of the fromToken that the taker must hold. Null if the taker has a sufficient balance.
CommonSwapResponseIssuesBalanceCurrentBalance: The current balance of the fromToken by the taker.
CommonSwapResponseIssuesBalanceRequiredBalance: The amount of the token that the taker must hold.
CommonSwapResponseIssuesBalanceToken: The 0x-prefixed contract address of the token.
CommonSwapResponseMinToAmount: The minimum amount of the toToken that must be received for the swap to succeed, in atomic units of the toToken. For example, 1000000000000000000 when receiving ETH equates to 1 ETH, 1000000 when receiving USDC equates to 1 USDC, etc. This value is influenced by the slippageBps parameter.
CommonSwapResponseToAmount: The amount of the toToken that will be received in atomic units of the toToken. For example, 1000000000000000000 when receiving ETH equates to 1 ETH, 1000000 when receiving USDC equates to 1 USDC, etc.
CommonSwapResponseToToken: The 0x-prefixed contract address of the token that will be received.
CreateEndUserBody: CreateEndUserBody
CreateEndUserBodyEvmAccount: Configuration for creating an EVM account for the end user.
CreateEndUserBodySolanaAccount: Configuration for creating a Solana account for the end user.
CreateEndUserBodyUserId: A stable, unique identifier for the end user. The userId must be unique across all end users in the developer’s CDP Project. It must be between 1 and 100 characters long and can only contain alphanumeric characters and hyphens.
CreateEndUserXIdempotencyKey: CreateEndUserXIdempotencyKey
CreateEvmAccountBody: CreateEvmAccountBody
CreateEvmAccountBodyAccountPolicy: The ID of the account-level policy to apply to the account.
CreateEvmAccountBodyName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names must be unique across all EVM accounts in the developer’s CDP Project.
CreateEvmAccountXIdempotencyKey: CreateEvmAccountXIdempotencyKey
CreateEvmEip7702DelegationAddress: CreateEvmEip7702DelegationAddress
CreateEvmEip7702DelegationBody: CreateEvmEip7702DelegationBody
CreateEvmEip7702DelegationResponse: CreateEvmEip7702DelegationResponse
CreateEvmEip7702DelegationWithEndUserAccountBody: CreateEvmEip7702DelegationWithEndUserAccountBody
CreateEvmEip7702DelegationWithEndUserAccountBodyAddress: The 0x-prefixed address of the EVM account to delegate.
CreateEvmEip7702DelegationWithEndUserAccountBodyWalletSecretId: Required when not using delegated signing. The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
CreateEvmEip7702DelegationWithEndUserAccountProjectId: CreateEvmEip7702DelegationWithEndUserAccountProjectId
CreateEvmEip7702DelegationWithEndUserAccountResponse: CreateEvmEip7702DelegationWithEndUserAccountResponse
CreateEvmEip7702DelegationWithEndUserAccountUserId: CreateEvmEip7702DelegationWithEndUserAccountUserId
CreateEvmEip7702DelegationWithEndUserAccountXIdempotencyKey: CreateEvmEip7702DelegationWithEndUserAccountXIdempotencyKey
CreateEvmEip7702DelegationXIdempotencyKey: CreateEvmEip7702DelegationXIdempotencyKey
CreateEvmSmartAccountBody: CreateEvmSmartAccountBody
CreateEvmSmartAccountBodyName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names must be unique across all EVM accounts in the developer’s CDP Project.
CreateEvmSmartAccountBodyOwnersItem: CreateEvmSmartAccountBodyOwnersItem
CreateEvmSmartAccountXIdempotencyKey: CreateEvmSmartAccountXIdempotencyKey
CreateEvmSwapQuoteBody: CreateEvmSwapQuoteBody
CreateEvmSwapQuoteBodyFromAmount: The amount of the fromToken to send in atomic units of the token. For example, 1000000000000000000 when sending ETH equates to 1 ETH, 1000000 when sending USDC equates to 1 USDC, etc.
CreateEvmSwapQuoteBodyFromToken: The 0x-prefixed contract address of the token to send.
CreateEvmSwapQuoteBodyGasPrice: The target gas price for the swap transaction, in Wei. For EIP-1559 transactions, this value should be seen as the maxFeePerGas value. If not provided, the API will use an estimate based on the current network conditions.
CreateEvmSwapQuoteBodySignerAddress: The 0x-prefixed Externally Owned Account (EOA) address that will sign the Permit2 EIP-712 permit message. This is only needed if taker is a smart contract.
CreateEvmSwapQuoteBodyTaker: The 0x-prefixed address that holds the fromToken balance and has the Permit2 allowance set for the swap.
CreateEvmSwapQuoteBodyToToken: The 0x-prefixed contract address of the token to receive.
CreateEvmSwapQuoteXIdempotencyKey: CreateEvmSwapQuoteXIdempotencyKey
CreateOnrampOrderBody: CreateOnrampOrderBody
CreateOnrampOrderResponse: CreateOnrampOrderResponse
CreateOnrampSessionBody: CreateOnrampSessionBody
CreateOnrampSessionResponse: CreateOnrampSessionResponse
CreatePolicyBody: CreatePolicyBody
CreatePolicyBodyDescription: An optional human-readable description for the policy. Policy descriptions can consist of alphanumeric characters, spaces, commas, and periods, and be 50 characters or less.
CreatePolicyXIdempotencyKey: CreatePolicyXIdempotencyKey
CreateSolanaAccountBody: CreateSolanaAccountBody
CreateSolanaAccountBodyAccountPolicy: The ID of the account-level policy to apply to the account.
CreateSolanaAccountBodyName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names must be unique across all Solana accounts in the developer’s CDP Project.
CreateSolanaAccountXIdempotencyKey: CreateSolanaAccountXIdempotencyKey
CreateSpendPermissionAddress: CreateSpendPermissionAddress
CreateSpendPermissionRequest: Request parameters for creating a Spend Permission.
CreateSpendPermissionRequestSpender: Entity that can spend account’s tokens. Can be either a Smart Account or an EOA.
CreateSpendPermissionRequestToken: ERC-7528 native token address (e.g. “0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE” for native ETH), or an ERC-20 contract address.
CreateSpendPermissionXIdempotencyKey: CreateSpendPermissionXIdempotencyKey
CreateSwapQuoteResponse: CreateSwapQuoteResponse
CreateSwapQuoteResponseBlockNumber: The block number at which the liquidity conditions were examined.
CreateSwapQuoteResponseFees: The estimated fees for the swap.
CreateSwapQuoteResponseFromAmount: The amount of the fromToken that will be sent in this swap, in atomic units of the fromToken. For example, 1000000000000000000 when sending ETH equates to 1 ETH, 1000000 when sending USDC equates to 1 USDC, etc.
CreateSwapQuoteResponseFromToken: The 0x-prefixed contract address of the token that will be sent.
CreateSwapQuoteResponseIssues: An object containing potential issues discovered during validation that could prevent the swap from being executed successfully.
CreateSwapQuoteResponseIssuesAllowance: Details of the allowances that the taker must set in order to execute the swap successfully. Null if no allowance is required.
CreateSwapQuoteResponseIssuesAllowanceCurrentAllowance: The current allowance of the fromToken by the taker.
CreateSwapQuoteResponseIssuesAllowanceSpender: The 0x-prefixed address of to set the allowance on.
CreateSwapQuoteResponseIssuesBalance: Details of the balance of the fromToken that the taker must hold. Null if the taker has a sufficient balance.
CreateSwapQuoteResponseIssuesBalanceCurrentBalance: The current balance of the fromToken by the taker.
CreateSwapQuoteResponseIssuesBalanceRequiredBalance: The amount of the token that the taker must hold.
CreateSwapQuoteResponseIssuesBalanceToken: The 0x-prefixed contract address of the token.
CreateSwapQuoteResponseMinToAmount: The minimum amount of the toToken that must be received for the swap to succeed, in atomic units of the toToken. For example, 1000000000000000000 when receiving ETH equates to 1 ETH, 1000000 when receiving USDC equates to 1 USDC, etc. This value is influenced by the slippageBps parameter.
CreateSwapQuoteResponsePermit2: The approval object which contains the necessary fields to submit an approval for this transaction. Null if the fromToken is the native token or the transaction is a native token wrap / unwrap.
CreateSwapQuoteResponsePermit2Hash: The hash for the approval according to EIP-712. Computing the hash of the eip712 field should match the value of this field.
CreateSwapQuoteResponseToAmount: The amount of the toToken that will be received in atomic units of the toToken. For example, 1000000000000000000 when receiving ETH equates to 1 ETH, 1000000 when receiving USDC equates to 1 USDC, etc.
CreateSwapQuoteResponseToToken: The 0x-prefixed contract address of the token that will be received.
CreateSwapQuoteResponseTransaction: The details of the transaction to be signed and submitted to execute the swap.
CreateSwapQuoteResponseTransactionGas: The estimated gas limit that should be used to send the transaction to guarantee settlement.
CreateSwapQuoteResponseTransactionGasPrice: The gas price, in Wei, that should be used to send the transaction. For EIP-1559 transactions, this value should be seen as the maxFeePerGas value. The transaction should be sent with this gas price to guarantee settlement.
CreateSwapQuoteResponseTransactionTo: The 0x-prefixed address of the contract to call.
CreateSwapQuoteResponseTransactionValue: The value of the transaction in Wei.
DeletePolicyPolicyId: DeletePolicyPolicyId
DeletePolicyXIdempotencyKey: DeletePolicyXIdempotencyKey
Description: A human-readable description.
DeveloperJwtAuthentication: Information about an end user who authenticates using a JWT issued by the developer.
Eip712Domain: The domain of the EIP-712 typed data.
Eip712DomainSalt: The optional 32-byte 0x-prefixed hex salt for domain separation.
Eip712DomainVerifyingContract: The 0x-prefixed EVM address of the verifying smart contract.
Eip712Message: The message to sign using EIP-712.
Eip712Types: A mapping of struct names to an array of type objects (name + type). Each key corresponds to a type name (e.g., “EIP712Domain”, “PermitTransferFrom”).
EmailAuthentication: Information about an end user who authenticates using a one-time password sent to their email address.
EndUser: Information about the end user.
EndUserEvmAccount: Information about an EVM account associated with an end user.
EndUserEvmAccountAddress: The address of the EVM account.
EndUserEvmAccountsItem: The address of the EVM account associated with the end user.
EndUserEvmSmartAccount: Information about an EVM smart account associated with an end user.
EndUserEvmSmartAccountAddress: The address of the EVM smart account.
EndUserEvmSmartAccountOwnerAddressesItem: The address of an EVM EOA account that owns this smart account.
EndUserEvmSmartAccountsItem: The address of the EVM smart account associated with the end user.
EndUserSolanaAccount: Information about a Solana account associated with an end user.
EndUserSolanaAccountAddress: The base58 encoded address of the Solana account.
EndUserSolanaAccountsItem: The base58 encoded address of the Solana account associated with the end user.
EndUserUserId: A stable, unique identifier for the end user. The userId must be unique across all end users in the developer’s CDP Project. It must be between 1 and 100 characters long and can only contain alphanumeric characters and hyphens.
Error: An error response including the code for the type of error and a human-readable message describing the error.
EthValueCriterion: A schema for specifying a criterion for the value field of an EVM transaction.
EthValueCriterionEthValue: The amount of ETH, in wei, that the transaction’s value field should be compared to.
EvmAccount: EvmAccount
EvmAccountAddress: The 0x-prefixed, checksum EVM address.
EvmAccountName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names are guaranteed to be unique across all EVM accounts in the developer’s CDP Project.
EvmAccountPoliciesItem: EvmAccountPoliciesItem
EvmAddressCriterion: A schema for specifying a criterion for the to field of an EVM transaction.
EvmAddressCriterionAddressesItem: The 0x-prefixed EVM address that the transaction’s to field should be compared to.
EvmCall: EvmCall
EvmCallData: The call data to send. This is the hex-encoded data of the function call consisting of the method selector and the function arguments.
EvmCallTo: The address the call is directed to.
EvmDataCondition: A single condition to apply against the function and encoded arguments in the transaction’s data field. Each parameter configuration must be successfully evaluated against the corresponding function argument in order for a policy to be accepted.
EvmDataCriterion: A schema for specifying a criterion for the data field of an EVM transaction.
EvmDataParameterCondition: EvmDataParameterCondition
EvmDataParameterConditionList: EvmDataParameterConditionList
EvmEip7702DelegationOperation: The status of an EIP-7702 delegation operation.
EvmEip7702DelegationOperationDelegateAddress: The address the account has delegated to, if any. Only present when the account has an active delegation.
EvmEip7702DelegationOperationTransactionHash: The hash of the delegation transaction, if available. Present once the transaction has been submitted to the network.
EvmMessageCriterion: A schema for specifying a criterion for the message being signed.
EvmNetworkCriterion: A schema for specifying a criterion for the intended network of an EVM transaction.
EvmSmartAccount: EvmSmartAccount
EvmSmartAccountAddress: The 0x-prefixed, checksum address of the Smart Account.
EvmSmartAccountName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names are guaranteed to be unique across all Smart Accounts in the developer’s CDP Project.
EvmSmartAccountOwnersItem: EvmSmartAccountOwnersItem
EvmSmartAccountPoliciesItem: EvmSmartAccountPoliciesItem
EvmTypedAddressCondition: A schema for specifying criterion for an address field of an EVM typed message. The address can be deeply nested within the typed data’s message.
EvmTypedAddressConditionAddressesItem: The 0x-prefixed EVM address that the value located at the message’s path should be compared to.
EvmTypedNumericalCondition: A schema for specifying criterion for a numerical field of an EVM typed message. The value can be deeply nested within the typed data’s message.
EvmTypedNumericalConditionValue: The amount that the value located at the message’s path should be compared to.
EvmTypedStringCondition: A schema for specifying criterion for a string field of an EVM typed message. The value can be deeply nested within the typed data’s message.
EvmUserOperation: EvmUserOperation
EvmUserOperationTransactionHash: The hash of the transaction that included this particular user operation. This gets set after the user operation is broadcasted and the transaction is included in a block.
EvmUserOperationUserOpHash: The hash of the user operation. This is not the transaction hash, as a transaction consists of multiple user operations. The user operation hash is the hash of this particular user operation which gets signed by the owner of the Smart Account.
ExportEvmAccountAddress: ExportEvmAccountAddress
ExportEvmAccountBody: ExportEvmAccountBody
ExportEvmAccountByNameBody: ExportEvmAccountByNameBody
ExportEvmAccountByNameResponse: ExportEvmAccountByNameResponse
ExportEvmAccountByNameXIdempotencyKey: ExportEvmAccountByNameXIdempotencyKey
ExportEvmAccountResponse: ExportEvmAccountResponse
ExportEvmAccountXIdempotencyKey: ExportEvmAccountXIdempotencyKey
ExportSolanaAccountAddress: ExportSolanaAccountAddress
ExportSolanaAccountBody: ExportSolanaAccountBody
ExportSolanaAccountByNameBody: ExportSolanaAccountByNameBody
ExportSolanaAccountByNameResponse: ExportSolanaAccountByNameResponse
ExportSolanaAccountByNameXIdempotencyKey: ExportSolanaAccountByNameXIdempotencyKey
ExportSolanaAccountResponse: ExportSolanaAccountResponse
ExportSolanaAccountXIdempotencyKey: ExportSolanaAccountXIdempotencyKey
FromAmount: The amount of the fromToken to send in atomic units of the token. For example, 1000000000000000000 when sending ETH equates to 1 ETH, 1000000 when sending USDC equates to 1 USDC, etc.
FromToken: The 0x-prefixed contract address of the token to send.
GasPrice: The target gas price for the swap transaction, in Wei. For EIP-1559 transactions, this value should be seen as the maxFeePerGas value. If not provided, the API will use an estimate based on the current network conditions.
GetEndUserUserId: GetEndUserUserId
GetEvmAccountAddress: GetEvmAccountAddress
GetEvmSmartAccountAddress: GetEvmSmartAccountAddress
GetOnrampOrderByIdResponse: GetOnrampOrderByIdResponse
GetOnrampUserLimitsBody: GetOnrampUserLimitsBody
GetOnrampUserLimitsResponse: GetOnrampUserLimitsResponse
GetPolicyByIdPolicyId: GetPolicyByIdPolicyId
GetSolanaAccountAddress: GetSolanaAccountAddress
GetSwapPriceResponse: GetSwapPriceResponse
GetSwapPriceResponseBlockNumber: The block number at which the liquidity conditions were examined.
GetSwapPriceResponseFees: The estimated fees for the swap.
GetSwapPriceResponseFromAmount: The amount of the fromToken that will be sent in this swap, in atomic units of the fromToken. For example, 1000000000000000000 when sending ETH equates to 1 ETH, 1000000 when sending USDC equates to 1 USDC, etc.
GetSwapPriceResponseFromToken: The 0x-prefixed contract address of the token that will be sent.
GetSwapPriceResponseGas: The estimated gas limit that should be used to send the transaction to guarantee settlement.
GetSwapPriceResponseGasPrice: The gas price, in Wei, that should be used to send the transaction. For EIP-1559 transactions, this value should be seen as the maxFeePerGas value. The transaction should be sent with this gas price to guarantee settlement.
GetSwapPriceResponseIssues: An object containing potential issues discovered during validation that could prevent the swap from being executed successfully.
GetSwapPriceResponseIssuesAllowance: Details of the allowances that the taker must set in order to execute the swap successfully. Null if no allowance is required.
GetSwapPriceResponseIssuesAllowanceCurrentAllowance: The current allowance of the fromToken by the taker.
GetSwapPriceResponseIssuesAllowanceSpender: The 0x-prefixed address of to set the allowance on.
GetSwapPriceResponseIssuesBalance: Details of the balance of the fromToken that the taker must hold. Null if the taker has a sufficient balance.
GetSwapPriceResponseIssuesBalanceCurrentBalance: The current balance of the fromToken by the taker.
GetSwapPriceResponseIssuesBalanceRequiredBalance: The amount of the token that the taker must hold.
GetSwapPriceResponseIssuesBalanceToken: The 0x-prefixed contract address of the token.
GetSwapPriceResponseMinToAmount: The minimum amount of the toToken that must be received for the swap to succeed, in atomic units of the toToken. For example, 1000000000000000000 when receiving ETH equates to 1 ETH, 1000000 when receiving USDC equates to 1 USDC, etc. This value is influenced by the slippageBps parameter.
GetSwapPriceResponseToAmount: The amount of the toToken that will be received in atomic units of the toToken. For example, 1000000000000000000 when receiving ETH equates to 1 ETH, 1000000 when receiving USDC equates to 1 USDC, etc.
GetSwapPriceResponseToToken: The 0x-prefixed contract address of the token that will be received.
GetUserOperationAddress: GetUserOperationAddress
GetUserOperationUserOpHash: GetUserOperationUserOpHash
Idl: IDL Specification following Anchor’s IDL format v0.30+.
IdlInstructionsItem: IdlInstructionsItem
IdlInstructionsItemAccountsItem: IdlInstructionsItemAccountsItem
IdlInstructionsItemArgsItem: IdlInstructionsItemArgsItem
IdlMetadata: Optional metadata about the IDL.
ImportEndUserBody: ImportEndUserBody
ImportEndUserBodyUserId: A stable, unique identifier for the end user. The userId must be unique across all end users in the developer’s CDP Project. It must be between 1 and 100 characters long and can only contain alphanumeric characters and hyphens.
ImportEndUserXIdempotencyKey: ImportEndUserXIdempotencyKey
ImportEvmAccountBody: ImportEvmAccountBody
ImportEvmAccountBodyAccountPolicy: The ID of the account-level policy to apply to the account.
ImportEvmAccountBodyName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names must be unique across all EVM accounts in the developer’s CDP Project.
ImportEvmAccountXIdempotencyKey: ImportEvmAccountXIdempotencyKey
ImportSolanaAccountBody: ImportSolanaAccountBody
ImportSolanaAccountBodyName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names must be unique across all EVM accounts in the developer’s CDP Project.
ImportSolanaAccountXIdempotencyKey: ImportSolanaAccountXIdempotencyKey
ListDataTokenBalancesAddress: ListDataTokenBalancesAddress
ListDataTokenBalancesResponse: ListDataTokenBalancesResponse
ListEndUsersResponse: ListEndUsersResponse
ListEvmAccountsResponse: ListEvmAccountsResponse
ListEvmSmartAccountsResponse: ListEvmSmartAccountsResponse
ListEvmTokenBalancesAddress: ListEvmTokenBalancesAddress
ListEvmTokenBalancesResponse: ListEvmTokenBalancesResponse
ListPoliciesResponse: ListPoliciesResponse
ListResponse: ListResponse
ListSolanaAccountsResponse: ListSolanaAccountsResponse
ListSolanaTokenBalancesAddress: ListSolanaTokenBalancesAddress
ListSolanaTokenBalancesResponse: ListSolanaTokenBalancesResponse
ListSpendPermissionsAddress: ListSpendPermissionsAddress
ListSpendPermissionsResponse: ListSpendPermissionsResponse
ListTokensForAccountAddress: ListTokensForAccountAddress
Metadata: Optional metadata as key-value pairs. Use this to store additional structured information on a resource, such as customer IDs, order references, or any application-specific data. Up to 10 key/value pairs may be provided. Keys and values are both strings. Keys must be ≤ 40 characters; values must be ≤ 500 characters.
MetadataValue: MetadataValue
MfaMethods: Information about the end user’s MFA enrollments.
MfaMethodsSms: An object containing information about the end user’s SMS MFA enrollment.
MfaMethodsTotp: An object containing information about the end user’s TOTP enrollment.
MintAddressCriterion: The criterion for the token mint addresses of a Solana transaction’s SPL token transfer instructions.
MintAddressCriterionAddressesItem: The Solana address that is compared to the list of token mint addresses in the transaction’s accountKeys (for legacy transactions) or staticAccountKeys (for V0 transactions) array.
NetUsdChangeCriterion: A schema for specifying a criterion for the USD denominated asset transfer or exposure for a transaction. This includes native transfers, as well as token transfers.
OAuth2Authentication: Information about an end user who authenticates using a third-party provider.
OnchainDataColumnSchema: Schema definition for a table column.
OnchainDataQuery: Request to execute a SQL query against indexed blockchain data.
OnchainDataQuerySql: SQL query to execute against the indexed blockchain data.
OnchainDataResult: Result of executing a SQL query.
OnchainDataResultMetadata: Metadata about query execution.
OnchainDataResultSchema: Schema information for the query result. This is a derived schema from the query result, so types may not match the underlying table.
OnchainDataResultSchemaColumnsItem: OnchainDataResultSchemaColumnsItem
OnchainDataSchemaResponse: Schema information for available blockchain data tables.
OnchainDataTableSchema: Schema definition for a data table.
OnrampOrder: An Onramp order.
OnrampOrderFee: A fee associated with an order.
OnrampPaymentLink: A payment link to pay for an order.
OnrampQuote: Quote information with pricing details for the crypto purchase.
OnrampSession: An onramp session containing a ready-to-use onramp URL.
OnrampUserLimit: A single limit with remaining capacity.
Policy: Policy
PolicyDescription: An optional human-readable description of the policy. Policy descriptions can consist of alphanumeric characters, spaces, commas, and periods, and be 50 characters or less.
PolicyId: The unique identifier for the policy.
PrepareAndSendUserOperationAddress: PrepareAndSendUserOperationAddress
PrepareAndSendUserOperationBody: PrepareAndSendUserOperationBody
PrepareAndSendUserOperationXIdempotencyKey: PrepareAndSendUserOperationXIdempotencyKey
PrepareUserOperationAddress: PrepareUserOperationAddress
PrepareUserOperationBody: PrepareUserOperationBody
PrepareUserOperationBodyDataSuffix: The EIP-8021 data suffix (hex-encoded) that enables transaction attribution for the user operation.
PrepareUserOperationCriteria: A schema for specifying criteria for the PrepareUserOperation operation.
PrepareUserOperationRule: PrepareUserOperationRule
ProgramIdCriterion: The criterion for the program IDs of a Solana transaction’s instructions.
ProgramIdCriterionProgramIdsItem: The Solana program ID that is compared to the list of program IDs in the transaction’s instructions.
QueryResultCacheConfiguration: Enables control over how often queries need to be fully re-executed on the backing store. This can be useful in scenarios where API calls might be made frequently, API latency is critical, and some freshness lag (ex: 750ms, 2s, 5s) is tolerable. By default, each query result is returned from cache so long as the result is from an identical query and less than 500ms old. This freshness tolerance can be modified upwards, to a maximum of 900000ms (i.e. 900s, 15m).
RequestEvmFaucetBody: RequestEvmFaucetBody
RequestEvmFaucetBodyAddress: The address to request funds to, which is a 0x-prefixed hexadecimal string.
RequestEvmFaucetResponse: RequestEvmFaucetResponse
RequestSolanaFaucetBody: RequestSolanaFaucetBody
RequestSolanaFaucetBodyAddress: The address to request funds to, which is a base58-encoded string.
RequestSolanaFaucetResponse: RequestSolanaFaucetResponse
RevokeDelegationForEndUserBody: RevokeDelegationForEndUserBody
RevokeDelegationForEndUserBodyWalletSecretId: When revoking with a wallet authentication scheme, the ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
RevokeDelegationForEndUserUserId: RevokeDelegationForEndUserUserId
RevokeDelegationForEndUserXIdempotencyKey: RevokeDelegationForEndUserXIdempotencyKey
RevokeSpendPermissionAddress: RevokeSpendPermissionAddress
RevokeSpendPermissionRequest: Request parameters for revoking a Spend Permission.
RevokeSpendPermissionXIdempotencyKey: RevokeSpendPermissionXIdempotencyKey
SendEndUserEvmTransactionCriteria: A schema for specifying criteria for the sendEndUserEvmTransaction operation.
SendEndUserEvmTransactionRule: SendEndUserEvmTransactionRule
SendEndUserSolTransactionCriteria: A schema for specifying criteria for the sendEndUserSolTransaction operation.
SendEndUserSolTransactionRule: SendEndUserSolTransactionRule
SendEvmAssetWithEndUserAccountBody: SendEvmAssetWithEndUserAccountBody
SendEvmAssetWithEndUserAccountBodyAmount: The amount of USDC to send as a decimal string (e.g., “1.5” or “25.50”).
SendEvmAssetWithEndUserAccountBodyWalletSecretId: Required when not using delegated signing. The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
SendEvmAssetWithEndUserAccountProjectId: SendEvmAssetWithEndUserAccountProjectId
SendEvmAssetWithEndUserAccountResponse: SendEvmAssetWithEndUserAccountResponse
SendEvmAssetWithEndUserAccountUserId: SendEvmAssetWithEndUserAccountUserId
SendEvmAssetWithEndUserAccountXIdempotencyKey: SendEvmAssetWithEndUserAccountXIdempotencyKey
SendEvmTransactionAddress: SendEvmTransactionAddress
SendEvmTransactionBody: SendEvmTransactionBody
SendEvmTransactionCriteria: A schema for specifying criteria for the SignEvmTransaction operation.
SendEvmTransactionResponse: SendEvmTransactionResponse
SendEvmTransactionRule: SendEvmTransactionRule
SendEvmTransactionWithEndUserAccountBody: SendEvmTransactionWithEndUserAccountBody
SendEvmTransactionWithEndUserAccountBodyAddress: The 0x-prefixed address of the EVM account belonging to the end user.
SendEvmTransactionWithEndUserAccountBodyWalletSecretId: Required when not using delegated signing. The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
SendEvmTransactionWithEndUserAccountProjectId: SendEvmTransactionWithEndUserAccountProjectId
SendEvmTransactionWithEndUserAccountResponse: SendEvmTransactionWithEndUserAccountResponse
SendEvmTransactionWithEndUserAccountUserId: SendEvmTransactionWithEndUserAccountUserId
SendEvmTransactionWithEndUserAccountXIdempotencyKey: SendEvmTransactionWithEndUserAccountXIdempotencyKey
SendEvmTransactionXIdempotencyKey: SendEvmTransactionXIdempotencyKey
SendSolTransactionCriteria: A schema for specifying criteria for the SendSolTransaction operation.
SendSolTransactionRule: SendSolTransactionRule
SendSolanaAssetWithEndUserAccountBody: SendSolanaAssetWithEndUserAccountBody
SendSolanaAssetWithEndUserAccountBodyAmount: The amount of USDC to send as a decimal string (e.g., “1.5” or “25.50”).
SendSolanaAssetWithEndUserAccountBodyWalletSecretId: Required when not using delegated signing. The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
SendSolanaAssetWithEndUserAccountProjectId: SendSolanaAssetWithEndUserAccountProjectId
SendSolanaAssetWithEndUserAccountResponse: SendSolanaAssetWithEndUserAccountResponse
SendSolanaAssetWithEndUserAccountUserId: SendSolanaAssetWithEndUserAccountUserId
SendSolanaAssetWithEndUserAccountXIdempotencyKey: SendSolanaAssetWithEndUserAccountXIdempotencyKey
SendSolanaTransactionBody: SendSolanaTransactionBody
SendSolanaTransactionResponse: SendSolanaTransactionResponse
SendSolanaTransactionWithEndUserAccountBody: SendSolanaTransactionWithEndUserAccountBody
SendSolanaTransactionWithEndUserAccountBodyAddress: The base58 encoded address of the Solana account belonging to the end user.
SendSolanaTransactionWithEndUserAccountBodyWalletSecretId: Required when not using delegated signing. The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
SendSolanaTransactionWithEndUserAccountProjectId: SendSolanaTransactionWithEndUserAccountProjectId
SendSolanaTransactionWithEndUserAccountResponse: SendSolanaTransactionWithEndUserAccountResponse
SendSolanaTransactionWithEndUserAccountUserId: SendSolanaTransactionWithEndUserAccountUserId
SendSolanaTransactionWithEndUserAccountXIdempotencyKey: SendSolanaTransactionWithEndUserAccountXIdempotencyKey
SendSolanaTransactionXIdempotencyKey: SendSolanaTransactionXIdempotencyKey
SendUserOperationAddress: SendUserOperationAddress
SendUserOperationBody: SendUserOperationBody
SendUserOperationCriteria: A schema for specifying criteria for the SendUserOperation operation.
SendUserOperationRule: SendUserOperationRule
SendUserOperationUserOpHash: SendUserOperationUserOpHash
SendUserOperationWithEndUserAccountAddress: SendUserOperationWithEndUserAccountAddress
SendUserOperationWithEndUserAccountBody: SendUserOperationWithEndUserAccountBody
SendUserOperationWithEndUserAccountBodyDataSuffix: The EIP-8021 data suffix (hex-encoded) that enables transaction attribution for the user operation.
SendUserOperationWithEndUserAccountBodyWalletSecretId: Required when not using delegated signing. The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
SendUserOperationWithEndUserAccountProjectId: SendUserOperationWithEndUserAccountProjectId
SendUserOperationWithEndUserAccountUserId: SendUserOperationWithEndUserAccountUserId
SendUserOperationWithEndUserAccountXIdempotencyKey: SendUserOperationWithEndUserAccountXIdempotencyKey
SettleX402PaymentBody: SettleX402PaymentBody
SettleX402PaymentResponse: SettleX402PaymentResponse
SettleX402PaymentResponsePayer: The onchain address of the client that is paying for the resource.
SettleX402PaymentResponseTransaction: The transaction of the settlement. For EVM networks, the transaction will be a 0x-prefixed, EVM transaction hash. For Solana-based networks, the transaction will be a base58-encoded Solana signature.
SignEndUserEvmHashRule: SignEndUserEvmHashRule
SignEndUserEvmMessageCriteria: A schema for specifying criteria for the signEndUserEvmMessage operation.
SignEndUserEvmMessageRule: SignEndUserEvmMessageRule
SignEndUserEvmTransactionCriteria: A schema for specifying criteria for the signEndUserEvmTransaction operation.
SignEndUserEvmTransactionRule: SignEndUserEvmTransactionRule
SignEndUserEvmTypedDataCriteria: A schema for specifying criteria for the signEndUserEvmTypedData operation.
SignEndUserEvmTypedDataRule: SignEndUserEvmTypedDataRule
SignEndUserSolMessageCriteria: A schema for specifying criteria for the signEndUserSolMessage operation.
SignEndUserSolMessageRule: SignEndUserSolMessageRule
SignEndUserSolTransactionCriteria: A schema for specifying criteria for the signEndUserSolTransaction operation.
SignEndUserSolTransactionRule: SignEndUserSolTransactionRule
SignEvmHashAddress: SignEvmHashAddress
SignEvmHashBody: SignEvmHashBody
SignEvmHashResponse: SignEvmHashResponse
SignEvmHashRule: SignEvmHashRule
SignEvmHashXIdempotencyKey: SignEvmHashXIdempotencyKey
SignEvmMessageAddress: SignEvmMessageAddress
SignEvmMessageBody: SignEvmMessageBody
SignEvmMessageCriteria: A schema for specifying the rejection criteria for the SignEvmMessage operation.
SignEvmMessageResponse: SignEvmMessageResponse
SignEvmMessageRule: SignEvmMessageRule
SignEvmMessageWithEndUserAccountBody: SignEvmMessageWithEndUserAccountBody
SignEvmMessageWithEndUserAccountBodyAddress: The 0x-prefixed address of the EVM account belonging to the end user.
SignEvmMessageWithEndUserAccountBodyWalletSecretId: Required when not using delegated signing. The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
SignEvmMessageWithEndUserAccountProjectId: SignEvmMessageWithEndUserAccountProjectId
SignEvmMessageWithEndUserAccountResponse: SignEvmMessageWithEndUserAccountResponse
SignEvmMessageWithEndUserAccountUserId: SignEvmMessageWithEndUserAccountUserId
SignEvmMessageWithEndUserAccountXIdempotencyKey: SignEvmMessageWithEndUserAccountXIdempotencyKey
SignEvmMessageXIdempotencyKey: SignEvmMessageXIdempotencyKey
SignEvmTransactionAddress: SignEvmTransactionAddress
SignEvmTransactionBody: SignEvmTransactionBody
SignEvmTransactionCriteria: A schema for specifying criteria for the SignEvmTransaction operation.
SignEvmTransactionResponse: SignEvmTransactionResponse
SignEvmTransactionRule: SignEvmTransactionRule
SignEvmTransactionWithEndUserAccountBody: SignEvmTransactionWithEndUserAccountBody
SignEvmTransactionWithEndUserAccountBodyAddress: The 0x-prefixed address of the EVM account belonging to the end user.
SignEvmTransactionWithEndUserAccountBodyWalletSecretId: Required when not using delegated signing. The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
SignEvmTransactionWithEndUserAccountProjectId: SignEvmTransactionWithEndUserAccountProjectId
SignEvmTransactionWithEndUserAccountResponse: SignEvmTransactionWithEndUserAccountResponse
SignEvmTransactionWithEndUserAccountUserId: SignEvmTransactionWithEndUserAccountUserId
SignEvmTransactionWithEndUserAccountXIdempotencyKey: SignEvmTransactionWithEndUserAccountXIdempotencyKey
SignEvmTransactionXIdempotencyKey: SignEvmTransactionXIdempotencyKey
SignEvmTypedDataAddress: SignEvmTypedDataAddress
SignEvmTypedDataCriteria: A schema for specifying criteria for the SignEvmTypedData operation.
SignEvmTypedDataFieldCriterion: SignEvmTypedDataFieldCriterion
SignEvmTypedDataFieldCriterionTypes: An object containing EIP-712 type definitions, as well as a primary type for the root message object.
SignEvmTypedDataFieldCriterionTypesTypesValueItem: SignEvmTypedDataFieldCriterionTypesTypesValueItem
SignEvmTypedDataResponse: SignEvmTypedDataResponse
SignEvmTypedDataRule: SignEvmTypedDataRule
SignEvmTypedDataVerifyingContractCriterion: A schema for specifying criterion for a domain’s verifying contract.
SignEvmTypedDataVerifyingContractCriterionAddressesItem: The 0x-prefixed EVM address that the domain’s verifying contract should be compared to.
SignEvmTypedDataWithEndUserAccountBody: SignEvmTypedDataWithEndUserAccountBody
SignEvmTypedDataWithEndUserAccountBodyAddress: The 0x-prefixed address of the EVM account belonging to the end user.
SignEvmTypedDataWithEndUserAccountBodyWalletSecretId: Required when not using delegated signing. The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
SignEvmTypedDataWithEndUserAccountProjectId: SignEvmTypedDataWithEndUserAccountProjectId
SignEvmTypedDataWithEndUserAccountResponse: SignEvmTypedDataWithEndUserAccountResponse
SignEvmTypedDataWithEndUserAccountUserId: SignEvmTypedDataWithEndUserAccountUserId
SignEvmTypedDataWithEndUserAccountXIdempotencyKey: SignEvmTypedDataWithEndUserAccountXIdempotencyKey
SignEvmTypedDataXIdempotencyKey: SignEvmTypedDataXIdempotencyKey
SignSolMessageCriteria: A schema for specifying criteria for the SignSolMessage operation.
SignSolMessageRule: SignSolMessageRule
SignSolTransactionCriteria: A schema for specifying criteria for the SignSolTransaction operation.
SignSolTransactionRule: SignSolTransactionRule
SignSolanaMessageAddress: SignSolanaMessageAddress
SignSolanaMessageBody: SignSolanaMessageBody
SignSolanaMessageResponse: SignSolanaMessageResponse
SignSolanaMessageWithEndUserAccountBody: SignSolanaMessageWithEndUserAccountBody
SignSolanaMessageWithEndUserAccountBodyAddress: The base58 encoded address of the Solana account belonging to the end user.
SignSolanaMessageWithEndUserAccountBodyWalletSecretId: Required when not using delegated signing. The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
SignSolanaMessageWithEndUserAccountProjectId: SignSolanaMessageWithEndUserAccountProjectId
SignSolanaMessageWithEndUserAccountResponse: SignSolanaMessageWithEndUserAccountResponse
SignSolanaMessageWithEndUserAccountUserId: SignSolanaMessageWithEndUserAccountUserId
SignSolanaMessageWithEndUserAccountXIdempotencyKey: SignSolanaMessageWithEndUserAccountXIdempotencyKey
SignSolanaMessageXIdempotencyKey: SignSolanaMessageXIdempotencyKey
SignSolanaTransactionAddress: SignSolanaTransactionAddress
SignSolanaTransactionBody: SignSolanaTransactionBody
SignSolanaTransactionResponse: SignSolanaTransactionResponse
SignSolanaTransactionWithEndUserAccountBody: SignSolanaTransactionWithEndUserAccountBody
SignSolanaTransactionWithEndUserAccountBodyAddress: The base58 encoded address of the Solana account belonging to the end user.
SignSolanaTransactionWithEndUserAccountBodyWalletSecretId: Required when not using delegated signing. The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
SignSolanaTransactionWithEndUserAccountProjectId: SignSolanaTransactionWithEndUserAccountProjectId
SignSolanaTransactionWithEndUserAccountResponse: SignSolanaTransactionWithEndUserAccountResponse
SignSolanaTransactionWithEndUserAccountUserId: SignSolanaTransactionWithEndUserAccountUserId
SignSolanaTransactionWithEndUserAccountXIdempotencyKey: SignSolanaTransactionWithEndUserAccountXIdempotencyKey
SignSolanaTransactionXIdempotencyKey: SignSolanaTransactionXIdempotencyKey
SignerAddress: The 0x-prefixed Externally Owned Account (EOA) address that will sign the Permit2 EIP-712 permit message. This is only needed if taker is a smart contract.
SiweAuthentication: Information about an end user who authenticates using Sign In With Ethereum (EIP-4361).
SlippageBps: The maximum acceptable slippage of the toToken in basis points. If this parameter is set to 0, no slippage will be tolerated. If not provided, the default slippage tolerance is 100 bps (i.e., 1%).
SmsAuthentication: Information about an end user who authenticates using a one-time password sent to their phone number via SMS.
SmsAuthenticationPhoneNumber: The phone number of the end user in E.164 format.
SolAddressCriterion: The criterion for the recipient addresses of a Solana transaction’s native transfer instruction.
SolAddressCriterionAddressesItem: The Solana address that is compared to the list of native transfer recipient addresses in the transaction’s accountKeys (for legacy transactions) or staticAccountKeys (for V0 transactions) array.
SolDataCondition: A single condition to apply against a specific instruction type and its parameters.
SolDataCriterion: A schema for specifying criterion for instruction data in a Solana transaction.
SolDataParameterCondition: A single parameter condition to apply against a specific instruction’s parameters.
SolDataParameterConditionList: A single parameter condition to apply against a specific instruction’s parameters.
SolMessageCriterion: The criterion for the message of a Solana transaction.
SolNetworkCriterion: The criterion for the Solana network of a transaction.
SolValueCriterion: The criterion for the SOL value in lamports of a native transfer instruction in a Solana transaction.
SolanaAccount: SolanaAccount
SolanaAccountAddress: The base58 encoded Solana address.
SolanaAccountName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names are guaranteed to be unique across all Solana accounts in the developer’s CDP Project.
SolanaAccountPoliciesItem: SolanaAccountPoliciesItem
SolanaToken: General information about a Solana token. Includes the mint address, and other identifying information.
SolanaTokenAmount: Amount of a given Solana token.
SolanaTokenAmountAmount: The amount is denominated in the smallest indivisible unit of the token. For SOL, the smallest indivisible unit is lamports (10^-9 SOL). For SPL tokens, the smallest unit is defined by the token’s decimals configuration.
SolanaTokenBalance: SolanaTokenBalance
SolanaTokenMintAddress: The mint address of the token. For native SOL, the mint address is So11111111111111111111111111111111111111111. For SPL tokens, this is the mint address where the token is defined.
SpendPermission: The core spend permission.
SpendPermissionAccount: Smart account this spend permission is valid for.
SpendPermissionResponseObject: SpendPermissionResponseObject
SpendPermissionSpender: Entity that can spend account’s tokens.
SpendPermissionToken: Token address (ERC-7528 native token address or ERC-20 contract).
SplAddressCriterion: The criterion for the recipient addresses of a Solana transaction’s SPL token transfer instructions.
SplAddressCriterionAddressesItem: The Solana address that is compared to the list of SPL token transfer recipient addresses in the transaction’s accountKeys (for legacy transactions) or staticAccountKeys (for V0 transactions) array.
SplValueCriterion: The criterion for the SPL token value of a SPL token transfer instruction in a Solana transaction.
SupportedX402PaymentKindsResponse: SupportedX402PaymentKindsResponse
SwapUnavailableResponse: SwapUnavailableResponse
Taker: The 0x-prefixed address that holds the fromToken balance and has the Permit2 allowance set for the swap.
TelegramAuthentication: Information about an end user who authenticates using Telegram.
ToToken: The 0x-prefixed contract address of the token to receive.
Token: General information about a token. Includes the type, the network, and other identifying information.
TokenAmount: Amount of a given token.
TokenAmountAmount: The amount is denominated in the smallest indivisible unit of the token. For ETH, the smallest indivisible unit is Wei (10^-18 ETH). For ERC-20s, the smallest unit is the unit returned from function totalSupply() public view returns (uint256).
TokenBalance: TokenBalance
TokenContractAddress: The contract address of the token. For Ether, the contract address is 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE per EIP-7528. For ERC-20 tokens, this is the contract address where the token is deployed.
TokenFee: TokenFee
TokenFeeAmount: The estimated amount of the fee in atomic units of the token. For example, 1000000000000000 if the fee is in ETH equates to 0.001 ETH, 10000 if the fee is in USDC equates to 0.01 USDC, etc.
TokenFeeToken: The contract address of the token that the fee is paid in. The address 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE is used for the native token of the network (e.g. ETH).
UpdateEvmAccountAddress: UpdateEvmAccountAddress
UpdateEvmAccountBody: UpdateEvmAccountBody
UpdateEvmAccountBodyAccountPolicy: The ID of the account-level policy to apply to the account, or an empty string to unset attached policy.
UpdateEvmAccountBodyName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names must be unique across all EVM accounts in the developer’s CDP Project.
UpdateEvmAccountXIdempotencyKey: UpdateEvmAccountXIdempotencyKey
UpdateEvmSmartAccountAddress: UpdateEvmSmartAccountAddress
UpdateEvmSmartAccountBody: UpdateEvmSmartAccountBody
UpdateEvmSmartAccountBodyName: An optional name for the smart account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names must be unique across all EVM smart accounts in the developer’s CDP Project.
UpdatePolicyBody: UpdatePolicyBody
UpdatePolicyBodyDescription: An optional human-readable description for the policy. Policy descriptions can consist of alphanumeric characters, spaces, commas, and periods, and be 50 characters or less.
UpdatePolicyPolicyId: UpdatePolicyPolicyId
UpdatePolicyXIdempotencyKey: UpdatePolicyXIdempotencyKey
UpdateSolanaAccountAddress: UpdateSolanaAccountAddress
UpdateSolanaAccountBody: UpdateSolanaAccountBody
UpdateSolanaAccountBodyAccountPolicy: The ID of the account-level policy to apply to the account, or an empty string to unset attached policy.
UpdateSolanaAccountBodyName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names must be unique across all Solana accounts in the developer’s CDP Project.
UpdateSolanaAccountXIdempotencyKey: UpdateSolanaAccountXIdempotencyKey
Uri: A valid URI.
Url: A valid HTTP or HTTPS URL.
UserOperationReceipt: The receipt that contains information about the execution of user operation.
UserOperationReceiptBlockHash: The block hash of the block including the transaction as 0x-prefixed string.
UserOperationReceiptRevert: The revert data if the user operation has reverted.
UserOperationReceiptRevertData: The 0x-prefixed raw hex string.
UserOperationReceiptTransactionHash: The hash of this transaction as 0x-prefixed string.
ValidateEndUserAccessTokenBody: The request body for a developer to verify an end user’s access token.
VerifyX402PaymentBody: VerifyX402PaymentBody
VerifyX402PaymentResponse: VerifyX402PaymentResponse
VerifyX402PaymentResponsePayer: The onchain address of the client that is paying for the resource.
WebhookEventListResponse: Response containing a list of webhook event delivery attempts.
WebhookEventResponse: Details of a webhook event delivery attempt for a subscription.
WebhookEventResponseDetail: Details of the HTTP response received from the webhook target.
WebhookSubscriptionListResponse: WebhookSubscriptionListResponse
WebhookSubscriptionRequest: Request to create a new webhook subscription with support for multi-label filtering.
WebhookSubscriptionResponse: Response containing webhook subscription details.
WebhookSubscriptionResponseMetadata: Additional metadata for the subscription.
WebhookSubscriptionResponseMetadataExtraValue: WebhookSubscriptionResponseMetadataExtraValue
WebhookSubscriptionUpdateRequest: Request to update an existing webhook subscription.
WebhookTarget: Target configuration for webhook delivery. Specifies the destination URL and any custom headers to include in webhook requests.
X402ExactEvmPayload: The x402 protocol exact scheme payload for EVM networks. The scheme is implemented using ERC-3009. For more details, please see EVM Exact Scheme Details.
X402ExactEvmPayloadAuthorization: The authorization data for the ERC-3009 authorization message.
X402ExactEvmPayloadAuthorizationFrom: The 0x-prefixed, checksum EVM address of the sender of the payment.
X402ExactEvmPayloadAuthorizationNonce: The hex-encoded nonce of the payment (bytes32).
X402ExactEvmPayloadAuthorizationTo: The 0x-prefixed, checksum EVM address of the recipient of the payment.
X402ExactEvmPayloadSignature: The EIP-712 hex-encoded signature of the ERC-3009 authorization message. Smart account signatures may be longer than 65 bytes.
X402ExactEvmPermit2Payload: The x402 protocol exact scheme payload for EVM networks using Permit2. Permit2 is a universal token approval mechanism that works with any ERC-20 token, unlike ERC-3009 which requires token-level support.
X402ExactEvmPermit2PayloadPermit2Authorization: The authorization data for the Permit2 PermitWitnessTransferFrom message.
X402ExactEvmPermit2PayloadPermit2AuthorizationFrom: The 0x-prefixed, checksum EVM address of the sender of the payment.
X402ExactEvmPermit2PayloadPermit2AuthorizationNonce: The Permit2 nonce as a decimal string (uint256).
X402ExactEvmPermit2PayloadPermit2AuthorizationPermitted: The token permissions for the transfer.
X402ExactEvmPermit2PayloadPermit2AuthorizationPermittedToken: The 0x-prefixed, checksum EVM address of the token to transfer.
X402ExactEvmPermit2PayloadPermit2AuthorizationSpender: The 0x-prefixed, checksum EVM address of the spender (x402 Permit2 proxy contract).
X402ExactEvmPermit2PayloadPermit2AuthorizationWitness: The witness data containing payment details.
X402ExactEvmPermit2PayloadPermit2AuthorizationWitnessExtra: Optional hex-encoded extra data.
X402ExactEvmPermit2PayloadPermit2AuthorizationWitnessTo: The 0x-prefixed, checksum EVM address of the recipient.
X402ExactEvmPermit2PayloadSignature: The EIP-712 hex-encoded signature of the Permit2 PermitWitnessTransferFrom message. Smart account signatures may be longer than 65 bytes.
X402ExactSolanaPayload: The x402 protocol exact scheme payload for Solana networks. For more details, please see Solana Exact Scheme Details.
X402ResourceInfo: Describes the resource being accessed in x402 protocol.
X402SettlePaymentRejection: The result when x402 payment settlement fails.
X402SettlePaymentRejectionPayer: The onchain address of the client that is paying for the resource.
X402SettlePaymentRejectionTransaction: The transaction of the settlement. For EVM networks, the transaction will be a 0x-prefixed, EVM transaction hash. For Solana-based networks, the transaction will be a base58-encoded Solana signature.
X402SupportedPaymentKind: The supported payment kind for the x402 protocol. A kind is comprised of a scheme and a network, which together uniquely identify a way to move money on the x402 protocol. For more details, please see x402 Schemes.
X402V1PaymentPayload: The x402 protocol payment payload that the client attaches to x402-paid API requests to the resource server in the X-PAYMENT header.
X402V1PaymentRequirements: The x402 protocol payment requirements that the resource server expects the client’s payment payload to meet.
X402V2PaymentPayload: The x402 protocol payment payload that the client attaches to x402-paid API requests to the resource server in the X-PAYMENT header.
X402V2PaymentRequirements: The x402 protocol payment requirements that the resource server expects the client’s payment payload to meet.
X402VerifyPaymentRejection: The result when x402 payment verification fails.
X402VerifyPaymentRejectionPayer: The onchain address of the client that is paying for the resource.
X402Version: The version of the x402 protocol.
X402v1PaymentRequirementsAsset: The asset to pay with.
X402v1PaymentRequirementsPayTo: The destination to pay value to.
X402v2PaymentRequirementsAsset: The asset to pay with.
X402v2PaymentRequirementsPayTo: The destination to pay value to.

Enums§

AbiFunctionType: The type of the ABI item, must be function.
AbiInputType: The type of the ABI item.
AbiItem: AbiItem
AbiStateMutability: State mutability of a function in Solidity.
AuthenticationMethod: Information about how the end user is authenticated.
CreatePolicyBodyScope: The scope of the policy.
CreateSwapQuoteResponseWrapper: A wrapper for the response of a swap quote operation.
DeveloperJwtAuthenticationType: The type of authentication information.
EmailAuthenticationType: The type of authentication information.
ErrorType: The code that indicates the type of error that occurred. These error codes can be used to determine how to handle the error.
EthValueCriterionOperator: The operator to use for the comparison. The transaction’s value field will be on the left-hand side of the operator, and the ethValue field will be on the right-hand side.
EthValueCriterionType: The type of criterion to use. This should be ethValue.
EvmAddressCriterionOperator: The operator to use for the comparison. The transaction’s to field will be on the left-hand side of the operator, and the addresses field will be on the right-hand side.
EvmAddressCriterionType: The type of criterion to use. This should be evmAddress.
EvmDataConditionParamsItem: A list of parameter conditions to apply against encoded arguments in the transaction’s data field.
EvmDataCriterionAbi: The ABI of the smart contract being called. This can be a partial structure with only specific functions.
EvmDataCriterionType: The type of criterion to use. This should be evmData.
EvmDataParameterConditionListOperator: The operator to use for the comparison. The value resolved at the name will be on the left-hand side of the operator, and the values field will be on the right-hand side.
EvmDataParameterConditionOperator: The operator to use for the comparison. The value resolved at the name will be on the left-hand side of the operator, and the value field will be on the right-hand side.
EvmEip7702DelegationNetwork: The network for the EIP-7702 delegation.
EvmEip7702DelegationOperationStatus: The current status of the delegation operation. UNSPECIFIED means the status has not been set. PENDING means the operation has been created but not yet submitted. SUBMITTED means the operation has been submitted to the network. COMPLETED means the operation has completed successfully. FAILED means the operation has failed.
EvmMessageCriterionType: The type of criterion to use. This should be evmMessage.
EvmNetworkCriterionNetworksItem: The network the transaction is for.
EvmNetworkCriterionOperator: The operator to use for the comparison. The transaction’s intended network will be on the left-hand side of the operator, and the networks field will be on the right-hand side.
EvmNetworkCriterionType: The type of criterion to use. This should be evmNetwork.
EvmSwapsNetwork: The network on which to perform the swap.
EvmTypedAddressConditionOperator: The operator to use for the comparison. The value located at the message’s path will be on the left-hand side of the operator, and the addresses field will be on the right-hand side.
EvmTypedNumericalConditionOperator: The operator to use for the comparison. The value located at the message’s path will be on the left-hand side of the operator, and the value field will be on the right-hand side.
EvmUserOperationNetwork: The network the user operation is for.
EvmUserOperationStatus: The status of the user operation.
GetSqlSchemaDatabase: GetSqlSchemaDatabase
GetSwapPriceResponseWrapper: A wrapper for the response of a swap price operation.
ImportEndUserBodyKeyType: The type of key being imported. Determines what type of account will be associated for the end user.
KnownAbiType: A reference to an established EIP standard. When referencing a KnownAbiType within a policy rule configuring an EvmDataCriterion, criteria will only decode function data officially documented in the standard. For more information on supported token standards, see the links below. - erc20 - Token Standard. - erc721 - Non-Fungible Token Standard. - erc1155 - Multi Token Standard.
KnownIdlType: A reference to an established Solana program. When referencing a KnownIdlType within a policy rule configuring an SolDataCriterion, criteria will decode instruction data as documented in the programs. For more information on supported programs, see the links below. - SystemProgram. - TokenProgram. - AssociatedTokenProgram.
ListEndUsersSortItem: ListEndUsersSortItem
ListEvmTokenBalancesNetwork: The name of the supported EVM networks in human-readable format.
ListPoliciesScope: ListPoliciesScope
ListSolanaTokenBalancesNetwork: The name of the supported Solana networks in human-readable format.
ListTokensForAccountNetwork: ListTokensForAccountNetwork
MintAddressCriterionOperator: The operator to use for the comparison. Each of the token mint addresses in the transaction’s accountKeys (for legacy transactions) or staticAccountKeys (for V0 transactions) array will be on the left-hand side of the operator, and the addresses field will be on the right-hand side.
MintAddressCriterionType: The type of criterion to use. This should be mintAddress.
NetUsdChangeCriterionOperator: The operator to use for the comparison. The total value of a transaction’s asset transfer will be on the left-hand side of the operator, and the changeCents field will be on the right-hand side.
NetUsdChangeCriterionType: The type of criterion to use. This should be netUSDChange.
OAuth2ProviderType: The type of OAuth2 provider.
OnchainDataResultSchemaColumnsItemType: Column data type (ClickHouse types).
OnrampLimitType: The type of limit: - weekly_spending: Rolling 7-day spending limit. The limit applies to the sum of all completed transactions within a sliding 168-hour (7-day) window. As time passes, older transactions naturally expire from the window. $500 is the default limit. - lifetime_transactions: All-time transaction count limit. Tracks the total number of completed transactions across the user’s entire history with no time-based expiration. Once the limit is reached, no further transactions are allowed. 15 is the default limit.
OnrampOrderFeeType: The type of fee.
OnrampOrderPaymentMethodTypeId: The type of payment method to be used to complete an onramp order.
OnrampOrderStatus: The status of an onramp order.
OnrampPaymentLinkType: The type of payment link.
OnrampQuotePaymentMethodTypeId: The type of payment method used to generate the onramp quote.
OnrampUserIdType: The type of user identifier: - phone_number: A phone number in E.164 format associated with an onramp user.
PolicyScope: The scope of the policy. Only one project-level policy can exist at any time.
PrepareUserOperationCriteriaItem: PrepareUserOperationCriteriaItem
PrepareUserOperationRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
PrepareUserOperationRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
ProgramIdCriterionOperator: The operator to use for the comparison. Each of the program IDs in the transaction’s instructions will be on the left-hand side of the operator, and the programIds field will be on the right-hand side.
ProgramIdCriterionType: The type of criterion to use. This should be programId.
RequestEvmFaucetBodyNetwork: The network to request funds from.
RequestEvmFaucetBodyToken: The token to request funds for.
RequestSolanaFaucetBodyToken: The token to request funds for.
Rule: A rule that limits the behavior of an account.
SendEndUserEvmTransactionCriteriaItem: SendEndUserEvmTransactionCriteriaItem
SendEndUserEvmTransactionRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SendEndUserEvmTransactionRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SendEndUserSolTransactionCriteriaItem: SendEndUserSolTransactionCriteriaItem
SendEndUserSolTransactionRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SendEndUserSolTransactionRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SendEvmAssetWithEndUserAccountBodyNetwork: The EVM network to send USDC on.
SendEvmTransactionBodyNetwork: The network to send the transaction to.
SendEvmTransactionCriteriaItem: SendEvmTransactionCriteriaItem
SendEvmTransactionRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SendEvmTransactionRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SendEvmTransactionWithEndUserAccountBodyNetwork: The network to send the transaction to.
SendSolTransactionCriteriaItem: SendSolTransactionCriteriaItem
SendSolTransactionRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SendSolTransactionRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SendSolanaAssetWithEndUserAccountBodyNetwork: The Solana network to send USDC on.
SendSolanaTransactionBodyNetwork: The Solana network to send the transaction to.
SendSolanaTransactionWithEndUserAccountBodyNetwork: The Solana network to send the transaction to.
SendUserOperationCriteriaItem: SendUserOperationCriteriaItem
SendUserOperationRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SendUserOperationRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SettleX402PaymentError
SignEndUserEvmHashRuleAction: Whether any attempts to sign a hash will be accepted or rejected. This rule does not accept any criteria.
SignEndUserEvmHashRuleOperation: The operation to which the rule applies.
SignEndUserEvmMessageRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SignEndUserEvmMessageRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SignEndUserEvmTransactionCriteriaItem: SignEndUserEvmTransactionCriteriaItem
SignEndUserEvmTransactionRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SignEndUserEvmTransactionRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SignEndUserEvmTypedDataCriteriaItem: SignEndUserEvmTypedDataCriteriaItem
SignEndUserEvmTypedDataRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SignEndUserEvmTypedDataRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SignEndUserSolMessageRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SignEndUserSolMessageRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SignEndUserSolTransactionCriteriaItem: SignEndUserSolTransactionCriteriaItem
SignEndUserSolTransactionRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SignEndUserSolTransactionRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SignEvmHashRuleAction: Whether any attempts to sign a hash will be accepted or rejected. This rule does not accept any criteria.
SignEvmHashRuleOperation: The operation to which the rule applies.
SignEvmMessageRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SignEvmMessageRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SignEvmTransactionCriteriaItem: SignEvmTransactionCriteriaItem
SignEvmTransactionRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SignEvmTransactionRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SignEvmTypedDataCriteriaItem: SignEvmTypedDataCriteriaItem
SignEvmTypedDataFieldCriterionConditionsItem: SignEvmTypedDataFieldCriterionConditionsItem
SignEvmTypedDataFieldCriterionType: The type of criterion to use. This should be evmTypedDataField.
SignEvmTypedDataRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SignEvmTypedDataRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SignEvmTypedDataVerifyingContractCriterionOperator: The operator to use for the comparison. The domain’s verifying contract will be on the left-hand side of the operator, and the addresses field will be on the right-hand side.
SignEvmTypedDataVerifyingContractCriterionType: The type of criterion to use. This should be evmTypedDataVerifyingContract.
SignSolMessageRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SignSolMessageRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SignSolTransactionCriteriaItem: SignSolTransactionCriteriaItem
SignSolTransactionRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SignSolTransactionRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SiweAuthenticationType: The type of authentication information.
SmsAuthenticationType: The type of authentication information.
SolAddressCriterionOperator: The operator to use for the comparison. Each of the native transfer recipient addresses in the transaction’s accountKeys (for legacy transactions) or staticAccountKeys (for V0 transactions) array will be on the left-hand side of the operator, and the addresses field will be on the right-hand side.
SolAddressCriterionType: The type of criterion to use. This should be solAddress.
SolDataConditionParamsItem: A list of parameter conditions to apply against a specific instruction’s data.
SolDataCriterionIdlsItem: SolDataCriterionIdlsItem
SolDataCriterionType: The type of criterion to use. This should be solData.
SolDataParameterConditionListOperator: The operator to use for the comparison. The value resolved at the name will be on the left-hand side of the operator, and the value field will be on the right-hand side.
SolDataParameterConditionOperator: The operator to use for the comparison. The value resolved at the name will be on the left-hand side of the operator, and the value field will be on the right-hand side.
SolMessageCriterionType: The type of criterion to use. This should be solMessage.
SolNetworkCriterionNetworksItem: The Solana network the transaction is for.
SolNetworkCriterionOperator: The operator to use for the comparison. The transaction’s intended network will be on the left-hand side of the operator, and the networks field will be on the right-hand side.
SolNetworkCriterionType: The type of criterion to use. This should be solNetwork.
SolValueCriterionOperator: The operator to use for the comparison. The transaction instruction’s value field will be on the left-hand side of the operator, and the solValue field will be on the right-hand side.
SolValueCriterionType: The type of criterion to use. This should be solValue.
SpendPermissionNetwork: The network the spend permission is on.
SplAddressCriterionOperator: The operator to use for the comparison. Each of the SPL token transfer recipient addresses in the transaction’s accountKeys (for legacy transactions) or staticAccountKeys (for V0 transactions) array will be on the left-hand side of the operator, and the addresses field will be on the right-hand side.
SplAddressCriterionType: The type of criterion to use. This should be splAddress.
SplValueCriterionOperator: The operator to use for the comparison. The transaction instruction’s value field will be on the left-hand side of the operator, and the splValue field will be on the right-hand side.
SplValueCriterionType: The type of criterion to use. This should be splValue.
VerifyX402PaymentError
WebhookEventResponseStatus: Current delivery status of the event.
X402PaymentPayload: The x402 protocol payment payload that the client attaches to x402-paid API requests to the resource server in the X-PAYMENT header. For EVM networks, smart account signatures can be longer than 65 bytes.
X402PaymentRequirements: The x402 protocol payment requirements that the resource server expects the client’s payment payload to meet.
X402SettleErrorReason: The reason the payment settlement errored on the x402 protocol.
X402SupportedPaymentKindNetwork: The network of the blockchain.
X402SupportedPaymentKindScheme: The scheme of the payment protocol.
X402VerifyInvalidReason: The reason the payment is invalid on the x402 protocol.
X402v1PaymentPayloadNetwork: The network of the blockchain to send payment on.
X402v1PaymentPayloadPayload: The payload of the payment depending on the x402Version, scheme, and network.
X402v1PaymentPayloadScheme: The scheme of the payment protocol to use. Currently, the only supported scheme is exact.
X402v1PaymentRequirementsNetwork: The network of the blockchain to send payment on.
X402v1PaymentRequirementsScheme: The scheme of the payment protocol to use. Currently, the only supported scheme is exact.
X402v2PaymentPayloadPayload: The payload of the payment depending on the x402Version, scheme, and network.
X402v2PaymentRequirementsScheme: The scheme of the payment protocol to use. Supported schemes are exact and upto.

Module types

Module types Copy item path

Modules§

Structs§

Enums§

Module types