GET
/
credit_batches
/
{id}
curl --request GET \
  --url https://api.sandbox.isometric.com/registry/v0/credit_batches/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-secret: <x-client-secret>'
{
  "beneficiary": {
    "domain": "isometric.com",
    "id": "abc_1H0G39139CF0DZB2",
    "name": "Isometric"
  },
  "country_of_issue": "GBR",
  "id": "abc_1H0G39139CF0DZB2",
  "issuance_id": "pfx_1H0G39139CF0DZB2",
  "issued_at": "2023-11-07T05:31:56Z",
  "left_child_id": "pfx_1H0G39139CF0DZB2",
  "owner": {
    "domain": "isometric.com",
    "id": "abc_1H0G39139CF0DZB2",
    "name": "Isometric"
  },
  "parent_id": "pfx_1H0G39139CF0DZB2",
  "project_id": "pfx_1H0G39139CF0DZB2",
  "removal_id": "pfx_1H0G39139CF0DZB2",
  "retired_at": "2023-11-07T05:31:56Z",
  "retirement_id": "pfx_1H0G39139CF0DZB2",
  "right_child_id": "pfx_1H0G39139CF0DZB2",
  "sequestered_at": "2023-11-07T05:31:56Z",
  "serial_number": "ISO-1-BSTORE-GBR-F5X7-2024-78177-81177",
  "size": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "status": "active"
}

Authorizations

Authorization
string
headerrequired

An JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret
string
required

A secret token identifying the client connecting to the API

Path Parameters

id
string
required

Response

200 - application/json
beneficiary
object | null
required
country_of_issue
string
required
id
string
required
issuance_id
string
required
issued_at
string
required
left_child_id
string | null
required

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

owner
object
required
parent_id
string | null
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.

project_id
string
required
removal_id
string
required
retired_at
string | null
required
retirement_id
string | null
required
right_child_id
string | null
required

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

sequestered_at
string
required
serial_number
string
required
size
object
required
status
enum<string>
required
Available options:
active,
split,
retired

Was this page helpful?

BeneficiariesCreate Delivery