Circle API Documentation
Complete API reference for Circle integration
API Overview
Access Circle's institutional-grade APIs for USDC transfers, treasury management, and cross-border payments through NVC Banking Platform.
Base Endpoints
- Production: api.circle.com
- Sandbox: api-sandbox.circle.com
- Authentication: Bearer Token
- Rate Limit: 1000 req/min
Response Format
- Content-Type: application/json
- HTTP Status Codes
- Error Handling
- Webhook Support
API Credentials
Production
v1.2.0
nvc-bank-*****
Enterprise
Payment APIs
Create Payment
POST /v1/payments
Content-Type: application/json
Authorization: Bearer {API_KEY}
{
"amount": "1000.00",
"currency": "USD",
"destination": {
"type": "wire",
"name": "Recipient Name",
"addressLine1": "123 Main St"
},
"metadata": {
"beneficiaryEmail": "recipient@example.com"
}
}
Get Payment Status
GET /v1/payments/{payment_id}
Authorization: Bearer {API_KEY}
Wallet APIs
Get Wallet Balance
GET /v1/wallets
Authorization: Bearer {API_KEY}
Response:
{
"data": [
{
"walletId": "12345",
"currency": "USD",
"balance": "150000.00"
}
]
}
Transfer Between Wallets
POST /v1/transfers
{
"source": {"type": "wallet", "id": "12345"},
"destination": {"type": "wallet", "id": "67890"},
"amount": "500.00"
}
USDC APIs
Mint USDC
POST /v1/businessAccount/transfers
{
"amount": "10000.00",
"currency": "USD",
"destination": {
"type": "blockchain",
"address": "0x49c51cC4b3EDAF72e8F65518dfC0078665ea1626",
"chain": "ETH"
}
}
Redeem USDC
POST /v1/transfers
{
"source": {
"type": "blockchain",
"chain": "ETH"
},
"destination": {"type": "wire"},
"amount": "5000.00"
}
Webhooks
Webhook Configuration
POST /v1/notifications/subscriptions
{
"url": "https://nvc-bank.com/webhooks/circle",
"subscriptionDetails": [
{
"url": "https://nvc-bank.com/webhooks/payments",
"notificationType": "payments"
}
]
}
Event Types:
- paymentsPayment status updates
- transfersTransfer completions
- chargebacksChargeback notifications
API Testing Console
Click "Execute API Call" to see response...