Create Automatic Tokens Forwarding

Through this endpoint customers can set up an automatic forwarding function specifically for tokens (not coins). They can have a toAddress which is essentially the main address and the destination for the automatic tokens forwarding.

There is also a minimumTransferAmount which only when reached will then trigger the forwarding. Through this the customer can save from fees.

Moreover, feePriority can be also set, which defines how quickly to move the tokens once they are received. The higher priority, the larger the fee will be. It can be "SLOW", "STANDARD" or "FAST".

The response of this endpoint contains an attribute fromAddress which can be used as a deposit address. Any funds received by this address will be automatically forwarded to toAddress based on what the customer has set for the automation.

For this automatic forwarding the customer can set a callback subscription.

Currently we support fungible tokens (ERC-20) only, NFTs (ERC-721) are not supported.

The subscription will work for all incoming transactions until it is deleted. There is no need to do that for every transaction.

This endpoint generates a new fromAddress each time.

Supports Callback Functionality Single Result - This endpoint returns only one single result. POST /blockchain-automations/{blockchain}/{network}/tokens-forwarding/automations

Path Parameters

Required
blockchain string

Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

Example : bitcoin

Possible Values : bitcoin ethereum
Required
network string

Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks.

Example : testnet

Possible Values : mainnet testnet goerli

Query parameters

Optional
context string

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

Example : yourExampleString

Request body schema application/json

Optional
context string

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

Example : yourExampleString
Required
data object
- Required
  item object
  - Optional
    callbackSecretKey string
    
    Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our Documentation.
    
    Example : yourSecretString
  - Required
    callbackUrl string
    
    Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. We support ONLY httpS type of protocol.
    
    Example : https://example.com
  - Required
    confirmationsCount string
    
    Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.
    
    Example : 3
  - Required
    feePriority string
    
    Represents the fee priority of the automation, whether it is "SLOW", "STANDARD" or "FAST".
    
    Example : standard
    
    Possible Values : slow standard fast
  - Required
    minimumTransferAmount string
    
    Represents the minimum transfer amount of the currency in the fromAddress that can be allowed for an automatic forwarding.
    
    Example : 0.00002
  - Required
    toAddress string
    
    Represents the hash of the address the currency is forwarded to.
    
    Example : tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6
  - Required
    tokenData object One Of
    
    object
    
    Required
    propertyId integer
    
    Represents the specific propertyId of the token data that will be forwarded.
    
    Example : 31
    
    object
    
    Required
    contractAddress string
    
    Represents the specific contractAddress of the Token that will be forwarded.
    
    Example : 0xdac17f958d2ee523a2206206994597c13d831ec7

Response schema

201 400 401 402 403 404 409 415 422 429 500

HTTP Status Code: 201
Content-Type: application/json

The resource has been successfully created.

Object :
Required
apiVersion string

Specifies the version of the API that incorporates this endpoint.

Example : 2021-03-20
Required
requestId string

Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

Example : 601c1710034ed6d407996b30
Optional
context string

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

Example : yourExampleString
Required
data
object
- Required
  item object
  
  Required
  callbackUrl string
  
  Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. We support ONLY httpS type of protocol.
  
  Example : https://example.com
  
  Required
  confirmationsCount integer
  
  Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.
  
  Example : 2
  
  Required
  createdTimestamp integer
  
  Defines the specific time/date when the automatic forwarding was created in Unix Timestamp.
  
  Example : 1611238648
  
  Required
  feeAddress string
  
  Represents the specific fee address, which is always automatically generated. Users must fund it.
  
  Example : mojjR51gMXLJ4B3SBPhEXXRFDX7U5UWXNQ
  
  Required
  feePriority string
  
  Represents the fee priority of the automation, whether it is "SLOW", "STANDARD" or "FAST".
  
  Example : standard
  
  Possible Values : slow standard fast
  
  Required
  fromAddress string
  
  Represents the hash of the address that forwards the tokens.
  
  Example : ms4KNsbNpoU8g424pzmEjbkFbfAHae1msB
  
  Required
  minimumTransferAmount string
  
  Represents the minimum transfer amount of the tokens in the fromAddress that can be allowed for an automatic forwarding.
  
  Example : 0.5
  
  Required
  referenceId string
  
  Represents a unique ID used to reference the specific callback subscription.
  
  Example : 6017dd02a309213863be9e55
  
  Required
  toAddress string
  
  Represents the hash of the address the tokens are forwarded to.
  
  Example : tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6
  
  Required
  tokenData object One Of
  
  object
  
  Required
  propertyId integer
  
  Defines the propertyId of the Omni Layer token.
  
  Example : 31
  
  object
  
  Required
  contractAddress string
  
  Represents the specific contractAddress of the Token that will be forwarded.
  
  Example : 0xdac17f958d2ee523a2206206994597c13d831ec7

