1. Get an API key
Circle’s APIs use API keys as the mechanism to authenticate client requests. The API key must be set in the Authorization header of the request sent from your backend server. The format of the header is Bearer secret-key-value. To obtain an API key for the sandbox environment, simply create an account and generate a new key in settings - it only takes a few seconds. GET AN API KEY Once you have generated your API key, record it in a secure place.2. Create a deposit address
To send funds to your Circle Mint Account on-chain, you will first need to generate a deposit address. To that end, you can use the create a deposit address API endpoint. Request:Curl
JSON
Note: You can only create one deposit address per blockchain.
3. List all deposit addresses
Each blockchain will have its own deposit address and it is important to ensure you always use the correct address. You can always make a GET request to see all of your different deposit addresses. In the following example make substitutions for the following placeholder keys:- Replace
${YOUR\_API\_KEY}with your API key. - Replace
${TRANSFER\_ID}with the ID of the transfer you created earlier.
Curl
JSON
4. Deposit to your account
Blockchain deposits can only be initiated from your respective wallet so this part of the deposit process will take place outside of Circle’s API. Using the wallet address returned in the previous step, you will send funds from your blockchain wallet to your Circle Mint Account.Warning: You must confirm the blockchain network is consistent with the
address you requested from Circle and the wallet you’re using to make this
transfer, or you could lose funds.
5. Check the latest balance
You can use the list all balances API endpoint to retrieve the balance of funds available for use in your account. In the following example make substitutions for the following placeholder keys:- Replace
${YOUR\_API\_KEY}with your API key. - Replace
${TRANSFER\_ID}with the ID of the transfer you created earlier.
Curl
JSON