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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

Body Params

Requested body of authorization

string
required
length between 1 and 128

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

string
enum
required

Registration mode — single or many

Allowed:
string
enum
required

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

Allowed:
string
required

Issuing date, format = yyyy/mm/dd.

string
required

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

int32
required

Number of issued units

double
required

Per unit value

string
enum
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.
Allowed:
double
required

Index rate

string
enum
required

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

Allowed:
string
required
length between 1 and 14

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

int32
required

Deposit number

string
enum
required

Early redemption terms:

  • yes — Has early redemption terms
  • no — Does not have early redemption terms
  • market — Redeem at market
Allowed:
string
required

1SO 4217 currency code

string
length between 1 and 128

Customer name - max length is 128 chars

int32

Number of purchased units

additional_data
object
string
length between 0 and 128

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

string
enum

Accrual frequency:

  • daily — Accrual for assets daily
  • monthly — Accrual for assets monthly
Allowed:
Headers
string

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.

Responses

400

Bad Request

401

Unauthorized

404

Not found

500

Internal server error

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json