Redeem a Tokenized Asset

This endpoint is used by the tokenized asset issuer to confirm the redemption of tokens previously held in the Authorized Participant's wallet. When the issuer invokes this endpoint, Alpaca will initiate a journal of the underlying asset into the Authorized Participant's account.

Idempotency: When the Idempotency-Key header is supplied, this endpoint is
idempotent. Multiple requests with the same key and identical request body will
create only one redeem request. A subsequent request returns the previously created
request with the same response (no duplicate is created). If the same key is used
with a different request body, the API returns 422 Unprocessable Entity.

Recommended for production: Always supply Idempotency-Key when requesting a
redemption. This allows safe retries on timeouts, network errors, or 5xx responses
without risking duplicate requests. Use a client-generated unique value (e.g. UUID).

Path Params
uuid
required

Account identifier.

Body Params
uuid

Alpaca account ID (UUID) of the Authorized Participant. Exactly one of client_external_account_id or client_account_id must be provided to identify the Authorized Participant whose account will receive the underlying asset. The deprecated client_id field is still accepted as an alias for client_external_account_id during the deprecation window.

string

Customer's client identifier on the issuer's platform. Exactly one of client_external_account_id or client_account_id must be provided to identify the Authorized Participant whose account will receive the underlying asset. The deprecated client_id field is still accepted as an alias for client_external_account_id during the deprecation window.

string
deprecated

Customer's client identifier on the issuer's platform. Use client_external_account_id instead.

string
required

Unique identifier of the redemption request set by the issuer

string
enum
required

The token's blockchain network

string
required

The quantity to convert into the underlying asset. It can be fractional.

string
required

The tokenized asset symbol

string
required

Transaction hash of the completed request on the blockchain

string
required

The underlying asset symbol

string
required

The address where the redeemed tokens were originally held

Headers
string
length ≤ 128

Unique key for idempotent create. When supplied, duplicate requests (same key
and body) return the original redeem request instead of creating a new one. Use a
client-generated value (e.g. UUID) per logical request. Strongly recommended
for production to prevent duplicate requests on retries.

Responses

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