Balances

Get Organization (Circle) Balances

Changed on

ATTENTION, this endpoint is only enabled when the tenant distribution account type is CIRCLE.

get/balances

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Response

Returns the organization's Circle balances

Example response

{
  "account": {
    "address": "GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL",
    "circle_wallet_id": "1000646072",
    "type": "DISTRIBUTION_ACCOUNT.STELLAR.DB_VAULT",
    "status": "ACTIVE"
  },
  "balances": [
    {
      "asset_code": "USDC",
      "asset_issuer": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
      "amount": "100.00"
    }
  ]
}

Changes

    • breaking

      removed the media type */* for the response with the status

    • info

      added the media type application/json for the response with the status