Callback parameters Method : POST

You can use the optional parameter callbackSecretKey in your request for additional security. It is then used to create a unique hash string in the x-signature response header in the callback request itself. For more information, please see our Documentation.

TOKENS_FORWARDING_SUCCESS TOKENS_FORWARDING_FAIL

Content-Type : application/json

Object :
Required
apiVersion string

Specifies the version of the API that incorporates this endpoint.

Example : 2021-03-20
Required
referenceId string

Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.

Example : 6038d09050653d1f0e40584c
Required
idempotencyKey string

Specifies a unique ID generated by the system and attached to each callback. It is used by the server to recognize consecutive requests with the same data with the purpose not to perform the same operation twice.

Example : e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c
Required
data
object

Specifies all data, as attributes, included into the callback notification, which depends on the event.
- Required
  product string
  
  Represents the Crypto APIs 2.0 product which sends the callback.
  
  Example : BLOCKCHAIN_AUTOMATIONS
- Required
  event string
  
  Defines the specific event, for which a callback subscription is set.
  
  Example : TOKENS_FORWARDING_SUCCESS
- Required
  item object
  
  Defines an item as one result.
  
  Required
  blockchain string
  
  Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
  
  Example : bitcoin
  
  Required
  network string
  
  Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks.
  
  Example : testnet
  
  Required
  fromAddress string
  
  Represents the hash of the address that provides the tokens.
  
  Example : mySJoZ6wsjrKXZQRWpGoeBW5KkdKGL79Xz
  
  Required
  toAddress string
  
  Represents the hash of the address to forward the tokens to.
  
  Example : mmd963W1fECjLyaDCHcioSCZYHkRwjkGST
  
  Required
  spentFeesAmount string
  
  Represents the amount of the fee spent for the tokens to be forwarded.
  
  Example : 0.00013601
  
  Required
  spentFeesUnit string
  
  Represents the unit of the fee spent for the tokens to be forwarded, e.g. BTC.
  
  Example : BTC
  
  Required
  triggerTransactionId string
  
  Defines the unique Transaction ID that triggered the token forwarding.
  
  Example : 6ed1f1c8f2887a78ee8c45a975d928ca63eafc7b63def56324606ddd3cc9854f
  
  Required
  forwardingTransactionId string
  
  Defines the unique Transaction ID that forwarded the tokens.
  
  Example : b15ab5bbaf5107d551ae1b50181f4c55959205c4ff843e3c10d86d00e690fc72
  
  Required
  tokenType string
  
  Defines the type of token sent with the transaction, e.g. ERC 20.
  
  Example : OMNI
  
  Possible Values : ERC-20 ERC-721 OMNI
  
  Required
  token object One Of
  
  object
  
  Required
  name string
  
  Specifies the name of the token.
  
  Example : Tether USD
  
  Required
  symbol string
  
  Specifies an identifier of the token, where up to five alphanumeric characters can be used for it.
  
  Example : USDT
  
  Optional
  decimals string
  
  Defines how many decimals can be used to break the token.
  
  Example : 6
  
  Required
  amount string
  
  Defines the amount of tokens sent with the confirmed transaction.
  
  Example : 0.00039
  
  Required
  contractAddress string
  
  Defines the address of the contract.
  
  Example : 0xdac17f958d2ee523a2206206994597c13d831ec7
  
  object
  
  Required
  name string
  
  Specifies the name of the token.
  
  Example : Wonky Stonks
  
  Required
  symbol string
  
  Specifies an identifier of the token, where up to five alphanumeric characters can be used for it.
  
  Example : WSTK
  
  Required
  tokenId string
  
  Specifies the ID of the token.
  
  Example : 5027
  
  Required
  contractAddress string
  
  Specifies the address of the contract.
  
  Example : 0x518ba36f1ca6dfe3bb1b098b8dd0444030e79d9f
  
  object
  
  Required
  name string
  
  Specifies the name of the token.
  
  Example : TetherUSDT
  
  Required
  propertyId string
  
  Defines the ID of the property for Omni Layer.
  
  Example : 31
  
  Required
  transactionType string
  
  Defines the type of the transaction.
  
  Example : Simple Send, DEx Purchase etc.
  
  Required
  createdByTransactionId string
  
  The transaction ID used to create the token.
  
  Example : be5be71feac9e7019fbcdea5a87098a7862a0ee8c60bd5809b4d3b0cda940ddc
  
  Required
  amount string
  
  Defines the amount of tokens sent with the confirmed transaction.
  
  Example : 110.531723

