PIpismo
Assets

Get banking asset balance

Get banking asset balance using asset ID

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

Request

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

Path parameters

issuer_idstring required

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

asset_idstring required

Client assigned asset ID. Must consist of the characters [a-z,A-Z,0-9,-,:] with a range from 1 to 128.

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

1SO 4217 currency code

status'ACTIVE' | 'BLOCKED' | 'PENDING' | 'CANCELED' | 'COMPLETED' | 'REDEEMED'

Asset status

position_datestring

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

accrual_frequency'daily' | 'monthly'

Accrual frequency:

  • daily — Accrual for assets daily
  • monthly — Accrual for assets monthly

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": "986",
  "status": "ACTIVE",
  "position_date": "2023-03-22",
  "accrual_frequency": "daily"
}

Changes

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