v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Assets

Create banking asset redemption

Create a banking asset redemption. A banking asset redemption is the repayment of the original value of the asset to the investor.

If the request succeeds, this endpoint generates an Asset redeemed event and an Asset status changed event. If it fails, it generates an Asset redemption failed event.

put/v2/issuer/{issuer_id}/assets/{asset_id}/redemption

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.

Request body

unitsinteger required

Number of asset units

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.

external_idstring required

Provider-generated unique ID for client monitoring and tracking

redemption_datestring

Redemption date, format = yyyy/mm/dd

deposit_numberinteger

Deposit number

Example request

{
  "units": 50,
  "document_number": "83759935060",
  "deposit_number": 9999999,
  "external_id": "cac02d17-2587-4a7e-ae6a-b449049a8529",
  "redemption_date": "2022-07-01"
}

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