Credits Cost : 1000 Credits For 1 Result(s)

Try it out

Request Example

Http Java C# PHP Python Ruby Node.js Go

POST

https://rest.cryptoapis.io/blockchain-automations/bitcoin/testnet/tokens-forwarding/automations?context=yourExampleString

Headers

Content-Type: application/json

X-API-Key: my-api-key

Request Body

{
    "context": "yourExampleString",
    "data": {
        "item": {
            "callbackSecretKey": "yourSecretString",
            "callbackUrl": "https://example.com",
            "confirmationsCount": "3",
            "feePriority": "standard",
            "minimumTransferAmount": "0.00002",
            "toAddress": "tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6",
            "tokenData": {
                "propertyId": 31
            }
        }
    }
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"callbackSecretKey\": \"yourSecretString\",
            \"callbackUrl\": \"https:\/\/example.com\",
            \"confirmationsCount\": \"3\",
            \"feePriority\": \"standard\",
            \"minimumTransferAmount\": \"0.00002\",
            \"toAddress\": \"tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6\",
            \"tokenData\": {
                \"propertyId\": 31
            }
        }
    }
}");
Request request = new Request.Builder()
  .url("https://rest.cryptoapis.io/blockchain-automations/bitcoin/testnet/tokens-forwarding/automations?context=yourExampleString")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("X-API-Key", "my-api-key")
  .build();

Response response = client.newCall(request).execute();

var client = new RestClient("https://rest.cryptoapis.io/blockchain-automations/bitcoin/testnet/tokens-forwarding/automations?context=yourExampleString");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader(""X-API-Key", "my-api-key");
request.AddParameter("application/json", "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"callbackSecretKey\": \"yourSecretString\",
            \"callbackUrl\": \"https:\/\/example.com\",
            \"confirmationsCount\": \"3\",
            \"feePriority\": \"standard\",
            \"minimumTransferAmount\": \"0.00002\",
            \"toAddress\": \"tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6\",
            \"tokenData\": {
                \"propertyId\": 31
            }
        }
    }
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

$request = new HttpRequest();
$request->setUrl('https://rest.cryptoapis.io/blockchain-automations/bitcoin/testnet/tokens-forwarding/automations?context=yourExampleString');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
    'Content-Type' => 'application/json',
    'X-API-Key' => 'my-api-key'
));

$request->setBody('{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"callbackSecretKey\": \"yourSecretString\",
            \"callbackUrl\": \"https:\/\/example.com\",
            \"confirmationsCount\": \"3\",
            \"feePriority\": \"standard\",
            \"minimumTransferAmount\": \"0.00002\",
            \"toAddress\": \"tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6\",
            \"tokenData\": {
                \"propertyId\": 31
            }
        }
    }
}');

try {
    $response = $request->send();

    echo $response->getBody();
} catch (HttpException $ex) {
    echo $ex;
}

import http.client

conn = http.client.HTTPConnection("https://rest.cryptoapis.io")

payload = "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"callbackSecretKey\": \"yourSecretString\",
            \"callbackUrl\": \"https:\/\/example.com\",
            \"confirmationsCount\": \"3\",
            \"feePriority\": \"standard\",
            \"minimumTransferAmount\": \"0.00002\",
            \"toAddress\": \"tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6\",
            \"tokenData\": {
                \"propertyId\": 31
            }
        }
    }
}"
    querystring = {"context":"yourExampleString"}
headers = {
  'Content-Type': "application/json",
  'X-API-Key': "my-api-key"
}

conn.request("POST", "blockchain-automations,bitcoin,testnet,tokens-forwarding,automations",payload, headers=headers  , params=querystring )

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
}

require 'uri'
require 'net/http'

url = URI("https://rest.cryptoapis.io/blockchain-automations/bitcoin/testnet/tokens-forwarding/automations?context=yourExampleString")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["X-API-Key"] = 'my-api-key'
request.body = "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"callbackSecretKey\": \"yourSecretString\",
            \"callbackUrl\": \"https:\/\/example.com\",
            \"confirmationsCount\": \"3\",
            \"feePriority\": \"standard\",
            \"minimumTransferAmount\": \"0.00002\",
            \"toAddress\": \"tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6\",
            \"tokenData\": {
                \"propertyId\": 31
            }
        }
    }
}"

