v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Assets

Register banking asset

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

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

Date/time when card was issued in RFC3339 format, i.e., 2019-07-03T17:23:18Z

maturity_datestring date required

Deposit maturity date in YYYY-MM-DD format

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

Applicable only to Brazil. Customer type: NATURAL is an individual. LEGAL is a corporation or other legal entity type. Required when providing the has_asset_registration object.

document_numberstring required

Cardholder government document number. This can be from any document that identifies the cardholder such as a Tax ID, State ID, or driver's license.

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

ISO-4217 currency code.

customer_namestring

Applicable only to Brazil. Account owner's name for the individual or corporate customer. Required when providing the has_asset_registration object.

purchased_unitsinteger

Number of purchased units

external_idstring

Provider-generated unique ID for client monitoring and tracking

Interest accrual frequency

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

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

Example response

{
  "asset_id": "6ea8094b-73ba-4737-93ad-370c27c54813",
  "message": "Credit rights update request is being processed"
}