v1

latestOpenAPI 3.1.02026-07-24223580832.9 KB

bridge

Unlock Tokens for Bridge Swap

Initiates the unlocking process for assets on the destination blockchain that were previously locked during a bridging operation. This endpoint triggers the release of tokens, making them available for use on the target network. The response provides critical transaction details—including the destination chain ID, sender and receiver addresses, gas usage, and a unique reference ID—allowing developers and users to verify that the unlocking process has been successfully initiated and to track the transaction's progress.

💡 Compute Unit Value: 50 (Fixed)

post/defi/v1/bridge/unlock

Request body

bridgeId'300'

The unique ID to specify the bridge protocol for routing cross-chain queries or transactions. Find more here.

srcChainIdstring required

The unique chain ID to specify the source chain. Find more here.

dstChainIdstring required

The unique chain ID to specify the destination chain. Find more here.

dstTokenSymbolstring required

Symbol of the destination token.

dstTokenAddressstring required

Address of the destination token.

amountstring required

Amount of the token to unlock.

gasstring

Maximum gas to be approved for the transaction.

gasPrioritystring

Priority level for gas: low, medium, or high.

receiverstring required

Address of the token receiver.

primarySignaturestring required

Signature required for EVM to EVM unlock transactions.

secondarySignaturestring

Signature required for Stellar to EVM or vice versa unlock transactions.

lockIdstring required

Unique lock ID for the transaction.

enableFeeboolean

Flag to include a basis points fee transaction alongside the main transaction when set to true.

Example request

{
  "bridgeId": "300",
  "srcChainId": "1",
  "dstChainId": "1",
  "dstTokenSymbol": "ETH",
  "dstTokenAddress": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
  "amount": "10000",
  "gas": "100000",
  "gasPriority": "low",
  "receiver": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
  "primarySignature": "0x426361bb4b3317c04cf61ea9f1b1c736568e37468e042fb485905c984e8f548d2424ebbe6e89762a9d5925140acfacdb789bdc029f4d7095cc982b94530e73211b",
  "secondarySignature": "0xb41459682c24b425f86a3d3d24f7c424025a01a92413cdaa028519c4aa8023ac38a9f23e37b97c9fa2da99f4292d647d0494f23c94658828f8846bcba8164b4b1c",
  "lockId": "2344087691488240225697848222060823058",
  "enableFee": false
}

Response

Successful response

statusnumber

Numeric status code indicating success or failure of the API call

msgstring

Human-readable message describing the API result or error

Example response

{
  "status": 200,
  "msg": "success",
  "data": {
    "chainId": "137",
    "from": "0xB409cB0b5DB9f148d0bc491E140D9E0FDd789C11",
    "to": "0xD5D6B2f2D7a7506C49Bb0cb6FB39a67F065d6FC4",
    "value": "0",
    "gas": "20000",
    "data": "0xb43d20c30000000000000000000000000000000001c37472362b414ea769f6366bf6c212000000000000000000000000b409cb0b5db9f148d0bc491e140d9e0fdd789c11000000000000000000000000000000000000000000000000000000000bebc200584c4d0000000000000000000000000000000000000000000000000000000000584c4d00000000000000000000000000000000000000000000000000000000002791bca1f2de4661ed88a30c99a7a9449aa84174000000000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000001800000000000000000000000000000000000000000000000000000000000000041426361bb4b3317c04cf61ea9f1b1c736568e37468e042fb485905c984e8f548d2424ebbe6e89762a9d5925140acfacdb789bdc029f4d7095cc982b94530e73211b000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000041b41459682c24b425f86a3d3d24f7c424025a01a92413cdaa028519c4aa8023ac38a9f23e37b97c9fa2da99f4292d647d0494f23c94658828f8846bcba8164b4b1c00000000000000000000000000000000000000000000000000000000000000",
    "referenceId": "db6520b0a0c04b8e85245b9e6add6ce6"
  }
}