POST
/
retirements

Authorizations

Authorization
string
headerrequired

A 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

Body

application/json
beneficiary_organisation_id
string
required

The ID of the organisation that the credits will be retired in the name of, this can be the same as owner_organisation_id.

Required string length: 20 - 36
credit_batch_quantities
object[]
required

A list of credit batch IDs and kilogram amounts of each to retire.

notes
string | null
required

A publicly visible note stored with the credit retirement.

Maximum length: 256
owner_organisation_id
string
required

The ID of the organisation owns the credits to be retired. Typically this would be your own organisation ID.

Required string length: 20 - 36
retirement_purposes
enum<string>[]
required
Available options:
corporate_targets,
public_environmental_claims,
regulatory_requirement,
other
supplier_id
string
required

All credits in a retirement must originate from the same supplier.

Required string length: 20 - 36

Response

200 - application/json
beneficiary
object
required
credit_batch_size_total
object
required
id
string
required
Required string length: 20 - 36
notes
string | null
required
owner
object
required
purposes
enum<string>[]
required
Available options:
corporate_targets,
public_environmental_claims,
regulatory_requirement,
other
retired_at
string
required
url
string
required

Was this page helpful?

Create BeneficiaryCreate Retirement From Oldest Credits