Authorizations
A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>
Headers
A secret token identifying the client connecting to the API
"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"
Body
The ID of the organisation that the credits will be retired in the name of, this can be the same as owner_organisation_id
.
20 - 37
"org_1GB56M1ST1S0GVNA"
"org_1CP8EQDNQSBXTMR2"
A list of credit batch IDs and kilogram amounts of each to retire.
1
A publicly visible note stored with the credit retirement.
256
"Retired with care."
The ID of the organisation owns the credits to be retired. Typically this would be your own organisation ID.
20 - 37
"org_1GB56M1ST1S0GVNA"
"org_1CP8EQDNQSBXTMR2"
1
All credits in a retirement must originate from the same supplier.
20 - 37
"spl_1CC712KFS1S0YKPS"
"spl_1FJBMMGR3SBXKDME"
Response
Successful Response