response = http.request(request)
puts response.read_body

var https = require("https");

var options = {
  "method": "POST",
  "hostname": "rest.cryptoapis.io",
  "path": "/v2/blockchain-automations/bitcoin/testnet/tokens-forwarding/automations",
  "qs": {"context":"yourExampleString"},
  "headers": {
    "Content-Type": "application/json",
    "X-API-Key": "my-api-key"
  }
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
    "context": "yourExampleString",
    "data": {
        "item": {
            "callbackSecretKey": "yourSecretString",
            "callbackUrl": "https:\/\/example.com",
            "confirmationsCount": "3",
            "feePriority": "standard",
            "minimumTransferAmount": "0.00002",
            "toAddress": "tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6",
            "tokenData": {
                "propertyId": 31
            }
        }
    }
}));

req.end();

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://rest.cryptoapis.io/blockchain-automations/bitcoin/testnet/tokens-forwarding/automations?context=yourExampleString"

  payload := strings.NewReader("{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"callbackSecretKey\": \"yourSecretString\",
            \"callbackUrl\": \"https:\/\/example.com\",
            \"confirmationsCount\": \"3\",
            \"feePriority\": \"standard\",
            \"minimumTransferAmount\": \"0.00002\",
            \"toAddress\": \"tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6\",
            \"tokenData\": {
                \"propertyId\": 31
            }
        }
    }
}")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("X-API-Key", "my-api-key")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

201 400 401 402 403 404 409 415 422 429 500

Response Example

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "callbackUrl": "https://example.com",
            "confirmationsCount": 2,
            "createdTimestamp": 1611238648,
            "feeAddress": "mojjR51gMXLJ4B3SBPhEXXRFDX7U5UWXNQ",
            "feePriority": "standard",
            "fromAddress": "ms4KNsbNpoU8g424pzmEjbkFbfAHae1msB",
            "minimumTransferAmount": "0.5",
            "referenceId": "6017dd02a309213863be9e55",
            "toAddress": "tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6",
            "tokenData": {
                "propertyId": 31
            }
        }
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "callbackUrl": "https://example.com",
            "confirmationsCount": 2,
            "createdTimestamp": 1611238648,
            "feeAddress": "mojjR51gMXLJ4B3SBPhEXXRFDX7U5UWXNQ",
            "feePriority": "standard",
            "fromAddress": "ms4KNsbNpoU8g424pzmEjbkFbfAHae1msB",
            "minimumTransferAmount": "0.5",
            "referenceId": "6017dd02a309213863be9e55",
            "toAddress": "tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6",
            "tokenData": {
                "contractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7"
            }
        }
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "uri_not_found",
        "message": "The specified URI has not been found. Check the URI and try again.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "limit_greater_than_allowed",
        "message": "You have reached the allowed limit. The maximum number of items for this endpoint is {limit}, please use the specific pagination attributes to get the items in portions.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_pagination",
        "message": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "missing_api_key",
        "message": "The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_api_key",
        "message": "The provided API key is invalid. Please, generate a new one from your Dashboard.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "insufficient_credits",
        "message": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "banned_ip_address",
        "message": "This IP address has been banned. To check the reason for that, please contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_plan",
        "message": "This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_api_key",
        "message": "This endpoint is not available for your API key.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "feature_mainnets_not_allowed_for_plan",
        "message": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "tokens_forwarding_automations_limit_reached",
        "message": "Your current package plan tokens forwarding automations limit of {automations_limit} reached. Please contact us if you need more or upgrade your plan.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "resource_not_found",
        "message": "Resource not found",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_data",
        "message": "The data provided seems to be invalid.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unsupported_media_type",
        "message": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_request_body_structure",
        "message": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "request_limit_reached",
        "message": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unexpected_server_error",
        "message": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

TOKENS_FORWARDING_SUCCESS TOKENS_FORWARDING_FAIL

Callback Example

