v1 .2023-04-25

Jump to

Ctrl

General Information

REST APIs

Wallet as a Service

Generating

Transactions

Informative

Blockchain Data

Unified Endpoints

Tokens

Internal

HD Wallets

Solana

XRP (Ripple)

Blockchain Events

Create Subscriptions for

Manage Subscriptions

Blockchain Automations

Automatic Coins Forwarding

Delete Automatic Coins Forwarding

DELETE

Automatic Tokens Forwarding

Blockchain Tools

Features

Market Data

Metadata

List Supported Assets

GET

Exchange Rates

Assets

Create Automatic Tokens Forwarding

POST

/blockchain-automations/{blockchain}/{network}/tokens-forwarding/automations

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.

Path Parameters

blockchain string Required

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

network string Required

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", "sepolia" are test networks.

Query Parameters

context string Optional

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.

Request Body Schema application/json

context string Optional

data object Required

item object Required

callbackSecretKey string Optional

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.

callbackUrl string Required

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.

confirmationsCount string Required

Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.

feePriority string Required

Represents the fee priority of the automation, whether it is "SLOW", "STANDARD" or "FAST".

minimumTransferAmount string Required

Represents the minimum transfer amount of the currency in the fromAddress that can be allowed for an automatic forwarding.

toAddress string Required

Represents the hash of the address the currency is forwarded to.

tokenData object Required

propertyId integer Required

Represents the specific propertyId of the token data that will be forwarded.

Response Schema

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2023-04-25

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

data object Required

item object Required

callbackUrl string Required

https://example.com

confirmationsCount integer Required

Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.

createdTimestamp integer Required

Defines the specific time/date when the automatic forwarding was created in Unix Timestamp.

1611238648

feeAddress string Required

Represents the specific fee address, which is always automatically generated. Users must fund it.

mojjR51gMXLJ4B3SBPhEXXRFDX7U5UWXNQ

feePriority string Required

Represents the fee priority of the automation, whether it is "SLOW", "STANDARD" or "FAST".

standard

fromAddress string Required

Represents the hash of the address that forwards the tokens.

ms4KNsbNpoU8g424pzmEjbkFbfAHae1msB

minimumTransferAmount string Required

Represents the minimum transfer amount of the tokens in the fromAddress that can be allowed for an automatic forwarding.

0.5

referenceId string Required

Represents a unique ID used to reference the specific callback subscription.

6017dd02a309213863be9e55

toAddress string Required

Represents the hash of the address the tokens are forwarded to.

tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6

tokenData Required

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2023-04-25

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

code string Required

Specifies an error code, e.g. error 404.

uri_not_found

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

The specified URI has not been found. Check the URI and try again.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2023-04-25

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

code string Required

Specifies an error code, e.g. error 404.

banned_ip_address

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

This IP address has been banned. To check the reason for that, please contact our team via email.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

Callback parameters

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2021-03-20

referenceId string Required

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

6038d09050653d1f0e40584c

idempotencyKey string Required

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.

e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c

data object Required

Specifies all data, as attributes, included into the callback notification, which depends on the event.

product string Required

Represents the Crypto APIs 2.0 product which sends the callback.

BLOCKCHAIN_AUTOMATIONS

event string Required

Defines the specific event, for which a callback subscription is set.

TOKENS_FORWARDING_SUCCESS

item object Required

Defines an item as one result.

blockchain string Required

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

bitcoin

network string Required

testnet

fromAddress string Required

Represents the hash of the address that provides the tokens.

mySJoZ6wsjrKXZQRWpGoeBW5KkdKGL79Xz

toAddress string Required

Represents the hash of the address to forward the tokens to.

mmd963W1fECjLyaDCHcioSCZYHkRwjkGST

spentFeesAmount string Required

Represents the amount of the fee spent for the tokens to be forwarded.

0.00013601

spentFeesUnit string Required

Represents the unit of the fee spent for the tokens to be forwarded, e.g. BTC.

BTC

triggerTransactionId string Required

Defines the unique Transaction ID that triggered the token forwarding.

6ed1f1c8f2887a78ee8c45a975d928ca63eafc7b63def56324606ddd3cc9854f

forwardingTransactionId string Required

Defines the unique Transaction ID that forwarded the tokens.

b15ab5bbaf5107d551ae1b50181f4c55959205c4ff843e3c10d86d00e690fc72

tokenType string Required

Defines the type of token sent with the transaction, e.g. ERC 20.

OMNI

token Required

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2021-03-20

referenceId string Required

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

6038d09050653d1f0e40584c

idempotencyKey string Required

e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c

data object Required

Specifies all data, as attributes, included into the callback notification, which depends on the event.

product string Required

Represents the Crypto APIs 2.0 product which sends the callback.

BLOCKCHAIN_AUTOMATIONS

event string Required

Defines the specific event, for which a callback subscription is set.

TOKENS_FORWARDING_FAIL

item object Required

Defines an item as one result.

blockchain string Required

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

bitcoin

network string Required

testnet

fromAddress string Required

Represents the hash of the address that provides the tokens.

mizRduUBKEbJ6uzYJUegPh78gEGgM3WjAr

toAddress string Required

Represents the hash of the address to forward the tokens to.

mnumE76iEKN47bUsdni85oped5D1fRwKWi

triggerTransactionId string Required

Defines the unique Transaction ID that triggered the token forwarding.

ba1a4e661d36457abc46ea0effef0105f639912119fc64df8fb866118ce7c0d8

errorCode string Required

Represents the error code received for the failed token forwarding.

FEE_ADDRESS_OUT_OF_FUNDS

errorMessage string Required

Represents the error message received for the failed token forwarding.

You have insufficient credits.

Credits Cost : 1000 Credits for 1 Results

Was this page helpful?

Yes

Language

URL

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

{
    "apiVersion": "2023-04-25",
    "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": ""
        }
    }
}

{
    "apiVersion": "2023-04-25",
    "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": "2023-04-25",
    "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": "2023-04-25",
    "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": "2023-04-25",
    "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": "2023-04-25",
    "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": "2023-04-25",
    "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": "2023-04-25",
    "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": "2023-04-25",
    "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": "2023-04-25",
    "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": "2023-04-25",
    "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": "2023-04-25",
    "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": "2023-04-25",
    "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": "2023-04-25",
    "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": "2023-04-25",
    "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": "2023-04-25",
    "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": "2023-04-25",
    "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": "2023-04-25",
    "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"
            }
        ]
    }
}

{
    "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": ""
        }
    }
}

{
    "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."
        }
    }
}

Create Automatic Tokens Forwarding

Path Parameters

Query Parameters

Request Body Schema application/json

Response Schema

Callback parameters

Credits Cost : 1000 Credits for 1 Results

Security schema

URL Schema

Request