Skip to content
/
Update Payout Account

Bitcoin Suisse API (1.5.0)

The Bitcoin Suisse API allows customers of Bitcoin Suisse to automate activities like trading, custody, staking and reporting using their own tools.

Have a look at the Developer Portal to find out how to get an API key and how authentication works.

Download OpenAPI description
BitcoinSuisseOpenApi.json
BitcoinSuisseOpenApi.yaml
Overview
URL
https://bitcoinsuisse.com
Bitcoin Suisse AG
platform@bitcoinsuisse.com
License
Copyright © Bitcoin Suisse AG - 2026
Terms of Service
Languages
Servers
Mock server
https://docs.bitcoinsuisse.com/_mock/api/pages/rest/bitcoinsuisseopenapi
Bitcoin Suisse API
https://api.bitcoinsuisse.com
Bitcoin Suisse Sandbox API
https://sandbox-api.btcsqa.net

Customers

Operations

Accounts

Operations

HistoricalPortfolioValue

Operations

Trading Accounts

Operations

Trading Configuration

Operations

Trading Instruments

Operations

Market Data

Operations

Trading Orders

Operations

Public

Operations

Staking Orders

Operations

Staking Accounts

Operations

GetStakingAccount

Request

Path
accountNumberstring^[0-9]{12}$required
Query
includeOrdersInProgressboolean
Default false
includeRewardsboolean
Default false
Headers
customer-numberstringrequired

Defines which customer the request is executed for. If you manage multiple customers, this is how you switch between them. Use the Customer Management API endpoints to get the customer data. Example: 'BTCS-CUS-123456'

curl -i -X GET \
  'https://docs.bitcoinsuisse.com/_mock/api/pages/rest/bitcoinsuisseopenapi/staking/v5/stakingAccounts/{accountNumber}?includeOrdersInProgress=false&includeRewards=false' \
  -H 'customer-number: string'

Responses

Success

Bodyapplication/json
accountNumberstring

Staking account number.

stakingAccountTypestring

The account type of the staking account.

Enum"Unknown""Trading""Staking""Vault"
assetSymbolstring

Asset Symbol for the Staking Account.

payoutAccountstring or null

Configured payout account that gets rewards earned.

commissionnumber(decimal)

The commission taken on staking rewards to the account as a percentage.

productIdstring(uuid)

Product ID of the staking account.

rewardDetailsobject or null

Details about the rewards for the Staking Account

orderDetailsobject or null

Details about the Staking Orders for the Staking Account

isSafeToCloseboolean or null

Whether it is safe to close the account.

Response
application/json
{
  "accountNumber": "string",
  "stakingAccountType": "Unknown",
  "assetSymbol": "string",
  "payoutAccount": "string",
  "commission": 0,
  "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  "rewardDetails": {
    "rewardsToDate": 0,
    "rewardsToDateAfterCommissions": 0,
    "payoutAssetSymbol": "string"
  },
  "orderDetails": {
    "entriesInProgress": { … },
    "exitsInProgress": { … }
  },
  "isSafeToClose": true
}

Update Payout Account

Request

Please be aware that not all products allow you to choose a payout account of all account types. What is supported can be seen by supportedPayoutAccountTypes on the product.

Path
stakingAccountNumberstring^[0-9]{12}$required

A 12 digit staking account number.

Headers
customer-numberstringrequired

Defines which customer the request is executed for. If you manage multiple customers, this is how you switch between them. Use the Customer Management API endpoints to get the customer data. Example: 'BTCS-CUS-123456'

Body
payoutAccountNumberstring^[0-9]{12}$

Account number of new payout account.

curl -i -X PATCH \
  'https://docs.bitcoinsuisse.com/_mock/api/pages/rest/bitcoinsuisseopenapi/staking/v5/stakingAccounts/{stakingAccountNumber}' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'customer-number: string' \
  -d '{
    "payoutAccountNumber": "string"
  }'

Responses

Success

Response
No content

Staking Products

Operations

Staking Rewards

Operations

TradingApi

Operations

Reports

Operations

Loan Report

Operations