Vulcan Forge API
  1. State
Vulcan Forge API
  • Introduction
  • Getting Started
  • Authentication & Authorization
  • Core Concepts
    • Terminology
    • Regulated Assets
    • Tenants
    • Mapping & Labelling
    • SVM Networks
    • Transaction Processing
    • Key Management
    • Read Layer
  • API Reference
    • Blockchain Accounts
      • Create Account
      • Fetch Account Details
      • Fetch Account Private Key
      • Fetch Account Balance
      • Fetch Accounts
      • Update Account
      • Inactivate Account
    • Financial Instruments
      • Create Financial Instrument
      • Fetch Financial Instrument Details
      • Fetch Financial Instrument Circulating Supply
      • Fetch Financial Instruments
      • Update Financial Instrument
      • Close Financial Instrument
      • Pause Financial Instrument
      • Unpause Financial Instrument
      • Token Extensions Calculator
    • Positions
      • State
        • Initialize Position
          POST
        • Update Position
          PATCH
        • Inactivate Position
          PATCH
        • Freeze Position
          PATCH
        • Unfreeze Position
          PATCH
      • Movements
        • Mint
        • Burn
        • Transfer Financial Instrument
        • Transfer Network Currency
      • Trades
        • Trade
      • History
        • Fetch Position Details
        • Fetch Position Balance
        • Fetch Positions
    • Loans
      • Create Loan
      • Fetch Loan Details
      • Fetch Loans
      • Swap Collateral
      • Repay Loan
      • Close Loan
      • Refinance Loan
    • Market Data
      • Onchain Data Sources
        • Create Onchain Data Source
        • Update Oracle Data Source Definition
        • Refresh Oracle Data Source
        • Fetch Onchain Data Source Details
        • Fetch Oracle Data Sources
    • Blockchain Transactions
      • Processing
        • Fetch Transaction Status
        • Sign Transaction
        • Submit Transaction
      • Durable Nonces
        • Create Durable Nonce Accounts
        • Fetch Durable Nonce Account Details
        • Fetch Durable Nonce Accounts
      • Address Lookup Tables
        • Create Address Lookup Table
        • Fetch Address Lookup Table Details
        • Fetch Address Lookup Tables
        • Extend Address Lookup Table
        • Update Address Lookup Table
      • History
        • Fetch Transaction Details
        • Fetch Transactions
  • Schemas
    • Accounts
      • DKG
        • DKG Key Setup
      • Max Allowed Debit Config
      • Offchain References
      • Account Lookup
      • New Account
      • Tenancy Config
      • Offchain File
      • Network Currency Debit Limit Config
      • Token Debit Limit Config
      • Limit Duration
    • Transactions
      • Svm Value Input
      • Svm Transaction Config
      • Commitment Config
      • Transaction Lookup
    • Query
      • Query Components
        • Sort Model
        • Filter Model
        • Field Value Filter
      • Items Query
      • Bulk Query
    • Loans
      • Loan Duration
    • Reponses
      • Errors
        • Individual Error
        • Error Response
      • Accounts
        • Private Keys
          • Database Private Key Details
          • Private Key Details
          • Cloud Provider Resource Location
          • DKG Private Key Details
        • Account Response Detailed
        • Account Onchain Detailed
        • Account Offchain Detailed
        • Account Response Compact
        • Account Onchain Compact
        • Account Offchain Compact
        • Account Response Identifiers
      • Transactions
        • Svm Value Result
        • Svm Transaction Result
        • Svm Entity Result
      • Financial Instruments
        • Financial Instrument Detailed
        • Financial Instrument Compact
        • Financial Instrument Identifiers
      • Loans
        • Loan Response
      • Positions
        • Position Offchain Result
        • Position Balance Response
        • Position Response Detailed
        • Position Response Compact
        • Position Response Identifiers
      • Market Data
        • Onchain Data Source Response
    • Positions
      • Position Lookup
      • Mint Definition
      • Burn Definition
      • Transfer Financial Instrument Definition
      • Transfer Network Currency Definition
    • Market Data
      • Onchain Data Source Details
      • Switchboard details
    • Loans
  1. State

