private/register_bridge_deposit
Reports a bridge into one of the caller’s deposit addresses the moment its source transaction is sent, so public/get_pending_deposits shows it as bridging at once with the expected amount, before the bridge’s own API reports it. Rails: lifi, layerzero and ccip. Takes the rail, the source chain and transaction, the rail’s transfer id (Li.Fi: the quote’s transactionId, optional; LayerZero: the message guid; CCIP: the messageId), the deposit address, the source and delivered tokens and the expected amount. Idempotent per bridge. Display only: nothing is credited from it, and a registration its rail never confirms expires.
curl --request POST \
--url https://api.derive.xyz/v3/private/register_bridge_deposit \
--header 'Content-Type: application/json' \
--header 'X-DeriveSignature: <api-key>' \
--header 'X-DeriveTimestamp: <api-key>' \
--header 'X-DeriveWallet: <api-key>' \
--data '
{
"bridge_token": "<string>",
"bridge_token_decimals": 1,
"deposit_address": "<string>",
"expected_amount": "<string>",
"rail": "<string>",
"source_chain_id": 1,
"source_token": "<string>",
"source_tx_hash": "<string>",
"wallet": "<string>",
"provider_transfer_id": null,
"tool": null
}
'import requests
url = "https://api.derive.xyz/v3/private/register_bridge_deposit"
payload = {
"bridge_token": "<string>",
"bridge_token_decimals": 1,
"deposit_address": "<string>",
"expected_amount": "<string>",
"rail": "<string>",
"source_chain_id": 1,
"source_token": "<string>",
"source_tx_hash": "<string>",
"wallet": "<string>",
"provider_transfer_id": None,
"tool": None
}
headers = {
"X-DeriveWallet": "<api-key>",
"X-DeriveTimestamp": "<api-key>",
"X-DeriveSignature": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-DeriveWallet': '<api-key>',
'X-DeriveTimestamp': '<api-key>',
'X-DeriveSignature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
bridge_token: '<string>',
bridge_token_decimals: 1,
deposit_address: '<string>',
expected_amount: '<string>',
rail: '<string>',
source_chain_id: 1,
source_token: '<string>',
source_tx_hash: '<string>',
wallet: '<string>',
provider_transfer_id: null,
tool: null
})
};
fetch('https://api.derive.xyz/v3/private/register_bridge_deposit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.derive.xyz/v3/private/register_bridge_deposit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'bridge_token' => '<string>',
'bridge_token_decimals' => 1,
'deposit_address' => '<string>',
'expected_amount' => '<string>',
'rail' => '<string>',
'source_chain_id' => 1,
'source_token' => '<string>',
'source_tx_hash' => '<string>',
'wallet' => '<string>',
'provider_transfer_id' => null,
'tool' => null
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-DeriveSignature: <api-key>",
"X-DeriveTimestamp: <api-key>",
"X-DeriveWallet: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.derive.xyz/v3/private/register_bridge_deposit"
payload := strings.NewReader("{\n \"bridge_token\": \"<string>\",\n \"bridge_token_decimals\": 1,\n \"deposit_address\": \"<string>\",\n \"expected_amount\": \"<string>\",\n \"rail\": \"<string>\",\n \"source_chain_id\": 1,\n \"source_token\": \"<string>\",\n \"source_tx_hash\": \"<string>\",\n \"wallet\": \"<string>\",\n \"provider_transfer_id\": null,\n \"tool\": null\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-DeriveWallet", "<api-key>")
req.Header.Add("X-DeriveTimestamp", "<api-key>")
req.Header.Add("X-DeriveSignature", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.derive.xyz/v3/private/register_bridge_deposit")
.header("X-DeriveWallet", "<api-key>")
.header("X-DeriveTimestamp", "<api-key>")
.header("X-DeriveSignature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"bridge_token\": \"<string>\",\n \"bridge_token_decimals\": 1,\n \"deposit_address\": \"<string>\",\n \"expected_amount\": \"<string>\",\n \"rail\": \"<string>\",\n \"source_chain_id\": 1,\n \"source_token\": \"<string>\",\n \"source_tx_hash\": \"<string>\",\n \"wallet\": \"<string>\",\n \"provider_transfer_id\": null,\n \"tool\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.derive.xyz/v3/private/register_bridge_deposit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-DeriveWallet"] = '<api-key>'
request["X-DeriveTimestamp"] = '<api-key>'
request["X-DeriveSignature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"bridge_token\": \"<string>\",\n \"bridge_token_decimals\": 1,\n \"deposit_address\": \"<string>\",\n \"expected_amount\": \"<string>\",\n \"rail\": \"<string>\",\n \"source_chain_id\": 1,\n \"source_token\": \"<string>\",\n \"source_tx_hash\": \"<string>\",\n \"wallet\": \"<string>\",\n \"provider_transfer_id\": null,\n \"tool\": null\n}"
response = http.request(request)
puts response.read_body{
"bridge_id": "<string>",
"bridge_status": "<string>",
"deposit_address": "<string>",
"expected_amount": "<string>",
"expires_at_ms": 123,
"rail": "<string>",
"source_chain_id": 1,
"source_tx_hash": "<string>",
"substatus": "<string>",
"token": "<string>",
"delivered_at_ms": 123,
"provider_transfer_id": "<string>",
"receiving_amount": "<string>",
"receiving_token": "<string>",
"receiving_tx_hash": "<string>",
"source_address": "<string>"
}{
"error": {
"code": 123,
"message": "<string>",
"data": "<string>"
}
}Authorizations
Body
What the client sent and was quoted.
Response
Success
Where a deposit came from. Named apart from DepositBridgeOrigin because schemars shares one namespace and would emit an order-dependent BridgeOrigin2.
registered (reported by the client, not yet confirmed by its rail) submitted (in flight) delivered (landed on the destination chain) matched (joined to the L1 deposit) failed (the bridge refunded or could not fill — nothing reached the escrow) expired (unresolved past expires_at_ms; check the source chain) unmatched (delivered, but not credited within 24h; contact support)
curl --request POST \
--url https://api.derive.xyz/v3/private/register_bridge_deposit \
--header 'Content-Type: application/json' \
--header 'X-DeriveSignature: <api-key>' \
--header 'X-DeriveTimestamp: <api-key>' \
--header 'X-DeriveWallet: <api-key>' \
--data '
{
"bridge_token": "<string>",
"bridge_token_decimals": 1,
"deposit_address": "<string>",
"expected_amount": "<string>",
"rail": "<string>",
"source_chain_id": 1,
"source_token": "<string>",
"source_tx_hash": "<string>",
"wallet": "<string>",
"provider_transfer_id": null,
"tool": null
}
'import requests
url = "https://api.derive.xyz/v3/private/register_bridge_deposit"
payload = {
"bridge_token": "<string>",
"bridge_token_decimals": 1,
"deposit_address": "<string>",
"expected_amount": "<string>",
"rail": "<string>",
"source_chain_id": 1,
"source_token": "<string>",
"source_tx_hash": "<string>",
"wallet": "<string>",
"provider_transfer_id": None,
"tool": None
}
headers = {
"X-DeriveWallet": "<api-key>",
"X-DeriveTimestamp": "<api-key>",
"X-DeriveSignature": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-DeriveWallet': '<api-key>',
'X-DeriveTimestamp': '<api-key>',
'X-DeriveSignature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
bridge_token: '<string>',
bridge_token_decimals: 1,
deposit_address: '<string>',
expected_amount: '<string>',
rail: '<string>',
source_chain_id: 1,
source_token: '<string>',
source_tx_hash: '<string>',
wallet: '<string>',
provider_transfer_id: null,
tool: null
})
};
fetch('https://api.derive.xyz/v3/private/register_bridge_deposit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.derive.xyz/v3/private/register_bridge_deposit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'bridge_token' => '<string>',
'bridge_token_decimals' => 1,
'deposit_address' => '<string>',
'expected_amount' => '<string>',
'rail' => '<string>',
'source_chain_id' => 1,
'source_token' => '<string>',
'source_tx_hash' => '<string>',
'wallet' => '<string>',
'provider_transfer_id' => null,
'tool' => null
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-DeriveSignature: <api-key>",
"X-DeriveTimestamp: <api-key>",
"X-DeriveWallet: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.derive.xyz/v3/private/register_bridge_deposit"
payload := strings.NewReader("{\n \"bridge_token\": \"<string>\",\n \"bridge_token_decimals\": 1,\n \"deposit_address\": \"<string>\",\n \"expected_amount\": \"<string>\",\n \"rail\": \"<string>\",\n \"source_chain_id\": 1,\n \"source_token\": \"<string>\",\n \"source_tx_hash\": \"<string>\",\n \"wallet\": \"<string>\",\n \"provider_transfer_id\": null,\n \"tool\": null\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-DeriveWallet", "<api-key>")
req.Header.Add("X-DeriveTimestamp", "<api-key>")
req.Header.Add("X-DeriveSignature", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.derive.xyz/v3/private/register_bridge_deposit")
.header("X-DeriveWallet", "<api-key>")
.header("X-DeriveTimestamp", "<api-key>")
.header("X-DeriveSignature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"bridge_token\": \"<string>\",\n \"bridge_token_decimals\": 1,\n \"deposit_address\": \"<string>\",\n \"expected_amount\": \"<string>\",\n \"rail\": \"<string>\",\n \"source_chain_id\": 1,\n \"source_token\": \"<string>\",\n \"source_tx_hash\": \"<string>\",\n \"wallet\": \"<string>\",\n \"provider_transfer_id\": null,\n \"tool\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.derive.xyz/v3/private/register_bridge_deposit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-DeriveWallet"] = '<api-key>'
request["X-DeriveTimestamp"] = '<api-key>'
request["X-DeriveSignature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"bridge_token\": \"<string>\",\n \"bridge_token_decimals\": 1,\n \"deposit_address\": \"<string>\",\n \"expected_amount\": \"<string>\",\n \"rail\": \"<string>\",\n \"source_chain_id\": 1,\n \"source_token\": \"<string>\",\n \"source_tx_hash\": \"<string>\",\n \"wallet\": \"<string>\",\n \"provider_transfer_id\": null,\n \"tool\": null\n}"
response = http.request(request)
puts response.read_body{
"bridge_id": "<string>",
"bridge_status": "<string>",
"deposit_address": "<string>",
"expected_amount": "<string>",
"expires_at_ms": 123,
"rail": "<string>",
"source_chain_id": 1,
"source_tx_hash": "<string>",
"substatus": "<string>",
"token": "<string>",
"delivered_at_ms": 123,
"provider_transfer_id": "<string>",
"receiving_amount": "<string>",
"receiving_token": "<string>",
"receiving_tx_hash": "<string>",
"source_address": "<string>"
}{
"error": {
"code": 123,
"message": "<string>",
"data": "<string>"
}
}