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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

string
required

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

Body Params

Request body

int32
required

Number of asset units

string
required
length between 1 and 14

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

string
required
length between 0 and 128

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

string

Redemption date, format = yyyy/mm/dd

int32

Deposit number

Headers
string

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.

Responses

400

Bad Request

401

Unauthorized

404

Not found

500

Internal server error

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json