Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.circle.com/llms.txt

Use this file to discover all available pages before exploring further.

Circle provides a sandbox environment at https://api-sandbox.circle.com for prototyping and integration testing. Sandbox APIs match production APIs, so you can develop and test without generating real financial transactions. Simulated transactions use test networks only and do not move real funds. For details on idempotent requests, pagination, and date filtering, see the API reference. After completing your integration in the sandbox, follow these steps to move to production. If you have questions, contact your Circle solutions engineer or customer support.
1

Replace sandbox URLs with production URLs

Update all API base URLs from https://api-sandbox.circle.com to https://api.circle.com.
2

Replace sandbox API keys with production API keys

Use the Mint Console to create a production API key.
Production API keys allow you to work with real funds. Treat production keys with appropriate security protocols. Consult your security team for key management best practices.
3

(Optional) Set up an IPv4 allowlist

If you configure an IP allowlist, Circle only accepts requests using your production API key that originate from an IP address on that list. Verify that the static addresses in your system match the ones you registered with Circle.
4

Verify API key roles

In the sandbox, your API key provides access to all endpoints. In production, access is restricted to the APIs your entity is authorized to use.
  • Test each API call to confirm it works in production. For example, verify that your list all balances call returns results.
  • If you receive 403 responses or need additional capabilities, contact your Circle representative.
5

Allow for production settlement times

Sandbox settlement times are kept short for testing convenience. Production settlement times reflect real-world processing and are longer. For onchain transfers, the time to finality depends on the number of blockchain confirmations required for each blockchain.
  • Test actual settlement times in production.
  • Decide whether to perform actions (such as releasing goods) after confirmation or after settlement.
6

Anticipate transaction fees

Sandbox fees may not reflect your client agreement with Circle.
  • Review your contract with Circle to understand production fees.
  • Test transactions in production to determine actual fees.
  • Update your interface if you pass fees along to your customers.