Vulcan Forge API
  1. Movements
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
        • Update Position
        • Inactivate Position
        • Freeze Position
        • Unfreeze Position
      • Movements
        • Mint
          POST
        • Burn
          POST
        • Transfer Financial Instrument
          POST
        • Transfer Network Currency
          POST
      • 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. Movements

Transfer Network Currency

Testing
Development
https://vf-solana-api.dev.alphaledger.com
Development
https://vf-solana-api.dev.alphaledger.com
POST
/api/v1/positions/transfer-network-currency
Transfer the specified amount of network currency (e.g. SOL). The source account needs to have a sufficient balance to support the transfer.
Signers
itemData.source
fee payer (in transactionConfig or global fee payer)
IMPORTANT NOTE: takeSourceBalanceToMinimumRent=true should be used if the API client wants to reclaim all the network currency from an account and leave the account active only with a balance to cover the minimum rent fee. The account will be completly drawn down up to the minimum amount required to cover the rent fee, based on the current account data size. The transfer amount = current onchain balance - minimum rent fee.
We use this as a convenience feature, mostly with our DEFI_SETTLEMENT_WALLETs. These wallets are passthrough wallets and when they are dormant we want to keep only the minimum rent in them. With this flag we can easily drawn them down to minimum rent and transfer out unused balances - typically back to a global fee payer wallet. Other use cases can apply.

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

🟢201Created
application/json
Body

đźź 400
đźź 401
đźź 403
đźź 429
đź”´500
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://vf-solana-api.dev.alphaledger.com/api/v1/positions/transfer-network-currency?svmCluster=SOLANA_DEVNET' \
--header 'x-request-id: f9860f73-a466-41f2-a083-34eeb1cc3a3c' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '// offchainReferences -> onchainId (on-platform)
{
    "itemData": {
        // if you know the amount in lamports, use the lamports field and remmove the network currency field
        // "lamports": 170000,
        "amount": 0.00017,
        // uncomment the memo field if you want a memo added to the txn
        // "memo": "Transfer some network currency for testing",
        "source": {
            "offchainReferences": {
                "code": "xyz-global-fee-payer",
                "type": "WALLET",
                "organizationExternalId": "XYZ"
            }
        },
        "destination": {
            "onchainId": "DELkrQ6gZg8eHMzNtwB8YAcswVvzGMQ3QoFkUYBriWYJ"
        }
    }
}'
Response Response Example
201 - 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 22:00:34
Previous
Transfer Financial Instrument
Next
Trades
Built with