LIlifi

Check the status of a cross chain transfer

Cross chain transfers might take a while to complete. Waiting on the transaction on the sending chain doesn't help here. For this reason we build a simple endpoint that let's you check the status of your transfer. Important: A transaction that is not currently found may return HTTP 404 with code 1003. Clients should also handle a 200 response with status NOT_FOUND. Neither response proves execution failure or authorizes resubmission. Poll within a bounded window, then reconcile the original hash against the source chain; a polling timeout leaves the outcome unknown. While none of the parameters fromChain, toChain and bridge are required, passing the fromChain parameter will speed up the request and is therefore encouraged. If you want to learn more about how to use this endpoint please have a look at our guide.

get/v1/status

Request

Query parameters

txHashstring required

The transaction hash on the sending chain, destination chain or lifi step id

bridgestring

Identifier for a bridge tool. Retrieve the latest bridge keys from the /v1/tools endpoint. Keywords such as all, none, default, and [] are also supported where applicable.

The bridging tool used for the transfer

fromChainstring

The sending chain. Can be the chain id or chain key

toChainstring

The receiving chain. Can be the chain id or chain key

Headers

x-lifi-api-keystring

Authentication header, register in the LI.FI Partner Portal (https://portal.li.fi/ ) to get your API Key.

Response

Response of the Status request

status'NOT_FOUND' | 'INVALID' | 'PENDING' | 'DONE' | 'FAILED' required

The current status of the transfer. Can be PENDING, DONE, NOT_FOUND or FAILED

substatus'WAIT_SOURCE_CONFIRMATIONS' | 'WAIT_DESTINATION_TRANSACTION' | 'BRIDGE_NOT_AVAILABLE' | 'CHAIN_NOT_AVAILABLE' | 'REFUND_IN_PROGRESS' | 'UNKNOWN_ERROR' | 'COMPLETED' | 'PARTIAL' | 'REFUNDED'

A more specific substatus. This is available for PENDING and DONE statuses. More information can be found here: https://docs.li.fi/introduction/user-flows-and-examples/status-tracking

substatusMessagestring

A message that describes the substatus

toolstring required

The tool used for this transfer

transactionIdstring

The ID of this transfer (NOT a transaction hash).

fromAddressstring

The address of the sender.

toAddressstring

The address of the receiver.

lifiExplorerLinkstring

The link to the LI.FI explorer.

Example response

{
  "sending": {
    "txHash": "0xd3ad8fb8798d8440f3a1ec7fd51e102a88e4690f9365fad4eff1a17020376b4a",
    "txLink": "https://polygonscan.com/tx/0xd3ad8fb8798d8440f3a1ec7fd51e102a88e4690f9365fad4eff1a17020376b4a",
    "amount": "13000000",
    "token": {
      "address": "0xd69b31c3225728cc57ddaf9be532a4ee1620be51",
      "symbol": "anyUSDC",
      "decimals": 6,
      "chainId": 137,
      "name": "USDC",
      "coinKey": "anyUSDC",
      "priceUSD": "0",
      "logoURI": ""
    },
    "chainId": 137,
    "gasToken": {
      "address": "0x0000000000000000000000000000000000001010",
      "symbol": "MATIC",
      "decimals": 18,
      "chainId": 137,
      "name": "MATIC",
      "coinKey": "MATIC",
      "priceUSD": "0",
      "logoURI": ""
    },
    "gasAmount": "10000",
    "gasAmountUSD": "0.0",
    "gasPrice": "1000",
    "gasUsed": "1000",
    "timestamp": 1720545119,
    "value": "0"
  },
  "receiving": {
    "txHash": "0xba2793065e20835ef60993144d92e6bc1a86529a70e16c357f66ad13774868ad",
    "txLink": "https://bscscan.com/tx/0xba2793065e20835ef60993144d92e6bc1a86529a70e16c357f66ad13774868ad",
    "amount": "12100000000000000000",
    "token": {
      "address": "0x8965349fb649a33a30cbfda057d8ec2c48abe2a2",
      "symbol": "anyUSDC",
      "decimals": 18,
      "chainId": 56,
      "name": "USDC",
      "coinKey": "anyUSDC",
      "priceUSD": "0",
      "logoURI": ""
    },
    "chainId": 56,
    "gasToken": {
      "address": "0x0000000000000000000000000000000000001010",
      "symbol": "BNB",
      "decimals": 18,
      "chainId": 56,
      "name": "BNB",
      "coinKey": "BNB",
      "priceUSD": "0",
      "logoURI": ""
    },
    "gasAmount": "10000",
    "gasAmountUSD": "0.0",
    "gasPrice": "1000",
    "gasUsed": "1000",
    "timestamp": 1720560232,
    "value": "0"
  },
  "tool": "anyswap",
  "status": "DONE",
  "substatus": "COMPLETED",
  "substatusMessage": "The transfer is complete.",
  "transactionId": "0x0000000000000000000000000000000000001010",
  "fromAddress": "0x0000000000000000000000000000000000001010",
  "toAddress": "0x0000000000000000000000000000000000001010",
  "lifiExplorerLink": "https://scan.li.fi/tx/0xd3ad8fb8798d8440f3a1ec7fd51e102a88e4690f9365fad4eff1a17020376b4a",
  "metadata": {
    "integrator": "jumper.exchange"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.