We refreshed our doc site!
Bookmarked links may have changed
Read release notesIf you've completed your API integration in Circle’s sandbox, it's time to move your site into production. Because the code is largely the same between sandbox and production, moving into the production environment is a fairly straightforward process. Follow the steps below and take note of any additional information provided.
To ensure success, please note the following:
Take your sandbox code into the production environment. There are a couple ways to do this based on your needs:
When you’re transitioning from Sandbox to Production, you’ll need to switch to the Production base URL for your requests.
Sandbox URL: https://api-sandbox.circle.com
Production URL: https://api.circle.com
In some cases, this will be as simple as performing a “find and replace” function with a text editor; in others it will be more complex depending on your approach. Consult your engineering team if you have any questions.
Now that you’re ready to move to production, navigate to the API key tab within the Circle Mint developer dashboard. Create an API key and name it, and assign it a list of IPs permitted to originate requests. After creating your API key, you can copy and paste it as needed.
Security: Because the production API key allows you to work with real, live funds within your Circle Mint account, the key must be provided and managed by Circle. (You can’t regenerate it from your Circle Mint account.) For this reason, your production API key must be treated with appropriate security protocols. Please consult your company’s security team if you have questions.
Circle disables public access to all APIs by default. If you haven’t already connected with a Circle representative regarding using Circle's APIs, please reach out to [email protected].
If you have set up an IP allowlist, Circle only accepts requests using your Production API key that originate from an IP address on the list.
While working in sandbox, your sandbox API key has allowed you to make calls to any Circle endpoint for testing purposes. In production, you’ll be restricted to the functionality—and endpoint access—that you are specifically solutioned for in your Solution Description and Flow of Funds documents. If you attempt to make API calls to an endpoint you aren’t solutioned for, you’ll receive a 403 response.
In the sandbox environment, settlement times (the time it takes to process a transaction) are kept as low as possible to enable you to easily test a variety of behaviors. Because they reflect real-world transactions, production settlement times will invariably be longer (see table below).
Because sandbox does not reflect your client agreement with Circle, fees in the sandbox environment may not always reflect the fees you’ll be charged in production.