Inactivate Position

Testing
Development
https://vf-solana-api.dev.alphaledger.com
Development
https://vf-solana-api.dev.alphaledger.com
PATCH
/api/v1/positions/inactivate
Inactivates the Token Account / Position in the SVM Cluster and on the Vulcan Forge platform. It refunds remaining network currency to the desired destination: the feePayer or a provided itemData.refundDestination wallet.
If there is any token balance left in the position, in order to be able to close the position, this balance needs to be disposed of. The balance can be either burned with itemData.burnRemainingTokenBalance or transferred to another position with itemData.transferRemainingTokenBalanceTo.
If there is a token balance left and the position is frozen, this endpoint can also unfreeze the position in the same transaction by specifying the item.unfreezeIfNeeded = true. Optionally the itemData.freezeAuthority can be set if privateKeyDetails need to be provided for it, otherwise it will be fetched based on the token configuration. Note that the unfreeze option is only available if the financial instrument is a TOKEN_2022 version.
The position can reactivated later with the Initialize Position endpoint.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Query Params

Header Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

🟠400
🟠401
🟠403
🟠429
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://vf-solana-api.dev.alphaledger.com/api/v1/positions/inactivate?svmCluster=SOLANA_DEVNET' \
--header 'x-request-id: f9860f73-a466-41f2-a083-34eeb1cc3a3c' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "itemData": {
        "positionToInactivate": {
            "position": {
                "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                "offchainReferences": {
                    "alId": "ALFNDPF000153778",
                    "organizationExternalId": "ALT",
                    "accountNumber": "ALT10000233",
                    "code": "some-authority",
                    "type": "WALLET"
                },
                "autoSign": true,
                "otherTenantOrganizationExternalId": "ALIM",
                "offPlatform": false
            },
            "owner": {
                "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                "offchainReferences": {
                    "alId": "ALFNDPF000153778",
                    "organizationExternalId": "ALT",
                    "accountNumber": "ALT10000233",
                    "code": "some-authority",
                    "type": "WALLET"
                },
                "autoSign": true,
                "otherTenantOrganizationExternalId": "ALIM",
                "offPlatform": false
            },
            "financialInstrument": {
                "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                "offchainReferences": {
                    "alId": "ALFNDPF000153778",
                    "organizationExternalId": "ALT",
                    "accountNumber": "ALT10000233",
                    "code": "some-authority",
                    "type": "WALLET"
                },
                "autoSign": true,
                "otherTenantOrganizationExternalId": "ALIM",
                "offPlatform": false
            },
            "mintAuthority": {
                "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                "offchainReferences": {
                    "alId": "ALFNDPF000153778",
                    "organizationExternalId": "ALT",
                    "accountNumber": "ALT10000233",
                    "code": "some-authority",
                    "type": "WALLET"
                },
                "autoSign": true,
                "otherTenantOrganizationExternalId": "ALIM",
                "offPlatform": false
            },
            "freezeAuthority": {
                "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                "offchainReferences": {
                    "alId": "ALFNDPF000153778",
                    "organizationExternalId": "ALT",
                    "accountNumber": "ALT10000233",
                    "code": "some-authority",
                    "type": "WALLET"
                },
                "autoSign": true,
                "otherTenantOrganizationExternalId": "ALIM",
                "offPlatform": false
            }
        },
        "refundNetworkCurrrencyToFeePayer": false,
        "refundNetworkCurrrencyDestination": {
            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
            "offchainReferences": {
                "alId": "ALFNDPF000153778",
                "organizationExternalId": "ALT",
                "accountNumber": "ALT10000233",
                "code": "some-authority",
                "type": "WALLET"
            },
            "autoSign": true,
            "otherTenantOrganizationExternalId": "ALIM",
            "offPlatform": false
        },
        "burnRemainingTokenBalance": false,
        "transferRemainingTokenBalanceTo": {
            "position": {
                "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                "offchainReferences": {
                    "alId": "ALFNDPF000153778",
                    "organizationExternalId": "ALT",
                    "accountNumber": "ALT10000233",
                    "code": "some-authority",
                    "type": "WALLET"
                },
                "autoSign": true,
                "otherTenantOrganizationExternalId": "ALIM",
                "offPlatform": false
            },
            "owner": {
                "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                "offchainReferences": {
                    "alId": "ALFNDPF000153778",
                    "organizationExternalId": "ALT",
                    "accountNumber": "ALT10000233",
                    "code": "some-authority",
                    "type": "WALLET"
                },
                "autoSign": true,
                "otherTenantOrganizationExternalId": "ALIM",
                "offPlatform": false
            },
            "financialInstrument": {
                "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                "offchainReferences": {
                    "alId": "ALFNDPF000153778",
                    "organizationExternalId": "ALT",
                    "accountNumber": "ALT10000233",
                    "code": "some-authority",
                    "type": "WALLET"
                },
                "autoSign": true,
                "otherTenantOrganizationExternalId": "ALIM",
                "offPlatform": false
            },
            "mintAuthority": {
                "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                "offchainReferences": {
                    "alId": "ALFNDPF000153778",
                    "organizationExternalId": "ALT",
                    "accountNumber": "ALT10000233",
                    "code": "some-authority",
                    "type": "WALLET"
                },
                "autoSign": true,
                "otherTenantOrganizationExternalId": "ALIM",
                "offPlatform": false
            },
            "freezeAuthority": {
                "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
                "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
                "offchainReferences": {
                    "alId": "ALFNDPF000153778",
                    "organizationExternalId": "ALT",
                    "accountNumber": "ALT10000233",
                    "code": "some-authority",
                    "type": "WALLET"
                },
                "autoSign": true,
                "otherTenantOrganizationExternalId": "ALIM",
                "offPlatform": false
            }
        },
        "unfreezeIfNeeded": false,
        "freezeAuthority": {
            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
            "offchainReferences": {
                "alId": "ALFNDPF000153778",
                "organizationExternalId": "ALT",
                "accountNumber": "ALT10000233",
                "code": "some-authority",
                "type": "WALLET"
            },
            "autoSign": true,
            "otherTenantOrganizationExternalId": "ALIM",
            "offPlatform": false
        }
    },
    "svmTransactionConfig": {
        "feePayer": {
            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
            "offchainReferences": {
                "alId": "ALFNDPF000153778",
                "organizationExternalId": "ALT",
                "accountNumber": "ALT10000233",
                "code": "some-authority",
                "type": "WALLET"
            },
            "autoSign": true,
            "otherTenantOrganizationExternalId": "ALIM",
            "offPlatform": false
        },
        "computeUnitConfig": {
            "enable": true,
            "limit": 0,
            "price": 0,
            "priceEstimate": {
                "provider": "HELIUS",
                "calculationStrategy": "DEFAULT",
                "priorityLevel": "RECOMMENDED"
            }
        },
        "commitmentConfig": {
            "commitmentLevel": "processed"
        },
        "messageLifetimeStrategy": "RECENT_BLOCKHASH",
        "transactionVersion": "V0"
    },
    "tenancyConfig": {
        "overrideOrganizationExternalId": "ALIM"
    }
}'
Response Response Example
200 - Example 1
{
    "success": false,
    "offchainId": "ee36c656-aa74-4d6a-b23c-332c204cb202",
    "status": "SIGNED",
    "onchainId": "5nwo7XvhiVRpJasEzH5r3hGKJqaTxd7qVit3cedFJgESdAPrmawebMJu6fUKRfjXEaivuey7vBsW56xPxX76T1bm",
    "confirmationsCount": 2,
    "serializedMessage": "string",
    "errorMessage": "string",
    "txnTimestamp": "2025-10-21T16:17:45.035372Z"
}
Modified at 2026-02-21 21:59:53
Previous
Update Position
Next
Freeze Position
Built with