v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Assets

Get banking asset

Get banking asset using issuer and asset IDs

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

Path parameters

issuer_idstring required

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

assetIdstring required

Image asset ID. This is the image_asset_id field returned from the Get eligible token requestors endpoint.

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

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

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

currencystring required

ISO-4217 currency code.

status'PENDING' | 'PROCESSING' | 'CANCELLED' | 'SETTLED' | 'PROCESSED'

PENDING: Charge is scheduled and waiting for the cycle to close. PROCESSING: Cycle closing process has started and is awaiting completion. CANCELLED: Charge canceled due to link cancellation. SETTLED: Amount is zero and/or minimum_spend_to_charge has not been reached. PROCESSED: Charge was posted on the statement."

issuer_idstring

Issuer ID. For more information, see issuer identification number

created_atstring date-time

Datetime program calendar strategy was created. Format = YYYY-MM-DDTHH:MM:SS:MM.

updated_atstring date-time

Datetime program calendar strategy was updated. Format = YYYY-MM-DDTHH:MM:SS:MM

interest_ratenumber double

Interest rate

external_idstring

Provider-generated unique ID for client monitoring and tracking

Interest accrual frequency

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"
}