Close Financial Instrument

Developing

Development

https://vf-solana-api.dev.alphaledger.com

PATCH

/api/v1/financial-instruments/close

Close a financial instrument and reclaim network currency rent. Requires the existence of a close authority associated with the mint.

The circulating supply on this financial instrument needs to be brought down to 0, before it can be closed.

If the financial instrument was alreadyOnchain (i.e. this is an un-managed financial instrument) no SVM transaction will be created to close the financial instrument. Instead the financial instrument will only be closed in the offchain database.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://vf-solana-api.dev.alphaledger.com/api/v1/financial-instruments/close?svmCluster=SOLANA_DEVNET' \
--header 'x-request-id: f9860f73-a466-41f2-a083-34eeb1cc3a3c' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "itemData": {
        "financialInstrumentToClose": {
            "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
        },
        "refundDestination": {
            "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
        },
        "closeAuthority": {
            "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
        }
    },
    "tenancyConfig": {
        "overrideOrganizationExternalId": "ALIM"
    }
}'

Response Example

200 - Example 1

{
    "closedFinancialInstrument": {
        "onchainId": "ndA7eTfoWqrczXYUq53gNRRjQgEmufqErXbgXUFFUAA",
        "offchainId": "1a1e904d-0d95-4e66-85e1-88a57774e910"
    },
    "svmTransaction": {
        "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-23 09:56:18

Update Financial Instrument

Pause Financial Instrument