PIpismo
Assets

List banking asset redemptions

List banking asset redemptions using asset and issuer IDs

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

Request

  • Base URL
    https://sandbox.pismolabs.io/assets-accrual
  • URL
    https://sandbox.pismolabs.io/assets-accrual/v1/issuer/{issuer_id}/assets/{asset_id}/redemption
  • 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.

Query parameters

pageinteger required

Page number, default is 1.

perPageinteger required

Number of items per page, default is 10.

externalIdstring required

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

beginDatestring date

Date asset was issued

endDatestring date

Date asset was redeemed, format = yyyy-mm-dd.

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

current_pagenumber

Current page

per_pageinteger

Number of items per page, default is 10.

pagesinteger

Total number of pages, default is 1.

total_itemsnumber

Total number of items

Example response

{
  "current_page": 1,
  "per_page": 1,
  "pages": 1,
  "total_items": 1,
  "items": [
    {
      "redemption_id": "d72a234c-9cbe-4ad0-9b7c-8dd18e958bc0",
      "asset_id": "6ea8094b-73ba-4737-93ad-370c27c54813",
      "issuer_id": "98400-0-0d",
      "document_number": "123412341234",
      "deposit_number": 567339022,
      "redeemed_units": 10,
      "currency": "986",
      "redemption_date": "2023/03/30",
      "created_at": "2023-03-30T12:26:41",
      "external_id": "93830-FFFF-84940"
    }
  ]
}

Changes

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