Copy Page
Bitpanda Enterprise
Bitpanda Enterprise
Getting Started
Overview
Authentication
Versioning and API Changes
Changelog
REST API Endpoints
Overview
Auth Tokens
Obtain a Refresh and Access Tokens
Revoke a Refresh Token
User Administration
Individual Users
Create new user
Get user list v2
Search for users
Get user details v2
Update an existing user
Get user details
Off-boarding user
Inactivate user
Get user accepted Terms & Conditions
Get user Terms & Conditions v2
User verification files
Get account levels
Get account levels v2
Businesses
Get risk questions
Get a list of available businesses
Create new business
Get business details
Update an existing business
Create Authorized Individual
Get a list of Authorized Individuals
Get Authorized Individual details
Update Authorized Individual
Delete Authorized Individual
Create Shareholder
Get a list of Shareholders
Get Shareholder details
Update Shareholder
Delete Shareholder
Create Beneficial Owner
Get a list of Beneficial Owners
Get Beneficial Owner details
Update Beneficial Owner
Delete Beneficial Owner
Create Managing Director
Get a list of Managing Directors
Get Managing Director details
Update Managing Director
Delete Managing Director
Create Individual
Get a list of Individuals
Get Individual details
Update Individual
Delete Individual
User Files
Upload a file
Get file contents
Get file information
Legal & Regulatory
Get Terms & Conditions
Get Terms & Conditions v2
Get AML questions
Get appropriateness questions
Get client categorization questionnaire
Get DAC8 questionnaire
Get FATCA questionnaire
Get Legal Documents
Capture consent for User's final check
Retrieve Tax Identification Number Configuration
Get UK appropriateness questionnaire
Get appropriateness questionnaire for complex products
Get UK Risk Disclosure Warning
Acknowledge UK Risk Disclosure Warning
Get user compliance status
Asset Oversight
Asset History
Get asset history
Get asset history V2
Available Assets
Get a list of available assets
Get a list of available assets v2
Asset Details
Get asset details
Get asset details v2
Asset Info
Get asset information
Get asset information V2
Cryptocoin Details
Get cryptocoin details
Get cryptocoin details V2
Metal Details
Get metal details
Get metal details V2
Crypto Index Details
Get crypto index details
Get crypto index details V2
Stock Details
Get stock details
Get stock details V2
Equity Stock Details
Get equity stock details
Get equity stock details V2
ETF Details
Get ETF details
Get ETF details V2
Equity ETF Details
Get equity ETF details
Get equity ETF details V2
ETC Details
Get ETC details
Get ETC details V2
Equity ETC Details
Get Equity ETC details
Get Equity ETC details V2
Token Details
Get token details
Get token details V2
Asset ESG Data
Get asset ESG data
Get asset ESG data V2
List all available fiats per partner
Get the exchange rate for two assets
Get the swap exchange rate between two assets
Get assets under management
Get assets under management grouped by type
Get crypto index allocations
Get asset tags mapping
Get prices
Get prices V2
Trading Capabilities
Trades
Create a trade offer
[Deprecated] Accept a trade offer
Accept a trade offer V2
Accept a trade offer V3
Get a trade offer status
Create a trade offer V2
Swaps
Create a swap offer
Accept a swap offer
Accept a swap offer V2
Create a swap offer V2
Automated Orders
List automated orders
Get automated order price estimation
Create an automated order
Get an automated order details
Cancel an automated order
Portfolio Management
Returns the list of owned assets
Returns the list of owned asset groups
Portfolio performance based on timeframe
Returns the enhanced portfolio detail of an asset
Returns the list of owned assets
Returns the list of owned asset groups
Portfolio performance based on timeframe
Returns the enhanced portfolio detail of an asset
Transactions Timeline
All
Transaction timeline per user
Trades
List all trades per user
Get trade details
Get trades history for user using asset and fiat uuid
Search for trades
Lightweight Search for trades V2
Swaps
Search for swaps
Search for swaps V2
Swap details by swap offer ID
Swap details by swap offer ID V2
Crypto Transfers
List all crypto transfers per user
Search for crypto transfers
Non-User Initiated Transactions
Non-user initiated transaction details
List all non-user initiated transactions per partner or per user
List all non-user initiated transactions per partner or per user V2
Corporate Actions
List all corporate actions per partner or per user
Corporate action details
Crypto Actions
Crypto action details V2
Crypto action details
Staking Actions
List all staking actions per user
List all staking actions per user V2
Reports
Get all available report types per user
Get all generated reports per user
Download a specific report
Create Account Statement Report
Get ex-ante report for an offer
Tax Insights
Get user’s tax eligibility status
Update user’s tax eligibility status
Get trade tax details
Notification Events
List all notification events per partner
Smart Investment Features
Crypto Transfers
List external addresses
Create deposit address
Update external address
Create withdrawal address
Create withdrawal address V2
List of VASPs
Validate crypto address
Update tax declaration status for a crypto deposit transaction
Create a crypto withdrawal offer
Confirm a withdrawal offer
Crypto Staking
Get staking overview
Get bonded overview
Stake a crypto asset
Stake a crypto asset V2
Unstake a crypto asset
Unstake a crypto asset V2
Get a staking action status
Savings Plans
Create a savings plan
Search for savings plans
Search for savings plans V2
Get savings plan next recurrence date.
Cancel a savings plan
Cancel a savings plan V2
Confirm a savings plan transaction
Confirm a savings plan transaction V2
Create a savings plan V2
Settlements
List all available fiats per partner
Create a settlement deposit
Update the fiat stock
List all settlement transactions per partner
Webhooks
Overview
Setting up Webhooks
Handling Webhooks Events
User Updates Notifications
User Updates Notifications
Corporate Actions Notifications
Corporate Actions Notifications
Corporate Actions Notifications V2
Crypto Transfers Notifications
Deposit or withdrawal notification
Settlement Notifications
Top-Up Request
Top-Up Request V2
Top-Up Success
Top-Up Success V2
Send Money
Send Money V2
Send Money Success
Send Money Success V2
Non-user Initiated Transactions Notifications
Non-user Initiated Transactions
Non-user Initiated Transactions V2
Non-user Initiated Transactions V3
Savings Plans Notifications
Savings Plan Upcoming Trade
Savings Plan Upcoming Trade v2
Savings Plan Successful Trade
Savings Plan Failed Trade
Savings Plan Auto Cancel
Crypto Actions Notifications
Crypto Actions Notifications
Report Notifications
Reports Notifications
Automated Orders Notifiations
Automated Orders Notifications
Proxy Voting
Proxy Voting Notifications
Websocket
Overview
Setting a Websocket
Websocket Server Documentation
Glosary
Key Terms and Definitions
Schemas
400
401
403
404
405
406
409
410
413
422
428
500
503
OAuthTokenRequest
AccessToken
OAuthRevokeRequest
UserJourney
Term
PaginationMeta
PaginationLinks
TermListResponse
UserFlow
TradingAssetGroup
TermV2Link
TermV2Text
TermsV2Response
AmlAnswerNested
AmlQuestionNested
AmlAnswer
AmlQuestion
AmlQuestionListResponse
QuestionnaireAnswer
QuestionnaireQuestion
QuestionnaireQuestionListResponse
QuestionnaireQuestionUKListResponse
ComplexProductsAnswer
ComplexProductsQuestion
ComplexProductsQuestionListResponse
ClientCategorizationNestedQuestion
ClientCategorizationNestedAnswer
ClientCategorizationAnswer
ClientCategorizationQuestion
ClientCategorizationQuestionListResponse
Dac8Answer
Dac8Question
Dac8QuestionListResponse
FatcaAnswer
FatcaQuestion
FatcaQuestionListResponse
AccountLevel
AccountLevelListResponse
UpgradeThreshold
AccountLevelV2
AccountLevelListResponseV2
UKRiskDisclosureContentLink
UKRiskDisclosureContent
UKRiskDisclosureActions
UKRiskDisclosure
UkRiskDisclosureGetResponse
UKRiskDisclosureGetResponse
UKRiskDisclosureGetResponse
UKRiskDisclosureGetResponse
GetUserList
SimpleCursorPaginationMeta
GetUserListResponse
AmlQuestionAnswerRequest
AppropriatenessQuestionAnswerRequest
ClientCategorizationQuestionAnswerRequest
FatcaQuestionAnswerRequest
Dac8QuestionAnswerRequest
UserVerificationV2Request
UserTax
UserMultipleTax
UserExtCompliance
CreateUserV2RequestBody
CreateUserV2Response
UserSearch
UsersearchListResponse
UserSearchListResponse
UserSearchListResponse
UserSearchListResponse
GetUserV2
Getuserv2Response
GetUserV2Response
GetUserV2Response
GetUserV2Response
UpdateUserV2RequestBody
UpdateUserV2Response
GetUser
GetUserResponse
UserOffBoardingRequestBody
OffBoardingResponse
InactivateUserResponse
UserAcceptedTerm
UserAcceptedTermListResponse
UserAcceptedTermV2Link
UserAcceptedTermV2Text
UserAcceptedTermsV2Response
UserVerificationFilesV2RequestBody
ComplianceDetails
Appropriateness
AppropriatenessComplexProducts
UserComplianceV2
UserComplianceV2Response
LegalDocument
LegalDocumentListResponse
TaxRules
Asset
AssetListResponse
AssetResponse
AssetHistory
AssetHistoryListResponse
AssetInfo
AssetInfoListResponse
CryptoIndexAllocation
CryptoIndexAllocationListResponse
CoinDetails
CoindetailsResponse
CoinDetailsResponse
CoinDetailsResponse
CoinDetailsResponse
MetalDetails
MetaldetailsResponse
MetalDetailsResponse
CryptoIndexDetails
CryptoindexdetailsResponse
CryptoIndexDetailsResponse
YearlyNetIncome
StockDetails
StockdetailsResponse
StockDetailsResponse
EquityStockDetails
EquityStockDetailsResponse
ETFDetails
ETFDetailsResponse
EquityETFDetails
EquityETFDetailsResponse
ETCDetails
ETCDetailsResponse
EquityETCDetails
EquityETCDetailsResponse
TokenDetails
TokenDetailsResponse
ESGData
ESGDataResponse
ExchangeRate
SwapExchangeRate
AssetV2
AssetV2ListResponse
AssetV2Response
GetAssetsUnderManagement
AssetinfoListResponse
GetAssetsUnderManagementResponse
GetAssetsUnderManagementTypeGroup
GetAssetsUnderManagementTypeGroupResponse
FiatV2
Fiatv2ListResponse
FiatV2ListResponse
FiatV2ListResponse
FiatV2ListResponse
TagGroup
TagsMapping
TagsmappingListResponse
TagsMappingListResponse
Trade
TradeListResponse
TradeV2
Tradev2ListResponse
TradeV2ListResponse
TradeV2ListResponse
TradeV2ListResponse
TransactionTimelineItem
TransactiontimelineitemListResponse
TransactionTimelineItemListResponse
TradeSearchV2
Tradesearchv2ListResponse
TradeSearchV2ListResponse
TradesSearchLightweight
NextPrevCursorPagination
TradesSearchLightweightListResponse
TradeDetails
TradedetailsResponse
TradeDetailsResponse
CorporateActions
CorporateactionsListResponse
CorporateActionsListResponse
CorporateActionDetailsAsset
CorporateActionDetailsFiat
CorporateActionDetails
NonUserInitiatedTransactionsDetailsAsset
NonUserInitiatedTransactionDetailsFiat
NonUserInitiatedTransactionsDetails
CryptoActionDetailsAsset
CryptoActionDetailsFiat
CryptoActionDetails
CryptoActionDetailsAssetV2
CryptoActionTransaction
CryptoActionDetailsV2
CreateOfferRequest
Warnings
Offer
OfferResponse
CreateOfferUUIDRequest
OfferUUID
OfferuuidResponse
OfferUUIDResponse
OfferAccept
AcceptOfferResponse
AcceptOfferIdempotentResponse
OfferAcceptUuid
AcceptOfferUuidResponse
AcceptOfferUUIDResponse
OfferV2StatusResponse
Overview
OverviewListResponse
GroupOverview
GroupoverviewListResponse
GroupOverviewListResponse
Performance
PerformanceResponse
AssetDetailsEnhancedWithStaking
OverviewV2
Overviewv2ListResponse
OverviewV2ListResponse
OverviewV2ListResponse
OverviewV2ListResponse
AssetDetailsEnhancedWithStakingV2
Fiat
FiatListResponse
CreateDomainDepositRequestBody
CreateDepositResponse
UpdateFiatStockRequestBody
UpdateFiatStockResponse
TransactionSearch
TransactionsearchListResponse
TransactionSearchListResponse
UserReportTypesResponse
UserGeneratedReportsResponse
CreateAccountStatement
AccountStatementReportResponse
CreateReportResponse
ReportDetails
ExAnteReport
UploadFileRequestBody
FileInformation
FileinformationListResponse
FileInformationListResponse
OverviewResponse
BondedOverviewResponse
StakeRequest
StakeResponse
StakeSuccessResponse
PendingStakeActionResponse
PendingStakeActionSuccessResponse
UnstakeRequest
UnstakeResponse
UnstakeSuccessResponse
SearchResponse
SearchSuccessResponse
SearchV2Response
PaginationMetaV2
SearchV2SuccessResponse
StakeV2Request
StakeV2Response
StakeV2SuccessResponse
UnstakeV2Request
UnstakeV2Response
UnstakeV2SuccessResponse
GetStatusResponse
GetstatusSuccessResponse
EventV2
Eventv2ListResponse
EventV2ListResponse
EventV2ListResponse
EventV2ListResponse
NonUserInitiatedTransactions
NonuserinitiatedtransactionsListResponse
NonUserInitiatedTransactionsListResponse
NonUserInitiatedTransactionsV2
Nonuserinitiatedtransactionsv2ListResponse
NonUserInitiatedTransactionsV2ListResponse
GetPricesResponse
GetPricesSuccessResponse
GetPricesResponseV2
GetPricesV2SuccessResponse
OrderPriceEstimationResponse
GetTaxStatusResponse
GetTaxStatusSuccessResponse
UpdateTaxStatusRequest
UpdateTaxStatusResponse
UpdateTaxStatusSuccessResponse
GetTaxDetailsResponse
GetTaxDetailsSuccessResponse
AddressV2Response
AddressV2ListSuccessResponse
CreateAddressRequest
DepositAddressResponse
DepositAddressSuccessResponse
AddressResponse
AddressSuccessResponse
UpdateExternalAddressRequest
AddressV2SuccessResponse
CreateWithdrawalAddressRequest
CreateWithdrawalAddressRequestV2
VaspResponse
ValidateCryptoAddressRequest
ValidateCryptoAddressResponse
ValidateCryptoAddressSuccessResponse
TransactionResponse
TransactionListSuccessResponse
TransactionSuccessResponse
TaxDeclarationUpdateRequest
WithdrawalOfferRequest
WithdrawalOfferResponse
WithdrawalOfferSuccessResponse
WithdrawalResponse
WithdrawalSuccessResponse
AddressVerification
AddressVerificationResponse
SearchSavingsPlanResponse
SearchSavingsPlanSuccessResponse
CreateSavingsPlanRequest
CreateSavingsPlanResponse
CreateSavingsPlanSuccessResponse
ModifySavingsPlanRequest
ModifySavingsPlanResponse
ModifySavingsPlanSuccessResponse
CancelSavingsPlanV2Response
CancelSavingsPlanV2SuccessResponse
ConfirmSavingsPlanTransactionResponse
ConfirmSavingsPlanTransactionSuccessResponse
ConfirmSavingsPlanTransactionV2Response
ConfirmSavingsPlanTransactionV2SuccessResponse
SearchSavingsPlanV2Response
SearchSavingsPlanV2SuccessResponse
CreateSavingsPlanV2Request
CreateSavingsPlanV2Response
CreateSavingsPlanV2SuccessResponse
GetSavingsPlanNextRecurrenceResponse
GetSavingsPlanNextRecurrenceSuccessResponse
CreateSwapOfferRequest
CreateSwapOfferResponse
CreateSwapOfferSuccessResponse
SwaptradessearchListResponse
SwapTradesSearchListResponse
SwapTradesSearchListResponse
SwapTradesSearch
GetswapResponse
GetSwapResponse
GetSwapResponse
SwapTradesSearchListResponse
GetSwap
GetSwapResponse
Createswapofferresponsev2Response
CreateSwapOfferRequestV2
CreateSwapOfferResponseV2
Swaptradessearchv2ListResponse
CreateSwapOfferResponseV2Response
SwapTradesSearchV2
Getswapv2Response
SwapTradesSearchV2ListResponse
GetSwapV2
GetSwapV2Response
AcceptSwapOfferResponse
Acceptswapofferresponsev2Response
AcceptSwapOfferSuccessResponse
AcceptSwapOfferResponseV2
AcceptSwapOfferResponseV2Response
ListOrderResponse
ResponseMeta
ListOrdersSuccessResponse
CreateOrderRequest
CreateOrderResponse
CreateOrderSuccessResponse
GetOrderResponse
GetOrderSuccessResponse
RiskquestionListResponse
RiskAnswer
RiskQuestion
RiskQuestionListResponse
GeneralAddress
EntityTaxClassification
Business
BusinessListResponse
RiskQuestionAnswerRequest
CreateBusinessRequestBody
CreateBusinessResponse
BusinessDetails
BusinessDetailsResponse
UpdateBusinessRequestBody
UpdateBusinessResponse
AuthorizedIndividual
AuthorizedIndividualListResponse
CreateAuthorizedIndividualRequestBody
CreateAuthorizedIndividualResponse
AuthorizedIndividualResponse
UpdateAuthorizedIndividualRequestBody
UpdateAuthorizedIndividualResponse
Shareholder
ShareholderListResponse
CreateShareholderRequestBody
CreateShareholderResponse
ShareholderResponse
UpdateShareholderRequestBody
UpdateShareholderResponse
BeneficialOwnerType
BeneficialOwnerControllingPersonType
BeneficialOwner
BeneficialOwnerListResponse
CreateBeneficialOwnerRequestBody
CreateBeneficialOwnerResponse
BeneficialOwnerResponse
UpdateBeneficialOwnerRequestBody
UpdateBeneficialOwnerResponse
ManagingDirector
ManagingDirectorListResponse
CreateManagingDirectorRequestBody
CreateManagingDirectorResponse
ManagingDirectorResponse
UpdateManagingDirectorRequestBody
UpdateManagingDirectorResponse
Individual
IndividualListResponse
CreateIndividualRequestBody
CreateIndividualResponse
IndividualResponse
UpdateIndividualRequestBody
UpdateIndividualResponse
CorporateActionsNotificationRequest
CorporateActionsNotificationV2Request
UserUpdateRequest
CryptoTransferNotificationRequest
TopUpRequest
TopUpV2Request
TopUpSuccessRequest
TopUpSuccessV2Request
SendMoneyRequest
SendMoneyV2Request
SendMoneySuccessRequest
SendMoneySuccessV2Request
NonUserInitiatedTransactionsRequest
NonUserInitiatedTransactionsV2Request
NonUserInitiatedTransactionsV3Request
SavingsPlanNoticeRequest
SavingsPlanNoticeV2Request
SavingsPlanTradeSuccessNoticeRequest
SavingsPlanTradeErrorNoticeRequest
CryptoActionsNotificationRequest
AutomatedOrdersNotificationRequest
ReportsNotificationRequest
SavingsPlanAutoCancelNotificationRequest
ProxyVotingNotificationRequest
Custody
Introduction
Security
Getting Started
Webhooks
Supported Assets
Glossary
Changelog
Tutorials
API Onboarding
TrustVault Node.js SDK
Change Wallet Policy API
Create a Bitcoin Transaction
Create an Ethereum Transaction
Create Transaction (Unsupported EVM chain)
Create Ethereum Transaction GraphQL API
Calculating Transaction Fee
Decoding an Ethereum Transaction Webhook Payload
Get User Portfolio
Environments
InfraOps
Organisation Management
Address Book V2
APIs
Travel Rule API
Deprecations
Trust API
Query
User
User SubWallets - Details
User SubWallets - Portfolio
User SubWallets - Balances
Get Transactions
Get Transactions for a BTC Receive Address
Get All BTC Receive Addresses (With Transactions)
Get User Portfolio
csvPortfolio
Get Request Item
Mutations
Create Transactions
Create BTC Transaction
Create ETH
Create Transaction (EVM compatible chain)
Create Exchange Transfer
Create Change Policy Request
Create Bitcoin Receive Address
Add Signature
Cancel request
Create Sub Wallet
Create Eth Personal Sign
Create Eth Signed Typed Data
Create Radix Transaction
Create Xdc.Network Transaction
Authentication
TrustVault Public Keys
Under the Hood
Understanding Bitcoin
Supported Ethereum Decoded Data
Crypto Pay by Bitpanda
Overview
REST API Endpoints
Authentication
Obtain a Refresh and Access Tokens
Revoke a Refresh Token
Transactions
Get transaction details
Create a new transaction
Get transactions details
Get list of fiat currencies
Schemas
400
401
403
404
413
422
500
AccessToken
getTransactionResponse
getFiatsResponse
StakeV2SuccessResponse
Copy Page