{
    "apiVersion": "2021-03-20",
    "referenceId": "6038d09050653d1f0e40584c",
    "idempotencyKey": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c",
    "data": {
        "product": "BLOCKCHAIN_AUTOMATIONS",
        "event": "TOKENS_FORWARDING_SUCCESS",
        "item": {
            "blockchain": "bitcoin",
            "network": "testnet",
            "fromAddress": "mySJoZ6wsjrKXZQRWpGoeBW5KkdKGL79Xz",
            "toAddress": "mmd963W1fECjLyaDCHcioSCZYHkRwjkGST",
            "spentFeesAmount": "0.00013601",
            "spentFeesUnit": "BTC",
            "triggerTransactionId": "6ed1f1c8f2887a78ee8c45a975d928ca63eafc7b63def56324606ddd3cc9854f",
            "forwardingTransactionId": "b15ab5bbaf5107d551ae1b50181f4c55959205c4ff843e3c10d86d00e690fc72",
            "tokenType": "OMNI",
            "token": {
                "name": "Tether USD",
                "symbol": "USDT",
                "decimals": "6",
                "amount": "0.00039",
                "contractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7"
            }
        }
    }
}

{
    "apiVersion": "2021-03-20",
    "referenceId": "6038d09050653d1f0e40584c",
    "idempotencyKey": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c",
    "data": {
        "product": "BLOCKCHAIN_AUTOMATIONS",
        "event": "TOKENS_FORWARDING_SUCCESS",
        "item": {
            "blockchain": "bitcoin",
            "network": "testnet",
            "fromAddress": "mySJoZ6wsjrKXZQRWpGoeBW5KkdKGL79Xz",
            "toAddress": "mmd963W1fECjLyaDCHcioSCZYHkRwjkGST",
            "spentFeesAmount": "0.00013601",
            "spentFeesUnit": "BTC",
            "triggerTransactionId": "6ed1f1c8f2887a78ee8c45a975d928ca63eafc7b63def56324606ddd3cc9854f",
            "forwardingTransactionId": "b15ab5bbaf5107d551ae1b50181f4c55959205c4ff843e3c10d86d00e690fc72",
            "tokenType": "OMNI",
            "token": {
                "name": "Wonky Stonks",
                "symbol": "WSTK",
                "tokenId": "5027",
                "contractAddress": "0x518ba36f1ca6dfe3bb1b098b8dd0444030e79d9f"
            }
        }
    }
}

{
    "apiVersion": "2021-03-20",
    "referenceId": "6038d09050653d1f0e40584c",
    "idempotencyKey": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c",
    "data": {
        "product": "BLOCKCHAIN_AUTOMATIONS",
        "event": "TOKENS_FORWARDING_SUCCESS",
        "item": {
            "blockchain": "bitcoin",
            "network": "testnet",
            "fromAddress": "mySJoZ6wsjrKXZQRWpGoeBW5KkdKGL79Xz",
            "toAddress": "mmd963W1fECjLyaDCHcioSCZYHkRwjkGST",
            "spentFeesAmount": "0.00013601",
            "spentFeesUnit": "BTC",
            "triggerTransactionId": "6ed1f1c8f2887a78ee8c45a975d928ca63eafc7b63def56324606ddd3cc9854f",
            "forwardingTransactionId": "b15ab5bbaf5107d551ae1b50181f4c55959205c4ff843e3c10d86d00e690fc72",
            "tokenType": "OMNI",
            "token": {
                "name": "TetherUSDT",
                "propertyId": "31",
                "transactionType": "Simple Send, DEx Purchase etc.",
                "createdByTransactionId": "be5be71feac9e7019fbcdea5a87098a7862a0ee8c60bd5809b4d3b0cda940ddc",
                "amount": "110.531723"
            }
        }
    }
}

{
    "apiVersion": "2021-03-20",
    "referenceId": "6038d09050653d1f0e40584c",
    "idempotencyKey": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c",
    "data": {
        "product": "BLOCKCHAIN_AUTOMATIONS",
        "event": "TOKENS_FORWARDING_FAIL",
        "item": {
            "blockchain": "bitcoin",
            "network": "testnet",
            "fromAddress": "mizRduUBKEbJ6uzYJUegPh78gEGgM3WjAr",
            "toAddress": "mnumE76iEKN47bUsdni85oped5D1fRwKWi",
            "triggerTransactionId": "ba1a4e661d36457abc46ea0effef0105f639912119fc64df8fb866118ce7c0d8",
            "errorCode": "FEE_ADDRESS_OUT_OF_FUNDS",
            "errorMessage": "You have insufficient credits."
        }
    }
}

Key	Value

Create Automatic Tokens Forwarding

Path Parameters

Query parameters

Request body schema application/json

Response schema

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Callback parameters Method : POST

Content-Type : application/json

Object :

Content-Type : application/json

Object :

Credits Cost : 1000 Credits For 1 Result(s)

Request Example

Response Example

Callback Example

Try It Out API Endpoint