1. Settlement
Bitpanda
  • OAuth 2.0
    • Obtain a Refresh and Access Tokens
      POST
    • Revoke a Refresh Token
      POST
  • Users
    • Get Terms & Conditions
      GET
    • Get Terms & Conditions v2
      GET
    • Get AML questions
      GET
    • Get appropriateness questions
      GET
    • Get UK appropriateness questionnaire
      GET
    • Get appropriateness questionnaire for complex products
      GET
    • Get client categorization questionnaire
      GET
    • Get DAC8 questionnaire
      GET
    • Get FATCA questionnaire
      GET
    • Get account levels
      GET
    • Get account levels v2
      GET
    • Get UK Risk Disclosure Warning
      GET
    • Acknowledge UK Risk Disclosure Warning
      POST
    • Create new user
      POST
    • Get user list v2
      GET
    • Search for users
      GET
    • Get user details v2
      GET
    • Update an existing user
      PATCH
    • Get user details
      GET
    • Off-boarding user
      POST
    • Inactivate user
      PATCH
    • Get user accepted Terms & Conditions
      GET
    • Get user accepted Terms & Conditions v2
      GET
    • User verification files
      POST
    • Get user compliance status
      GET
    • Get Legal Documents
      GET
    • Capture consent for User's final check
      POST
    • Retrieve Tax Identification Number Configuration
      GET
  • Assets
    • Get a list of available assets
    • Get asset details
    • Get asset history
    • Get asset information
    • Get crypto index allocations
    • Get cryptocoin details
    • Get metal details
    • Get crypto index details
    • Get stock details
    • Get equity stock details
    • Get ETF details
    • Get equity ETF details
    • Get ETC details
    • Get Equity ETC details
    • Get token details
    • Get a list of available assets v2
    • Get asset details v2
    • Get asset information
    • Get asset history
    • Get cryptocoin details
    • Get metal details
    • Get crypto index details
    • Get stock details
    • Get equity stock details V2
    • Get ETF details
    • Get equity ETF details V2
    • Get ETC details
    • Get Equity ETC details V2
    • Get token details
    • Get asset tags mapping
    • Get prices
    • Get prices V2
  • Asset ESG Data
    • Get asset ESG data
    • Get asset ESG data V2
  • Exchange rate
    • Get the exchange rate for two assets
  • Swap exchange rate
    • Get the swap exchange rate between two assets
  • GetAssetsUnderManagement
    • Get assets under management
  • GetAssetsUnderManagementTypeGroup
    • Get assets under management grouped by type
  • Fiats
    • List all available fiats per partner
  • Trades
    • List all trades per user
    • Get trades history for user using asset and fiat uuid
    • Transaction timeline per user
    • Search for trades
    • Lightweight Search for trades V2
    • Create a trade offer
    • Create a trade offer V2
    • [Deprecated] Accept a trade offer
    • Accept a trade offer V2
    • Accept a trade offer V3
    • Get a trade offer status
    • List all non-user initiated transactions per partner or per user
    • List all non-user initiated transactions per partner or per user V2
  • TradeDetails
    • Get trade details
  • Corporate Actions
    • List all corporate actions per partner or per user
    • Corporate Actions Notifications
    • Corporate Actions Notifications
  • Operational Transactions
    • Corporate action details
    • Non-user initiated transaction details
    • Crypto action details
  • Operational Transactions V2
    • Crypto action details V2
  • Portfolio
    • 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
  • Settlement
    • List all available fiats per partner
      GET
    • Create a settlement deposit
      POST
    • Update the fiat stock
      POST
    • List all settlement transactions per partner
      GET
    • 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
  • Reports
    • Get all available report types per user
    • Get all generated reports per user
    • Create Account Statement Report
    • Download a specific report
    • Get ex-ante report for an offer
    • Reports Notifications
  • Files
    • Upload a file
    • Get file contents
    • Get file information
  • Staking
    • Get staking overview
    • Get bonded overview
    • Stake a crypto asset
    • Unstake a crypto asset
    • List all staking actions per user
    • List all staking actions per user V2
    • Stake a crypto asset V2
    • Unstake a crypto asset V2
    • Get a staking action status
  • Events
    • List all notification events per partner
  • Automated Order Price Estimation
    • Get automated order price estimation
  • Tax
    • Get user’s tax eligibility status
    • Update user’s tax eligibility status
    • Get trade tax details
  • Crypto-Transfers
    • List external addresses
    • Create deposit address
    • Update external address
    • Create withdrawal address
    • Create withdrawal address V2
    • List of VASPs
    • Validate crypto address
    • List all crypto transfers per user
    • Search for crypto transfers
    • Update tax declaration status for a crypto deposit transaction
    • Create a crypto withdrawal offer
    • Confirm a withdrawal offer
  • Savings
    • Create a savings plan
    • Search for savings plans
    • 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
    • Search for savings plans V2
    • Get savings plan next recurrence date.
    • Savings Plan Upcoming Trade
    • Savings Plan Upcoming Trade v2
    • Savings Plan Successful Trade
    • Savings Plan Failed Trade
    • Savings Plan Auto Cancel
  • Swaps
    • Create a swap offer
    • Search for swaps
    • Swap details by swap offer ID
    • Create a swap offer V2
    • Search for swaps V2
    • Swap details by swap offer ID V2
    • Accept a swap offer
    • Accept a swap offer V2
  • Automated Orders
    • List automated orders
    • Create an automated order
    • Get an automated order details
    • Cancel an automated order
  • Corporate onboarding
    • 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 Actions
    • User Updates Notifications
  • Crypto Transfers
    • Deposit or withdrawal notification
  • Non-user Initiated Transactions
    • Non-user Initiated Transactions
    • Non-user Initiated Transactions V2
    • Non-user Initiated Transactions V3
  • Crypto Action
    • Crypto Actions Notifications
    • Automated Orders Notifications
  • Schemas
    • 400
    • 401
    • 403
    • 404
    • 405
    • 406
    • 409
    • 410
    • 413
    • 422
    • 428
    • 500
    • 503
    • OAuthTokenRequest
    • AccessToken
    • OAuthRevokeRequest
    • UserJourney
    • Term
    • PaginationMeta
    • PaginationLinks
    • TermListResponse
    • UserFlow
    • TradingAssetGroup
    • TradingAssetAction
    • 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
    • GetUserList
    • SimpleCursorPaginationMeta
    • GetUserListResponse
    • AmlQuestionAnswerRequest
    • AppropriatenessQuestionAnswerRequest
    • ClientCategorizationQuestionAnswerRequest
    • FatcaQuestionAnswerRequest
    • Dac8QuestionAnswerRequest
    • UserVerificationV2Request
    • UserTax
    • UserMultipleTax
    • UserExtCompliance
    • CreateUserV2RequestBody
    • CreateUserV2Response
    • UserSearch
    • UsersearchListResponse
    • GetUserV2
    • 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
    • MetalDetails
    • MetaldetailsResponse
    • CryptoIndexDetails
    • CryptoindexdetailsResponse
    • YearlyNetIncome
    • StockDetails
    • StockdetailsResponse
    • EquityStockDetails
    • EquitystockdetailsResponse
    • ETFDetails
    • EtfdetailsResponse
    • EquityETFDetails
    • EquityetfdetailsResponse
    • ETCDetails
    • EtcdetailsResponse
    • EquityETCDetails
    • EquityetcdetailsResponse
    • TokenDetails
    • TokendetailsResponse
    • ESGData
    • EsgdataResponse
    • ExchangeRate
    • SwapExchangeRate
    • AssetV2
    • AssetV2ListResponse
    • AssetV2Response
    • GetAssetsUnderManagement
    • GetAssetsUnderManagementResponse
    • GetAssetsUnderManagementTypeGroup
    • GetAssetsUnderManagementTypeGroupResponse
    • FiatV2
    • Fiatv2ListResponse
    • TagGroup
    • TagsMapping
    • TagsmappingListResponse
    • Trade
    • TradeListResponse
    • TradeV2
    • Tradev2ListResponse
    • TransactionTimelineItem
    • TransactiontimelineitemListResponse
    • TradeSearchV2
    • Tradesearchv2ListResponse
    • TradesSearchLightweight
    • NextPrevCursorPagination
    • TradesSearchLightweightListResponse
    • TradeDetails
    • TradedetailsResponse
    • CorporateActions
    • CorporateactionsListResponse
    • CorporateActionDetailsAsset
    • CorporateActionDetailsFiat
    • CorporateActionDetails
    • NonUserInitiatedTransactionsDetailsAsset
    • NonUserInitiatedTransactionDetailsFiat
    • NonUserInitiatedTransactionsDetails
    • CryptoActionDetailsAsset
    • CryptoActionDetailsFiat
    • CryptoActionDetails
    • CryptoActionDetailsAssetV2
    • CryptoActionTransaction
    • CryptoActionDetailsV2
    • CreateOfferRequest
    • Warnings
    • Offer
    • OfferResponse
    • CreateOfferUUIDRequest
    • OfferUUID
    • OfferuuidResponse
    • OfferAccept
    • AcceptOfferResponse
    • AcceptOfferIdempotentResponse
    • OfferAcceptUuid
    • AcceptOfferUuidResponse
    • OfferV2StatusResponse
    • Overview
    • OverviewListResponse
    • GroupOverview
    • GroupoverviewListResponse
    • Performance
    • PerformanceResponse
    • AssetDetailsEnhancedWithStaking
    • OverviewV2
    • Overviewv2ListResponse
    • AssetDetailsEnhancedWithStakingV2
    • Fiat
    • FiatListResponse
    • CreateDomainDepositRequestBody
    • CreateDepositResponse
    • UpdateFiatStockRequestBody
    • UpdateFiatStockResponse
    • TransactionSearch
    • TransactionsearchListResponse
    • UserReportTypesResponse
    • UserGeneratedReportsResponse
    • CreateAccountStatement
    • AccountStatementReportResponse
    • CreateReportResponse
    • ReportDetails
    • ExAnteReport
    • UploadFileRequestBody
    • FileInformation
    • 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
    • NonUserInitiatedTransactions
    • NonuserinitiatedtransactionsListResponse
    • NonUserInitiatedTransactionsV2
    • 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
    • SearchSavingsPlanResponse
    • SearchSavingsPlanSuccessResponse
    • CreateSavingsPlanRequest
    • CreateSavingsPlanResponse
    • CreateSavingsPlanSuccessResponse
    • ModifySavingsPlanRequest
    • ModifySavingsPlanResponse
    • ModifySavingsPlanSuccessResponse
    • CancelSavingsPlanV2Response
    • CancelSavingsPlanV2SuccessResponse
    • ConfirmSavingsPlanTransactionResponse
    • ConfirmSavingsPlanTransactionSuccessResponse
    • ConfirmSavingsPlanTransactionV2Response
    • ConfirmSavingsPlanTransactionV2SuccessResponse
    • SearchSavingsPlanV2Response
    • SearchSavingsPlanV2SuccessResponse
    • CreateSavingsPlanV2Request
    • CreateSavingsPlanV2Response
    • CreateSavingsPlanV2SuccessResponse
    • GetSavingsPlanNextRecurrenceResponse
    • GetSavingsPlanNextRecurrenceSuccessResponse
    • CreateSwapOfferRequest
    • CreateSwapOfferResponse
    • CreateSwapOfferSuccessResponse
    • SwapTradesSearch
    • SwaptradessearchListResponse
    • GetSwap
    • GetswapResponse
    • CreateSwapOfferRequestV2
    • CreateSwapOfferResponseV2
    • Createswapofferresponsev2Response
    • SwapTradesSearchV2
    • Swaptradessearchv2ListResponse
    • GetSwapV2
    • Getswapv2Response
    • AcceptSwapOfferResponse
    • AcceptSwapOfferSuccessResponse
    • AcceptSwapOfferResponseV2
    • Acceptswapofferresponsev2Response
    • ListOrderResponse
    • ResponseMeta
    • ListOrdersSuccessResponse
    • CreateOrderRequest
    • CreateOrderResponse
    • CreateOrderSuccessResponse
    • GetOrderResponse
    • GetOrderSuccessResponse
    • 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
  1. Settlement

