latestOpenAPI 3.0.02026-08-10235750.6 KB

b0f71533dff5

Credits

Transfer credits

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

post/v1/transfer

Request body

fromIdstring required

The entity that holds the credits - if not a subaccountId the default subaccount will be used.

commentstring

An optional transaction comment

Example request

{
  "to": {
    "publicKey": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    "email": "info@carbonregistry.com",
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "fromId": "123e4567-e89b-12d3-a456-426614174000",
  "credits": [
    {
      "id": "exPost-1-0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
    }
  ],
  "comment": "Transfer 2024",
  "receiptEmails": [
    "info@carbonregistry.com"
  ]
}

Response

transactionIdstring required

The transaction id

successboolean required

Whether the transaction was successful or not

Example response

{
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "success": true
}