Track transfer status
Returns the current status of a cross-chain transfer. Poll this endpoint after executing user steps to monitor progress until completion.
GET/status/{quoteId}
Check the current status of a transfer. Returns the status and an optional LayerZero Scan explorer URL.
| Path Parameters | Value |
|---|---|
quoteId string required The quote ID from the /quotes response |
| Header Parameters | Value |
|---|---|
x-api-key string required Your API key |
| Query Parameters | Value |
|---|---|
txHash string Optional transaction hash for faster status lookup |
Response
{"status": "SUCCEEDED","explorerUrl": "https://layerzeroscan.com/tx/...","executionHistory": [{"event": "SENT","transaction": {"chainKey": "base","hash": "0x..."}},{"event": "DELIVERED","transaction": {"chainKey": "optimism","hash": "0x..."}}]}
Reference
Authentication
Required. Include your API key in the x-api-key header.
Parameters
| Parameter | Type | Location | Required | Description |
|---|---|---|---|---|
quoteId | string | Path | Yes | Quote ID from the /quotes response |
txHash | string | Query | No | Transaction hash from execution (recommended for faster updates) |
Response
Returns transfer status information with optional execution history.
Attributes
| Attribute | Type | Description |
|---|---|---|
status | enum | Current transfer state: PENDING, PROCESSING, SUCCEEDED, FAILED, UNKNOWN |
explorerUrl | string | Optional LayerZero Scan URL for tracking |
executionHistory | array | Optional array of execution events |
Status values
| Status | Description | Terminal |
|---|---|---|
UNKNOWN | Transfer not found or not started | Yes |
PENDING | Transfer initiated but not yet processing | No |
PROCESSING | Cross-chain message in transit | No |
SUCCEEDED | Transfer completed successfully | Yes |
FAILED | Transfer failed (reverted or timeout) | Yes |
Execution history events
| Event | Description | Chain |
|---|---|---|
SENT | Transaction submitted | Source chain |
BUS_RODE | Batch executed (Stargate V2 only) | Source chain |
DELIVERED | Message delivered | Destination chain |
Each event includes:
| Attribute | Type | Description |
|---|---|---|
event | enum | Event type |
transaction | object | Transaction details |
transaction.chainKey | string | Chain where event occurred |
transaction.hash | string | Transaction hash |
transaction.timestamp | number | Unix timestamp in milliseconds |
Code examples
- cURL
- TypeScript
- Python
curl -X GET "https://transfer.layerzero-api.com/v1/status/quote_abc123?txHash=0x..." \
-H "x-api-key: YOUR_API_KEY"
const params = new URLSearchParams({txHash: '0x...'});
const response = await fetch(
`https://transfer.layerzero-api.com/v1/status/quote_abc123?${params}`,
{
headers: {'x-api-key': process.env.VT_API_KEY},
},
);
const {status, explorerUrl} = await response.json();
console.log('Status:', status);
console.log('Explorer:', explorerUrl);
import requests
response = requests.get(
"https://transfer.layerzero-api.com/v1/status/quote_abc123",
params={"txHash": "0x..."},
headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(f"Status: {data['status']}")
print(f"Explorer: {data.get('explorerUrl')}")
Response
{
"status": "SUCCEEDED",
"explorerUrl": "https://layerzeroscan.com/tx/0x...",
"executionHistory": [
{
"event": "SENT",
"transaction": {
"chainKey": "base",
"hash": "0x123...",
"timestamp": 1704067200000
}
},
{
"event": "DELIVERED",
"transaction": {
"chainKey": "arbitrum",
"hash": "0x456...",
"timestamp": 1704067260000
}
}
]
}
Error handling
| HTTP Status | Description | Action |
|---|---|---|
404 | Quote not found | Return UNKNOWN status |
429 | Rate limit exceeded | Wait 5 seconds, retry |
500 | Server error | Retry with exponential backoff |
async function checkStatusSafe(quoteId: string, txHash: string): Promise<string> {
try {
const params = new URLSearchParams({txHash});
const response = await fetch(
`https://transfer.layerzero-api.com/v1/status/${quoteId}?${params}`,
{headers: {'x-api-key': process.env.VT_API_KEY}},
);
if (response.status === 404) return 'UNKNOWN';
if (response.status === 429) {
await new Promise((r) => setTimeout(r, 5000));
return checkStatusSafe(quoteId, txHash);
}
const {status} = await response.json();
return status;
} catch (error) {
console.error('Status check failed:', error);
return 'UNKNOWN';
}
}
Related endpoints
- Quotes — Request transfer quotes (provides the
quoteId) - Build user steps — Generate fresh transactions for Solana
- Submit signature — Submit signatures for Aori routes
Examples
- EVM Example — Complete transfer with status tracking
- Solana Example — Solana transfer with polling