'/%3e%3cdefs%3e%3cpattern%20id='pattern0_2104_4598'%20patternContentUnits='objectBoundingBox'%20width='1'%20height='1'%3e%3cuse%20xlink:href='%23image0_2104_4598'%20transform='matrix(0.00376176%200%200%200.0172414%20-0.00219436%200)'/%3e%3c/pattern%3e%3cimage%20id='image0_2104_4598'%20width='267'%20height='58'%20preserveAspectRatio='none'%20xlink:href='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQsAAAA6CAMAAACQ2ozcAAAAM1BMVEVMaXH////////////////////////////////////////////////////////////////x7/yuAAAAEHRSTlMAoDDgEPBgwIBAINCwkHBQDIOTDwAAAAlwSFlzAAFxGAABcRgB7MGwCAAABm1JREFUaIHlW+uWsyoMLSIIeH3/pz0CKrmgQuusdn0nf2YaMW42kISgr1cQK+SySj+61/9cmm45RLTfRvNV0WoBIptv4/mi6AWLuiVDd0lKmLPGGPsA0nelGG8TZoXU69poTPi/v1smBjB338dZxvk218B/VIrxBl8hth9t73+Zp2x7SdNuLMX+tJTitZCKjQx1MzFquLBVc+hvpBSv8NMX/Hb+Bv2MbS8DaNsVYn9aSvFK2nWB5slHtr0sUL4Ur0vx+usowdL3A1jBhUVcfGmR1HCBFPbvuWhskvuefC4/wkWbWyMgzV2ub39GarhA+cf0KBevHrTdffSvcuGxonzCA73JBGq4gFnt7qN/lYtxwflEWOA3KWJVriWOpkd0+lUuQj6Rsu6QkcuL9jW2o4xbyzTZfpWLOG79FlatgnP5Y9tRnFn3RAYE7p/loo1bJ6GtnSLIYbuwRrz8rq6SCyY/y8W2UU0SFkw7xQCghszN/y4Xr0ZCKjpPxQz46Vjdj9pupiHUBsxclmRXcOG0CKZHfVV9dHqM1QmRrZNU4IVN15kwQ98fNHSlYNsaUsmmEUw899gNuQCck2ur17KwZXcypM6gsVSCtSN4YcozzLmWqtvbNCPRUDKgbU07RiC/z8XgmOnMtHNiYUJZu8Tbg8YW3B6HOK6PwRPQRo1sT21nBGVq73OxKNaElx8n3iiAR4CL8YbOHlH0YHnXtAL2osg2Gr8PuMgIIaPNTIooqIJdijfkyFO6b6u9gBTDo1M1PKOK6bNcYCBtf9Gwqcc7LHgr1qqFaHil69Y2KAY9zMWe/Ny3BWSU4vVdZ3UtvCHxGuQD7m2nmfY0FyBBGK8bJidXitf/gxbA7DVQwStdBbbVng48zsUxMexdy7EWr/8H9dw/QjJNLRfHKnmci2Pk5G1LW4nX/2U9x5p5eYOLvYj6PBfb+qXHfacWy/H6P6yuhavBfl1Cl0VtK7MaaGcS30wZF6ny2WS4kD71ttjyZgXHEDk5j4Ew2dTh9SbREYCEqA/NBBXY9pHX4E2eLOPiRQT1RsDAv0sc7QZhOHowIwxjHd4wDcDEmCJ1jmjQREG2werBxt3HXKRIwE+cEAYwmMijygze/hxvrq6FNJp0mNp2Zxf0x1ykWD8zLmA7lIChqe+u8U4Eb2goLbjYSaCJdnDqC20jR4JOAMzHXADYjAs4pCj5QYvH3uCFVjy66IR6Y8zoSfDlPr1rhEKdyHCB64GwJ8PHXAA144L3eBcYaw3DixwfW3skqw+GcUpHj1fP60TwSveXXKDRP7fAubjBi2bKwnrAT5p/gAsEEFuA41jNBQ60YZEip8Lq4r/NBexOLRfbvX0XfGZY5i5uVjcNOzs6tz0S23/GhYNctKcWKrmI4Sq+2BlebpRm9FSY8IRYcVTndS3si6DrEX/JBfKdeKjgitcMLw4DxNf7oVcHW/viSLt/kfqV46KHF9BofR5Tr7iA0QKhg6lIJqZe4Q3hExAroJEgIe6c17XgpEOeZy7ighatS7mA0RDlTyiJr8Obr2sJqjmva4H1g7eObREXNEiVcoGeBWqKuXy7FG9kBEhwfyjPZG9wkQOVfJlgS/Bu9+wbyy5z7YoLNL2XfgNMisFTBd6+qH5xW9fqjbV6JLUVfc4FzuS6yVoz3Lyzw7jAi2SlfrWiBTkhaOvwZrnomaa6lrNPxRwX2ft1JRe3Jb40mUvxkmc+Vtcy0NyFjgIv5oJOjEz39nVXitf/Rb6c+4txufQXWTkqpjkuXrnDLlnLhcsfmSU5Up9SvP7ZvK7F4shFXSsrB5lZLrLHXbzGd80FziS4pN15Kd6QXIGJYUhftolyXtfKSgrBWS5c7p6plguyayJyFmcv8IZRT1nmHnKJ5jzvzAoormS5yFoYqrm4AgI//LjFu3cvkKvioLQp2qlIlQseSuEXQYDt7JqFiVmei+wqqeeCfBIFewcT5XK80R+rwZgNx/F60qEhm3Zgu+HHuxK54hMucmTYei5e7B2NCD37hknAy9tDvPS0WjDNef1iTUQMploZvKc942L/3Aj0sXmDi9UOGw0KoQovzAPD2miRhr35mr7fCo3BO0K9pq/ONOBbL03NpIfIcXNQI2gP2gIteym5gSmkGvgbmRd4J/aqj93zFiUc1VCSc+K0WWWytd+HtHZ678YTQ2Yu+4jSzVePbcNVe6n51+U/wZKesx3N5aEAAAAASUVORK5CYII='/%3e%3c/defs%3e%3c/svg%3e)
Wallets
The Wallets API allows you to manage digital wallets linked to your company account. It supports retrieving wallet information and checking balances across different asset types (USDT, USDC, BTC). Use this API to track balances, monitor available funds, and ensure sufficient balance before initiating transactions.
Key Features
Multi-currency support: View balances across USDT, USDC, and BTC wallets.
Real-time balances: Get up-to-date ledger and available balances.
Formatted output: Receive human-readable balance strings alongside raw values.
Get Wallets
Use Case
This endpoint retrieves all wallets associated with your API key. Each wallet represents a currency-specific account and includes its balance, account number, and creation date.
Headers
Must be set to 'application/json'.
Your API client ID.
Unix timestamp in milliseconds.
A unique UUID for this request.
HMAC-SHA256 signature of the request, Base64-encoded.
Get Balances
Use Case
This endpoint retrieves your account balances across all supported currencies. It provides real-time visibility into your available funds, making it useful for dashboards and ensuring sufficient funds before initiating transactions.
Balance values are returned in smallest units. Stablecoins (USDT, USDC) use 6 decimal places, while BTC uses 8 decimal places. Use the _formatted fields for human-readable values.
Get Balances Response
This is the standard shape of a balances response returned by the API.
Indicates whether the API request was successful.
A human-readable message describing the result of the request.
The unique identifier of the company whose balances are being retrieved.
A list of account objects, each representing a balance for a specific currency.
A unique identifier for the currency-specific account.
The company account number shared across all currency accounts.
The currency of the account (e.g., USDT, USDC, BTC).
The total balance recorded on the ledger. Values are fixed to 6 decimal places for stablecoins (USDT, USDC) and 8 decimal places for BTC.
The balance available for use. Uses the same decimal precision rules as ledger_balance (6 decimals for stablecoins, 8 for BTC).
A human-readable version of the ledger balance including the currency symbol.
A human-readable version of the available balance including the currency symbol.
The ISO 8601 timestamp indicating when the account was created.
A unique identifier for this API request, useful for debugging and support.
The ISO 8601 timestamp showing when the response was generated.
Get Balance By Currency
Use Case
This endpoint retrieves your account balance for a specific currency. Use it to check available funds in a particular wallet (e.g., BTC, USDT, USDC) before initiating transfers or for currency-specific reporting.
Path Parameters
The currency code to retrieve the balance for. Supported values: 'BTC', 'USDT', 'USDC'.
Get Balance By Currency Response
This is the standard shape of a single currency balance response returned by the API.
Indicates whether the API request was successful.
A human-readable message describing the result of the request.
The account number associated with your company.
The currency code for this balance (e.g., 'USDT', 'USDC', 'BTC').
The total balance recorded on the ledger for this currency.
The balance available for immediate use.
A human-readable version of the ledger balance including the currency symbol.
A human-readable version of the available balance including the currency symbol.
The timestamp (ISO 8601 format) indicating when this balance snapshot was taken.
The unique identifier of the company whose balance is being retrieved.
A unique identifier for this specific API request, useful for debugging and support.
The timestamp (ISO 8601 format) when the response was generated.
Error Responses
The Wallets API returns standard error responses. Below are common errors you may encounter.
Authentication Errors
The request is missing or has invalid authentication headers. Verify your x-auth-client, x-auth-timestamp, x-auth-nonce, and x-auth-signature are correct.
Your API key does not have permission to access wallet data. Check your API credentials and permissions in the dashboard.
Request Errors
The currency parameter is invalid or not supported. Supported currencies: BTC, USDT, USDC.
The requested currency wallet does not exist for your account.
You have exceeded the rate limit. Wait and retry after the cooldown period.