latestOpenAPI 3.0.02026-08-10235750.6 KB

b0f71533dff5

Credits

Retire credits

For retiring credits this is THE endpoint to use. You can retire credits from an organization, user or subaccount.

post/v1/retire

Request body

fromIdstring required

The entity that holds the credits

reasonstring required

The reason for retirement. This reason comes from a specified picklist.

beneficiaryNamestring required

The beneficiary for the retirement

commentstring required

A retirement comment

Example request

{
  "to": {
    "email": "info@carbonregistry.com",
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "fromId": "123e4567-e89b-12d3-a456-426614174000",
  "reason": "Corsia",
  "beneficiaryName": "Beff Jezos",
  "comment": "Retiring for flights 24'",
  "credit": {
    "id": "exPost-1-0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
  },
  "receiptEmails": [
    {
      "email": "info@carbonregistry.com"
    }
  ]
}

Response

successboolean required

Whether the transaction was successful or not

transactionIdstring required

The id of the possibly pending transaction