Get Public carbon_credit_batch List
GET /obp/v7.0.0/banks/ogcr/dynamic-entities/public/carbon_credit_batch
OBPv7.0.0-dynamicEntity_getPubliccarbon_credit_batchList_ogcr No role required _Carbon_credit_batch(ogcr)Dynamic-EntityDynamic
Get Public carbon_credit_batch List.
One batch of certified carbon credit units issued for an activity over one monitoring period after certification or re-certification. Represented by a Batch NFT. This Dynamic Entity is part of OGCR.
Property List:
- carbon_credit_batch_id: Internal identifier for the batch
- activity_id: Activity that generated the units
- certificate_of_compliance_id: Certificate (or updated certificate after re-certification) the units were issued from
- unit_type: Permanent Removal, Carbon Farming Sequestration, Soil Emission Reduction or Carbon Storage in Product
- status_code: Unit status: issued, retired, expired, cancelled
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_batch"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
</details>
Authentication is Optional
Filtering, sorting and pagination on the list endpoint:
Queryable (declared indexed) fields: activity_id, carbon_credit_batch_id, certificate_of_compliance_id, status_code.
- Filter:
?obp_filter[FIELD]=OP:VALUE. Operators:eq,ne,in,lt,gt,le,ge,between,like,is_null,not_set.in/betweentake comma-separated values;is_null/not_settake 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,100or?obp_filter[closed_date]=not_set - Legacy filter (still supported): bare field parameters, e.g.
?name=James%20Brown&number=123.456&number=11.11filters byname == "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 join queries (obp_exists / obp_not_exists) are not available on this endpoint.
User Authentication is Optional. The User need not be logged in.
Example success response
{
"bank_id": "ogcr",
"carbon_credit_batch_list": [
{
"carbon_credit_batch": {
"carbon_credit_batch_id": "string",
"activity_id": "string",
"certificate_of_compliance_id": "string",
"unit_type": "Soil Emission Reduction",
"monitoring_period_start_date": "2020-01-01",
"monitoring_period_end_date": "2020-01-01",
"amount": 1,
"status_code": "string",
"issue_date": "2020-01-01",
"expiry_date": "2020-01-01"
},
"metadata": {
"created": {
"at": "2026-09-30T10:12:00Z"
},
"updated": {
"at": "2026-09-30T11:40:00Z"
}
}
}
]
}Possible errors (1)
- OBP-50000: Unknown Error.