Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Assets

Get banking asset balance

Get banking asset balance using asset ID

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

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

OK

unitsinteger

Number of asset units

redeemed_unitsnumber

Number of redeemed units

units_availablenumber

total units available after redemption operation

latest_accrual_datestring

Latest accrual date, format = yyyy/mm/dd.

daily_ratenumber double

Daily rate

accum_daily_ratenumber double

Accumulative daily rate

factorstring

Calculated pre-rate factor based on how many days the asset has accrued (base unit value x factor = new unit value accrued). The pre-rate factor is used to calculate how much ROI the customer can expect to receive.

unit_valuenumber double

Per unit value

current_amountnumber double

Current amount

currencystring

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

position_datestring

Updated position date, format = yyyy/mm/dd.

accrual_frequency'DAILY' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY' | 'MATURITY'

Interest accrual frequency

Example response

{
  "units": 20,
  "redeemed_units": 10,
  "units_available": 3000,
  "latest_accrual_date": "2023/03/22",
  "daily_rate": 1.2,
  "accum_daily_rate": 1.2,
  "unit_value": 65.56,
  "current_amount": 45.8,
  "currency": "USD",
  "status": "PENDING",
  "position_date": "2023-03-22",
  "accrual_frequency": "DAILY"
}