Pause Financial Instrument

Developing

Development

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

PATCH

/api/v1/financial-instruments/pause

Pause activity on the financial instrument. Applies only to TOKEN_2022 financial instruments and requires the pausable authority to be configured.

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

Bodyapplication/json

🟠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/pause?svmCluster=SOLANA_DEVNET' \
--header 'x-request-id: f9860f73-a466-41f2-a083-34eeb1cc3a3c' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "itemData": {
        "pausableAuthority": {
            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
            "offchainReferences": {},
            "offPlatform": false,
            "otherTenantOrganizationExternalId": "ALIM",
            "autoSign": true
        },
        "financialInstrument": {
            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
            "offchainReferences": {},
            "offPlatform": false,
            "otherTenantOrganizationExternalId": "ALIM",
            "autoSign": true
        }
    },
    "tenancyConfig": {
        "overrideOrganizationExternalId": "ALIM"
    }
}'

Response Example

200 - Example 1

{
    "success": false,
    "confirmationsCount": 2,
    "status": "SIGNED",
    "serializedMessage": "string",
    "errorMessage": "string",
    "onchainId": "5nwo7XvhiVRpJasEzH5r3hGKJqaTxd7qVit3cedFJgESdAPrmawebMJu6fUKRfjXEaivuey7vBsW56xPxX76T1bm",
    "offchainId": "ee36c656-aa74-4d6a-b23c-332c204cb202",
    "txnTimestamp": "2025-10-21T16:17:45.035372Z"
}

Modified at 2026-02-23 10:04:32

Close Financial Instrument

Unpause Financial Instrument