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.
fromAddress
each time.Path Parameters
-
Requiredblockchain string
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
-
Requirednetwork 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.
Query parameters
-
Optionalcontext 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.
Request body schema application/json
-
Optionalcontext 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. -
Requireddata object
-
Requireditem object
-
OptionalcallbackSecretKey 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.
-
RequiredcallbackUrl 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
. -
RequiredconfirmationsCount string
Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.
-
RequiredfeePriority string
Represents the fee priority of the automation, whether it is "SLOW", "STANDARD" or "FAST".
-
RequiredminimumTransferAmount string
Represents the minimum transfer amount of the currency in the
fromAddress
that can be allowed for an automatic forwarding. -
RequiredtoAddress string
Represents the hash of the address the currency is forwarded to.
-
RequiredtokenData object One Ofobject
-
RequiredpropertyId integer
Represents the specific
propertyId
of the token data that will be forwarded.Example : 31
-
-
-
Response schema
Content-Type: application/json
The resource has been successfully created.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext 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 -
Requireddata object
-
Requireditem object
-
RequiredcallbackUrl 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 -
RequiredconfirmationsCount integer
Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.
Example : 2 -
RequiredcreatedTimestamp integer
Defines the specific time/date when the automatic forwarding was created in Unix Timestamp.
Example : 1611238648 -
RequiredfeeAddress string
Represents the specific fee address, which is always automatically generated. Users must fund it.
Example : mojjR51gMXLJ4B3SBPhEXXRFDX7U5UWXNQ -
RequiredfeePriority string
Represents the fee priority of the automation, whether it is "SLOW", "STANDARD" or "FAST".
Example : standard -
RequiredfromAddress string
Represents the hash of the address that forwards the tokens.
Example : ms4KNsbNpoU8g424pzmEjbkFbfAHae1msB -
RequiredminimumTransferAmount string
Represents the minimum transfer amount of the tokens in the
fromAddress
that can be allowed for an automatic forwarding.Example : 0.5 -
RequiredreferenceId string
Represents a unique ID used to reference the specific callback subscription.
Example : 6017dd02a309213863be9e55 -
RequiredtoAddress string
Represents the hash of the address the tokens are forwarded to.
Example : tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6 -
RequiredtokenData object One Ofobject
-
RequiredpropertyId integer
Defines the
propertyId
of the Omni Layer token.Example : 31
-
-
-
Callback parameters Method : POST
Content-Type : application/json
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredreferenceId 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 -
RequiredidempotencyKey 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 -
Requireddata object
Specifies all data, as attributes, included into the callback notification, which depends on the
event
.-
Requiredproduct string
Represents the Crypto APIs 2.0 product which sends the callback.
Example : BLOCKCHAIN_AUTOMATIONS -
Requiredevent string
Defines the specific event, for which a callback subscription is set.
Example : TOKENS_FORWARDING_SUCCESS -
Requireditem object
Defines an
item
as one result.-
Requiredblockchain string
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
Example : bitcoin -
Requirednetwork 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 -
RequiredfromAddress string
Represents the hash of the address that provides the tokens.
Example : mySJoZ6wsjrKXZQRWpGoeBW5KkdKGL79Xz -
RequiredtoAddress string
Represents the hash of the address to forward the tokens to.
Example : mmd963W1fECjLyaDCHcioSCZYHkRwjkGST -
RequiredspentFeesAmount string
Represents the amount of the fee spent for the tokens to be forwarded.
Example : 0.00013601 -
RequiredspentFeesUnit string
Represents the unit of the fee spent for the tokens to be forwarded, e.g. BTC.
Example : BTC -
RequiredtriggerTransactionId string
Defines the unique Transaction ID that triggered the token forwarding.
Example : 6ed1f1c8f2887a78ee8c45a975d928ca63eafc7b63def56324606ddd3cc9854f -
RequiredforwardingTransactionId string
Defines the unique Transaction ID that forwarded the tokens.
Example : b15ab5bbaf5107d551ae1b50181f4c55959205c4ff843e3c10d86d00e690fc72 -
RequiredtokenType string
Defines the type of token sent with the transaction, e.g. ERC 20.
Example : OMNI -
Requiredtoken object One Ofobject
-
Requiredname string
Specifies the name of the token.
Example : Tether USD -
Requiredsymbol string
Specifies an identifier of the token, where up to five alphanumeric characters can be used for it.
Example : USDT -
Optionaldecimals string
Defines how many decimals can be used to break the token.
Example : 6 -
Requiredamount string
Defines the amount of tokens sent with the confirmed transaction.
Example : 0.00039 -
RequiredcontractAddress string
Defines the address of the contract.
Example : 0xdac17f958d2ee523a2206206994597c13d831ec7
-
-
-