Balance

Check account balance

Retrieve balances

get

/api/v1/balance

Returns all balances

Authorizations

x-api-keystringRequired

Your API key (obtain from dashboard)

Responses

200

Balances retrieved successfully

application/json

successbooleanRequired

Indicates if the request was successful

Example: true

messagestringRequired

Response message

Example: Balances retrieved successfully

get/api/v1/balance

GET /api/v1/balance HTTP/1.1
Host: api.coincircuit.io
x-api-key: YOUR_API_KEY
Accept: */*

200

Balances retrieved successfully

{
  "success": true,
  "message": "Balances retrieved successfully",
  "data": [
    {
      "currency": "USDT",
      "available": "1500.50",
      "pending": "250.00",
      "total": "1750.50"
    }
  ]
}

List balance transactions

get

/api/v1/balance/transactions

Returns your balance transactions.

Authorizations

x-api-keystringRequired

Your API key (obtain from dashboard)

Query parameters

pagenumber · min: 1Optional

Page number (1-based)

Default: 1Example: 1

sizenumber · min: 1 · max: 100Optional

Number of items per page

Default: 10Example: 10

sourcestring · enumOptional

Filter by source type

Example: depositPossible values:

statusstring · enumOptional

Filter by status

Example: completedPossible values:

directionstring · enumOptional

Filter by direction (money in or out)

Example: creditPossible values:

currencystring · enumOptional

Filter by balance currency

Example: USDTPossible values:

txHashstringOptional

Filter by crypto deposit transaction hash (exact)

startDatestringOptional

Start date (ISO string)

Example: 2026-01-01T00:00:00Z

endDatestringOptional

End date (ISO string)

Example: 2026-12-31T23:59:59Z

Responses

200

Balance transactions retrieved successfully

application/json

successbooleanRequired

Indicates if the request was successful.

Example: true

messagestringRequired

Response message.

Example: Balance transactions retrieved successfully

get/api/v1/balance/transactions

GET /api/v1/balance/transactions HTTP/1.1
Host: api.coincircuit.io
x-api-key: YOUR_API_KEY
Accept: */*

200

Balance transactions retrieved successfully

{
  "success": true,
  "message": "Balance transactions retrieved successfully",
  "data": [
    {
      "id": "bt_123456789_abcdef",
      "source": "deposit",
      "sourceId": "123e4567-e89b-12d3-a456-426614174000",
      "sourceReference": "CC-1G3fDjgD93md",
      "description": "Compliance screening fee - address 0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
      "direction": "credit",
      "status": "completed",
      "amount": "100.00",
      "currency": "USDT",
      "reference": "DEP-123456789",
      "balanceBefore": {
        "available": "1100.00",
        "pending": "0.00",
        "total": "1100.00"
      },
      "balanceAfter": {
        "available": "1100.00",
        "pending": "0.00",
        "total": "1100.00"
      },
      "createdAt": "2026-05-31T10:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "size": 10,
    "total": 42,
    "totalPages": 5
  }
}

Get a balance transaction by id

get

/api/v1/balance/transactions/{id}

Authorizations

x-api-keystringRequired

Your API key (obtain from dashboard)

Path parameters

idstringRequired

Responses

200

Balance transaction retrieved successfully

application/json

successbooleanRequired

Indicates if the request was successful.

Example: true

messagestringRequired

Response message.

Example: Balance transaction retrieved successfully

404

Balance transaction not found

get/api/v1/balance/transactions/{id}

GET /api/v1/balance/transactions/{id} HTTP/1.1
Host: api.coincircuit.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "message": "Balance transaction retrieved successfully",
  "data": {
    "id": "bt_123456789_abcdef",
    "source": "deposit",
    "sourceId": "123e4567-e89b-12d3-a456-426614174000",
    "sourceReference": "CC-1G3fDjgD93md",
    "description": "Compliance screening fee - address 0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    "direction": "credit",
    "status": "completed",
    "amount": "100.00",
    "currency": "USDT",
    "reference": "DEP-123456789",
    "balanceBefore": {
      "available": "1100.00",
      "pending": "0.00",
      "total": "1100.00"
    },
    "balanceAfter": {
      "available": "1100.00",
      "pending": "0.00",
      "total": "1100.00"
    },
    "createdAt": "2026-05-31T10:00:00.000Z"
  }
}