Get Organization (Circle) Balances

GET 
/balances

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

Responses

200

Returns the organization's Circle balances

application/json

Schema

Schema

account

object

required

address string

The address of the distribution account, present when the account type is STELLAR.

circle_wallet_id string

The ID of the Circle wallet, present when the account type is CIRCLE.

type stringrequired

Possible values: [DISTRIBUTION_ACCOUNT.STELLAR.ENV, DISTRIBUTION_ACCOUNT.STELLAR.DB_VAULT, DISTRIBUTION_ACCOUNT.CIRCLE.DB_VAULT]

The type of the distribution account.

status stringrequired

Possible values: [ACTIVE, PENDING_USER_ACTIVATION]

balances

object[]

required

The organization's Circle balances

Array [

asset_code string

The asset code of the balance in the Stellar network.

asset_issuer string

The asset issuer of the balance in the Stellar network.

amount string

The amount of the balance.

]

Example (from schema)

{
  "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"
    }
  ]
}

400

Bad request, not supported when the distribution account is not of the CIRCLE type.

*/*

Schema

Schema

error string

Details about the error

extras

object

object

Example (from schema)

{
  "error": "Invalid input",
  "extras": {
    "field_foo": "field_foo is required",
    "field_bar": "field_bar needs to be an integer"
  }
}

401

Unauthorized

application/json

Schema

Schema

error string

extras

object

status number

message string

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Example

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Loading...