Bit Capital

The Bit Capital Developer Hub

Welcome to the Bit Capital developer hub. You'll find comprehensive guides and documentation to help you start working with the platform as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides    Community

Platform Assets

Introduction

All Bit Capital systems runs in a tokenized network based on Stellar. That means that digital wallet and its assigned bank account works the same for every currency you want to use.

Different custodians have different codes for the some currency, so we can keep all tokens stable and 1 to 1 with the real currency deposited in the bank.

The platform has already a set of built-in stable tokens that enables your software to operate over fiat and the most popular cryptocurrencies.

All instances operate with a root asset, the base of all basic operations and trades, usually it's one of the currencies below:

Optionally, you can enable some additional assets to use in the platform, so your users can store and trade between them in a compliant, robust and secure platform.


Asset Registrations

An asset registration is basically the action of registering a new account in a custody provider. If the provider requires, BT Core sends user informations, documents, legal term agreements and other informations related to the creation.
If the provider rejects the account (for example for KYC reasons) the asset registration for this asset goes to failed.


Types of Assets

Every platform asset can be configured with a type, that can be one of the options below, we describe further the difference between each type in the next sections.
We split the table into two variables, when the asset is registered in the wallet (the actual creation of the account in the provider) and if this registration is required for the consumer onboarding.

Type of AssetRegistration PhaseRequired for RegistrationBilling Currency
Root AssetOn Wallet CreationYesYes
Initial AssetOn Wallet CreationYesNo
Optional AssetAfter Wallet CreationNoNo

Root Asset

The root asset is the base asset for any conversions and operations in the instance. All service fees are billed in this asset and it is the default asset of any operation.
It's important to say that can only exist one root asset in each instance.


Initial Assets

Initial assets are assets that are not the root, but are still created on the instance setup, they can be required or not, if not required they are called optional assets.
Required initial assets are loaded by default every time a wallet is being registered, and if the custody provider rejects it, the entire user goes to the failed state.


Optional Assets

Optional assets are platform assets that are not required by the mediator to be registered on the creation of the wallet but might be registered in the future. In this case, the consumer will not create an account in the provider responsible for the asset until explicitly asked.

To register an optional asset in a already created wallet, you should use the endpoint below:

curl --location --request POST 'https://testnet.btcore.app/assets/BRLD/register' \
--header 'Content-Type: application/json' \
--data-raw '{
    "wallet": "705e0f54-2451-4b61-afe6-3624a7b6f148"
}'

🚧

Async Asset Registrations

Some custody providers may approve a new account asynchronously, so expect that the asset registration will not be created immediately.

Updated about a month ago



Platform Assets


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.