API Explorer 1884 endpoints

Create new retirement_event_on_chain

POST /obp/v7.0.0/banks/dylan-bank/dynamic-entities/retirement_event_on_chain

OBPv7.0.0-dynamicEntity_createretirement_event_on_chain_dylan-bank Roles: CanCreateDynamicEntityRecord_retirement_event_on_chain(per bank) _Retirement_event_on_chain(dylan-bank)Dynamic-EntityDynamic

Create new retirement_event_on_chain.

Parsed entity retirement_event_on_chain. This Dynamic Entity is part of OGCR.

Property List:

  • minted_at: On-chain block timestamp (mintedAt) from projectData, unix seconds.

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"retirement_event_on_chain"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

</details>

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Example request body
{
  "retirement_event_id": "string",
  "token_id": "string",
  "unit_type": "string",
  "carbon_credit_batch_id": "string",
  "amount": 1,
  "owner_address": "string",
  "beneficiary_name": "string",
  "end_use": "string",
  "retirement_reason": "string",
  "retirement_date": "2020-01-01",
  "minted_at": 1,
  "token_uri": "string",
  "contract_address": "string",
  "chain_id": 1,
  "tx_hash": "string",
  "block_number": 1
}
Example success response
{
  "bank_id": "dylan-bank",
  "retirement_event_on_chain": {
    "retirement_event_on_chain_id": "d8839721-ad8f-45dd-9f78-2080414b93f9",
    "retirement_event_id": "string",
    "token_id": "string",
    "unit_type": "string",
    "carbon_credit_batch_id": "string",
    "amount": 1,
    "owner_address": "string",
    "beneficiary_name": "string",
    "end_use": "string",
    "retirement_reason": "string",
    "retirement_date": "2020-01-01",
    "minted_at": 1,
    "token_uri": "string",
    "contract_address": "string",
    "chain_id": 1,
    "tx_hash": "string",
    "block_number": 1
  },
  "metadata": {
    "created": {
      "at": "2026-09-30T10:12:00Z",
      "user_id": "a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f",
      "on_behalf_of_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
    },
    "updated": {
      "at": "2026-09-30T11:40:00Z",
      "user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "on_behalf_of_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
    }
  }
}
Possible errors (4)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 dynamicEntity_createretirement_event_on_chain_dylan-bank Originally /banks/dylan-bank/dynamic-entities/retirement_event_on_chain