v2

latestOpenAPI 3.1.02026-08-054181117.0 KB

Issuance Credit Batches

List of credit batches for a given issuance.

Credit batches are divided between those allocated to the buffer pool and those allocated to the supplier. Note these are the original batches in the issuance, so some credit batches might be in status SPLIT if they had to be split for a delivery/transfer/retirement.

get/issuances/{id}/credit_batches

Path parameters

idstring required
Example:iss_1EWT8R5FY1S0GFCY

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

issuance_idstring required

Example response

{
  "issuance_id": "iss_1EWT8R5FY1S0GFCY",
  "supplier_credit_batches": [
    {
      "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"
    }
  ],
  "supplier_credit_batch_size_total": {
    "credits": 125.632,
    "credit_kgs": 125632
  },
  "buffer_pool_credit_batches": [
    {
      "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"
    }
  ],
  "buffer_pool_credit_batch_size_total": {
    "credits": 125.632,
    "credit_kgs": 125632
  },
  "credit_batch_size_total": {
    "credits": 125.632,
    "credit_kgs": 125632
  }
}