PIpismo
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

Request

  • Base URL
    https://sandbox.pismolabs.io/assets-accrual
  • URL
    https://sandbox.pismolabs.io/assets-accrual/v2/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.

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

A government document number, such as a social security number (US). Must be numeric with 11-14 digits.

external_idstring required

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

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

OK

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 about asset/quote operation

Example response

{
  "asset_id": "6ea8094b-73ba-4737-93ad-370c27c54813",
  "message": "Message about request operation"
}

Changes

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