PIpismo
Assets

Register banking asset

Register a banking asset with the Pismo platform. A banking asset is either a certificate of deposit or a bank receipt.

This endpoint generates an Asset registration succeeded event if it succeeds or an Asset registration failed event if it doesn't.

post/v1/issuer/{issuer_id}/assets

Request

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

Path parameters

issuer_idstring required

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

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

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,-,:].

registration_mode'single' | 'many' required

Registration mode — single or many

asset_type'cdb' | 'rdb' required

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

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

customer_type'natural' | 'legal' required

Customer type - natural or legal. A natural customer is an individual, a legal customer is a corporation or other legal entitiy type.

document_numberstring required

A government document number, such as a social security number (US). Must be numeric with 11-14 digits.

deposit_numberinteger required

Deposit number

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

Early redemption terms:

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

1SO 4217 currency code

customer_namestring

Customer name - max length is 128 chars

purchased_unitsinteger

Number of purchased units

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 request

{
  "asset_id": "cac02d17-2587-4a7e-ae6a-b449049a8529",
  "registration_mode": "many",
  "asset_type": "cdb",
  "issuing_date": "2021-04-16",
  "maturity_date": "2021-04-20",
  "purchased_units": 10,
  "issued_units": 1000,
  "unit_value": 9.99,
  "index_type": "di",
  "index_rate": 1,
  "customer_type": "natural",
  "customer_name": "Al Fresco",
  "document_number": "83759935060",
  "deposit_number": 9999999,
  "early_redemption_terms": "no",
  "currency": "986",
  "external_id": "external-test-cac02d17-2587-4a7e-ae6a-b449049a8529",
  "accrual_frequency": "daily"
}

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,-,:].

messagestring required

Message about asset/quote operation

Example response

{
  "asset_id": "6ea8094b-73ba-4737-93ad-370c27c54813",
  "message": "Message about request operation"
}

Changes

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