Issuance

Prepare burn transaction

Builds an unsigned burn transaction for client-side signing.

post/v1/issuance/tokens/{tokenId}/burn/prepare

Path parameters

tokenIdstring required

Token identifier.

Example:tok_example

Token identifier.

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Request body

signingWalletIdstring

Optional signer wallet — the walletId field returned by GET /v1/wallets. The wallet record id and the public key are not accepted.

Example request

{
  "signingWalletId": "privy_wallet_123",
  "burn": {
    "source": "So11111111111111111111111111111111111111112",
    "amount": "1000",
    "memo": "Correction"
  },
  "options": {
    "priorityFee": "low",
    "simulate": true
  }
}

Response

Prepared burn

Example response

{
  "data": {
    "transaction": {
      "id": "ttx_example",
      "tokenId": "tok_example",
      "organizationId": "org_example",
      "type": "mint",
      "status": "confirmed",
      "signature": "sig_example",
      "idempotencyKey": "idem_example_12345",
      "idempotencyFingerprint": "4f2d9c7a5e6f1c...",
      "serializedTx": "AQID",
      "slot": 123456,
      "blockTime": "2025-01-01T00:00:00.000Z",
      "fee": 5000,
      "error": "Signature failed",
      "initiatedByKeyId": "key_example",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-02T00:00:00.000Z"
    },
    "preparedTransaction": {
      "serialized": "AQID",
      "blockhash": "blockhash_example",
      "lastValidBlockHeight": "123456"
    },
    "simulation": {
      "success": true,
      "logs": [
        "Program log: success"
      ],
      "error": "Insufficient funds"
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}