Top-Up Request V2

Webhook
POST
top-up-v2
This webhook is used to notify the Partner about specific settlement processes listed below that take place between Bitpanda and the Partner:
Top-Up (Lower Threshold)
Event triggered when the partner's balance on our side drops below a predetermined lower threshold as a result of a buy trade. It serves to notify partners that they need to top up their account to maintain their trading activities without interruption. Once the partner replenishes their balance, and it no longer falls under the lower limit, the notifications cease until such a condition is met again.
Top-Up (Daily Settlement)
This webhook provides a daily notification about the partner's current wallet balance compared to a set baseline. It helps manage financial resources by informing the partner of the need to deposit funds if the current balance falls short of the baseline. If the amount_to_deposit is zero, indicating no need for additional funds, the notification is not sent.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢200
Return a 200, 201, 202 or 204 status to indicate that the data was received successfully
This response does not have a body.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://your-api-server.com' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "params": {
        "trade_id": 1234567,
        "timestamp": 1646154525,
        "fiat_id": "b88b8466-efe3-11eb-b56f-0691764446a7",
        "fiat_balance": "323000.78000000",
        "amount_to_deposit": "123.00000000"
    }
}'
Modified at 2026-04-17 02:41:01
Previous
Top-Up Request
Next
Top-Up Success
Built with