API Explorer 896 endpoints

Get carbon_credit_balance_on_chain List

GET /obp/dynamic-entity/banks/ogcr/carbon_credit_balance_on_chain

OBPv4.0.0-dynamicEntity_getcarbon_credit_balance_on_chainList_ogcr Roles: CanGetDynamicEntityRecord_carbon_credit_balance_on_chain(per bank) _Carbon_credit_balance_on_chain(ogcr)Dynamic-EntityDynamic

Get carbon_credit_balance_on_chain List.

Cache of CarbonCredit (ERC-20) balances on the OGCR chain (chain id 20253). One record per holding address, covering both operator wallets and the ERC-6551 token-bound accounts of credit batches. Populated by OGCR-chain-cache, which derives the holder set from Transfer events and then reads each balance at the current head. Balances are current-state, not historical: each record is only true as of block_number.

Property List:

  • balance: CarbonCredit balance in smallest units, as read at block_number. Decimal string because a uint256 does not fit an integer field. Divide by 10^decimals for tonnes CO2e.
  • batch_token_id: When holder_type is token_bound_account, the CarbonCreditBatchNFT token id this account belongs to. 0 otherwise. Join to carbon_credit_batch_on_chain.token_id.
  • block_number: Block height the balance was read at.
  • chain_id: EVM chain id (OGCR chain = 20253).
  • contract_address: CarbonCredit ERC-20 contract address the balance was read from.
  • decimals: Decimals of the CarbonCredit ERC-20, for rendering balance.
  • holder_type: Whether this address is a plain wallet or the ERC-6551 token-bound account of a credit batch. One of: wallet, token_bound_account. A token_bound_account balance is credits still held inside their batch; a wallet balance is credits withdrawn from a batch and now pooled.
  • owner_address: Address holding the balance, lowercase-insensitive checksum form. The business key for this record. Match against operator.ogcr_wallet_address or land_manager.ogcr_wallet_address to find a party's holdings.
  • symbol: Symbol of the CarbonCredit ERC-20.

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"carbon_credit_balance_on_chain"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

</details>

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Filtering, sorting and pagination on the list endpoint:

(no fields on this entity are declared indexed, so only the legacy bare-parameter filter below is available.)

  • Filter: ?obp_filter[FIELD]=OP:VALUE. Operators: eq, ne, in, lt, gt, le, ge, between, like, is_null, not_set. in / between take comma-separated values; is_null / not_set take no value. Repeat the same key to AND several constraints on one field. e.g. ?obp_filter[status]=eq:active&obp_filter[amount]=between:10,100 or ?obp_filter[closed_date]=not_set
  • Legacy filter (still supported): bare field parameters, e.g. ?name=James%20Brown&number=123.456&number=11.11 filters by name == "James Brown" && (number == 123.456 || number == 11.11).
  • Sort: ?obp_sort_by=FIELD[,FIELD2]&obp_sort_direction=ASC|DESC.
  • Paginate: ?obp_limit=20&obp_offset=40.

Filtering, sorting, pagination and is_null / not_set work on every deployment (no special backend required).

One-hop joins (EXISTS / NOT EXISTS) — filter this entity by a condition on a related entity linked through a declared reference: field:

  • ?obp_exists[RelatedEntity] — keep rows that have at least one related RelatedEntity.
  • ?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE — ...that have at least one matching the predicate.
  • ?obp_not_exists[RelatedEntity] — keep rows with NO related RelatedEntity at all.
  • ?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE — ...with no related RelatedEntity matching the predicate (this includes rows that have no related RelatedEntity).
  • If two entities are linked by more than one reference, disambiguate the edge with via:, e.g. ?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed.

The nested filter[...] reuses the operator grammar above. Mind the distinction: obp_not_exists[X]=filter[flag]=eq:true (no related X with flag=true — includes rows with no X) is not the same as obp_exists[X]=filter[flag]=ne:true (has a related X with flag≠true — excludes rows with no X).

Only a field typed reference:<Entity> and declared indexed: true forms a join edge; a plain string field holding ids is not joinable.

Joins require the SQL projection backend (dynamic_entity.indexing.backend=auto on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns 400 (OBP-09022); while an index is still building it returns 409. The plain filter / sort / paginate / is_null / not_set features above do not need the projection backend.

Example success response
{
  "bank_id": "ogcr",
  "carbon_credit_balance_on_chain_list": [
    {
      "carbon_credit_balance_on_chain_id": "d8839721-ad8f-45dd-9f78-2080414b93f9",
      "balance": "1000000000000000000",
      "batch_token_id": 1,
      "block_number": 12400,
      "chain_id": 20253,
      "contract_address": "0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b",
      "decimals": 18,
      "holder_type": "token_bound_account",
      "owner_address": "0x30753E4A8aad7F8597332E813735Def5dD395028",
      "symbol": "CC"
    }
  ]
}
Possible errors (3)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented by OBPv4.0.0 dynamicEntity_getcarbon_credit_balance_on_chainList_ogcr Originally /banks/ogcr/carbon_credit_balance_on_chain