PIpismo
Assets

Update banking asset

Update a banking asset using issuer and asset IDs

This endpoint generates an Asset updated event.

patch/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.

Request body

operation_type'amendment' required

Quota operation type. Must be amendment (update quota).

early_redemption_terms'yes' | 'no' | 'market'

Early redemption terms:

  • yes — Has early redemption terms
  • no — Does not have early redemption terms
  • market — Redeem at market

Example request

{
  "operation_type": "amendment",
  "early_redemption_terms": "yes",
  "additional_data": {
    "early_redemption_attributes": [
      {
        "date": "2021-02-01",
        "interest_rate": 1.09,
        "floating_rate": 1.18
      },
      {
        "date": "2021-03-01",
        "interest_rate": 100000000000001.1,
        "floating_rate": 1.15
      }
    ]
  }
}

Response

OK

asset_idstring

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'

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

issuer_idstring

Issuer ID. For more information, see issuer identification number

isin_codestring

An International Securities Identification Number (ISIN) uniquely identifies a security. Its structure is defined in ISO 6166. The ISIN code is a 12-character alphanumeric code that serves for uniform identification of a security through normalization of the assigned National Number, where one exists, at trading and settlement.

registration_mode'single' | 'many'

Registration mode — single or many

issuing_datestring

Issuing date, format = yyyy/mm/dd.

maturity_datestring

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

created_atstring

Date/time (UTC) asset registered on Pismo platform

updated_atstring

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

issued_unitsinteger

Number of issued units

unit_valuenumber double

Per unit value

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

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

Index rate

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

Asset status

currencystring

1SO 4217 currency code

early_redemption_terms'yes' | 'no' | 'market'

Early redemption terms:

  • yes — Has early redemption terms
  • no — Does not have early redemption terms
  • market — Redeem at market
interest_ratenumber double

Interest rate

Example response

{
  "asset_id": "6ea8094b-73ba-4737-93ad-370c27c54813",
  "asset_type": "cdb",
  "issuer_id": "98400-0-0d",
  "isin_code": "isin12341234",
  "registration_mode": "single",
  "issuing_date": "2023/03/22",
  "maturity_date": "2023/03/22",
  "created_at": "2023-03-30T12:26:41",
  "updated_at": "2023-03-30T12:26:41",
  "issued_units": 10,
  "unit_value": 65.56,
  "index_type": "pre",
  "index_rate": 2,
  "status": "ACTIVE",
  "currency": "986",
  "early_redemption_terms": "market",
  "interest_rate": 2.3,
  "additional_data": {
    "early_redemption_attributes": [
      {
        "date": "2021-02-01",
        "interest_rate": 1.09,
        "floating_rate": 1.18
      },
      {
        "date": "2021-03-01",
        "interest_rate": 100000000000001.1,
        "floating_rate": 1.15
      }
    ]
  }
}

Changes

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