Jump to
Ctrl
+
/

Delete Automatic Tokens Forwarding

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

Through this endpoint customers can delete a forwarding function they have set for tokens (not coins).

By setting a fromAddress and a toAddress, and specifying the amount, tokens can be transferred between addresses.

A feePriority will be returned which represents the fee priority of the automation whether it is "SLOW", "STANDARD" OR "FAST".

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.

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.

referenceId string Required

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

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.

Response Schema

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2021-03-20
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

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.

yourExampleString
data object Required
item object Required
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.

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.

2
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 object Required
propertyId integer Required

Defines the propertyId of the Omni Layer token.

31

Credits Cost : 100 Credits for 1 Results

Was this page helpful?
Yes
No
Language
URL

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