reportTransaction - TEROCARBON

Critical Endpoint. Used by the Marketplace to notify Tero Carbon about significant operations involving Tero VCUs that have occurred within the Marketplace's internal system. Tero Carbon uses these notifications to keep its master registry aligned and potentially update related metadata. This endpoint does not execute the operation on Tero's side, it only reports it. Approval/rejection of the reported event is communicated asynchronously via Webhook.

Operation Types Explained:

Tokenization: Notify Tero after your marketplace has internally tokenized VCUs deposited into your custody.

Transfer: Notify Tero after an internal transfer between users occurred on your platform.

Retire: Notify Tero after you have internally retired/burned VCU representations on your platform.

Detokenization: Notify Tero after you have internally detokenized/burned VCU representations before Tero re-tokenizes them back into a user's Tero account. Provide unitsAccountDestinationID. Tero will only re-tokenize whole tCO2e units based on unitsQuantity and unit.

Request

Body Params application/json

Example

{
    "marketplaceId": "string",
    "operationType": "retire",
    "unitId": 0,
    "issuanceId": 0,
    "transactionAmount": 0,
    "transactionUnit": "tCO2e",
    "transactionUnitPrice": "string",
    "transactionDescription": "string",
    "originWallet": "string",
    "originUserName": "string",
    "originUserEmail": "string",
    "originUserDocId": "string",
    "destinationWallet": "string",
    "destinationUserName": "string",
    "destinationUserEmail": "string",
    "destinationUserDocId": "string",
    "contractAddress": "string",
    "transactionReferenceId": "string",
    "transactionHash": "string",
    "publicNetworkChainId": "string",
    "publicNetworkName": "string",
    "unitsInternalAccountID": 0,
    "unitsAccountDestinationID": 0,
    "unitsRetirementNotes": "string",
    "transactionTimestamp": "2019-08-24T14:15:22Z",
    "marketplaceTransactionRef": "string",
    "detokenizationProof": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "marketplaceId": "string",
    "operationType": "retire",
    "unitId": 0,
    "issuanceId": 0,
    "transactionAmount": 0,
    "transactionUnit": "tCO2e",
    "transactionUnitPrice": "string",
    "transactionDescription": "string",
    "originWallet": "string",
    "originUserName": "string",
    "originUserEmail": "string",
    "originUserDocId": "string",
    "destinationWallet": "string",
    "destinationUserName": "string",
    "destinationUserEmail": "string",
    "destinationUserDocId": "string",
    "contractAddress": "string",
    "transactionReferenceId": "string",
    "transactionHash": "string",
    "publicNetworkChainId": "string",
    "publicNetworkName": "string",
    "unitsInternalAccountID": 0,
    "unitsAccountDestinationID": 0,
    "unitsRetirementNotes": "string",
    "transactionTimestamp": "2019-08-24T14:15:22Z",
    "marketplaceTransactionRef": "string",
    "detokenizationProof": "string"
}