PIpismo
Assets

Delete banking asset

Delete a banking asset previously registered with the Pismo platform

This endpoint generates an Asset status changed event.

delete/v1/issuer/{issuer_id}/assets/{asset_id}

Request

  • Base URL
    https://sandbox.pismolabs.io/assets-accrual
  • URL
    https://sandbox.pismolabs.io/assets-accrual/v1/issuer/{issuer_id}/assets/{asset_id}
  • Auth
    HTTP bearer

Path parameters

issuer_idstring required

Issuer ID. For more information, refer to issuer identification number

asset_idstring required

Client assigned asset ID. Must consist of the characters [a-z,A-Z,0-9,-,:] with a range from 1 to 128.

Headers

x-cidstring

The Correlation IDentifier field is used to link related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. You can find the x-cid field in the response header from an API endpoint call.

If this field isn't passed, one is automatically generated.

Response

OK

asset_idstring required

Asset ID. This ID is client-generated. It must be between 1 and 128 characters long and consist of only the characters [a-z,A-Z,0-9,-,:].

asset_type'cdb' | 'rdb' required

Asset type, cdb (certificate of deposit) or rdb (bank deposit receipt)

registration_mode'single' | 'many' required

Registration mode — single or many

issuing_datestring required

Issuing date, format = yyyy/mm/dd.

maturity_datestring required

Asset maturity date, format = yyyy/mm/dd.

issued_unitsinteger required

Number of issued units

unit_valuenumber double required

Per unit value

index_type'di' | 'pre' | 'ipca' required

Index type:

  • di — DI rate is the average rate of interbank transactions carried out through interbank certificates of deposits. It is calculated based on fixed interbank deposits transactions settled within one business day.
  • ipca — The Extended National Consumer Price Index (IPCA) is the reference for the Brazilian inflation-targeting system. The Banco Central do Brasil (BCB) works to ensure that the IPCA's annual inflation is centered at the inflation target set by the National Monetary Council (CMN). The IPCA is also the price index of the National Treasury's Notes Series B (NTN-B).
  • pre — Use when there is a tax defined for the asset.
index_ratenumber double required

Index rate

currencystring required

1SO 4217 currency code

status'ACTIVE' | 'BLOCKED' | 'PENDING' | 'CANCELED' | 'COMPLETED' | 'REDEEMED'

Asset status

issuer_idstring

Issuer ID. For more information, see issuer identification number

created_atstring

Date/time (UTC) asset registered on Pismo platform

updated_atstring

Date/time (UTC) asset last updated on Pismo platform

interest_ratenumber double

Interest rate

external_idstring

Client-provided external asset ID. No longer than 128 alphanumeric characters.

accrual_frequency'daily' | 'monthly'

Accrual frequency:

  • daily — Accrual for assets daily
  • monthly — Accrual for assets monthly

Example response

{
  "asset_id": "2334c547-c3f6-4d83-a933-16a3835a0065",
  "asset_type": "cdb",
  "issuer_id": "12345678",
  "registration_mode": "single",
  "issuing_date": "2021-01-10",
  "maturity_date": "2022-03-10",
  "created_at": "2023-03-30T12:26:41",
  "updated_at": "2023-03-30T12:26:41",
  "issued_units": 1000,
  "unit_value": 9.99,
  "customer_type": "natural",
  "customer_name": "Helen Wheels",
  "document_number": "12345678901",
  "deposit_number": "998-878-090",
  "early_redemption_terms": "market",
  "index_type": "di",
  "index_rate": 1,
  "status": "ACTIVE",
  "currency": "986",
  "interest_rate": 0.1,
  "additional_data": {
    "early_redemption_attributes": [
      {
        "date": "2021-05-20",
        "interest_rate": 0.04,
        "floating_rate": 1.12345678
      },
      {
        "date": "2021-12-01",
        "interest_rate": 1.12345678,
        "floating_rate": 1.12345678
      }
    ]
  },
  "accrual_frequency": "daily"
}

Changes

No recorded changes to this operation across all 1 revision of this API.