Sign in

v2

latestOpenAPI 3.1.02026-08-054181117.0 KB

Credit Batch

Information about a specific credit batch.

get/credit_batches/{id}

Path parameters

idstring required
Example:ctb_1DRBTYA8Q1S07CBY

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

A secret token identifying the client connecting to the API

Response

Successful Response

idstring required
serial_numberstring required
status'active' | 'split' | 'retired' required
issued_atstring date-time required
retired_atstring date-time nullable required
delivered_atstring date-time nullable required
sequestered_onstring date required
country_of_issuestring required

An ISO 3166-1 alpha-3 country code

supplier_idstring required
parent_idstring nullable required

If this credit batch was created from splitting a larger batch in two, this will be set to the id of the parent credit batch.

left_child_idstring nullable required

If this credit batch has status SPLIT, it will have two child batches representing the two halves of this split.

right_child_idstring nullable required

If this credit batch has status SPLIT, it will have two child batches representing the two halves of this split.

issuance_idstring required
delivery_idstring nullable required
retirement_idstring nullable required
ghg_entry_idstring required
removal_idstring required

Deprecated, please use ghg_entry_id instead.

project_idstring required
ccp_approvedboolean required

Whether this credit batch has been issued as part of a ICVCM Core Carbon Principles (CCP) approved project

Example response

{
  "id": "ctb_1DRBTYA8Q1S07CBY",
  "serial_number": "ISO-1-BSTORE-GBR-F5X7-2024-78177-81177",
  "size": {
    "credits": 125.632,
    "credit_kgs": 125632
  },
  "country_of_issue": "GBR",
  "supplier_id": "spl_1CC712KFS1S0YKPS",
  "parent_id": "ctb_1DRBTYA8Q1S07CBY",
  "left_child_id": "ctb_1DRBTYA8Q1S07CBY",
  "right_child_id": "ctb_1DRBTYA8Q1S07CBY",
  "issuance_id": "iss_1EWT8R5FY1S0GFCY",
  "delivery_id": "dlv_1C454ZXA61S03Z9T",
  "beneficiary": {
    "id": "org_1GB56M1ST1S0GVNA",
    "name": "Isometric",
    "domain": "isometric.com"
  },
  "retirement_id": "ret_1FYBH4QDT1S0SVKF",
  "ghg_entry_id": "rmv_1EEM6NJXX1S0EXKD",
  "removal_id": "rmv_1EEM6NJXX1S0EXKD",
  "owner": {
    "id": "org_1GB56M1ST1S0GVNA",
    "name": "Isometric",
    "domain": "isometric.com"
  },
  "project_id": "prj_1CTWZQGKE1S0VAXA"
}