Delete Automatic Tokens Forwarding

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

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

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

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

    Example : testnet
    Possible Values : mainnet testnet ropsten rinkeby
  • Required
    referenceId string

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

    Example : 6017dd02a309213863be9e55

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.

Response schema

200 400 401 402 403 404 409 415 422 429 500
HTTP Status Code: 200
Content-Type: application/json

The delete request has been successful.

  • Object :

  • Required
    apiVersion string

    Specifies the version of the API that incorporates this endpoint.

    Example : 2.0
  • 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 : You can add any text here
  • 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.

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

        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
Try it out

Request Example

DELETE
https://rest.cryptoapis.io/v2/blockchain-automations/bitcoin/testnet/tokens-forwarding/automations/6017dd02a309213863be9e55
Headers
Host: https://rest.cryptoapis.io/v2
Content-Type: application/json
X-API-Key: my-api-key

Response Example

{
    "apiVersion": "2.0",
    "requestId": "601c1710034ed6d407996b30",
    "context": "You can add any text here",
    "data": {
        "item": {
            "callbackUrl": "https://example.com",
            "confirmationsCount": 2,
            "createdTimestamp": 1611238648,
            "feeAddress": "mojjR51gMXLJ4B3SBPhEXXRFDX7U5UWXNQ",
            "feePriority": "",
            "fromAddress": "ms4KNsbNpoU8g424pzmEjbkFbfAHae1msB",
            "minimumTransferAmount": "0.5",
            "referenceId": "6017dd02a309213863be9e55",
            "toAddress": "tb1q54j7qcu7kgsrx87yn0r9zjdvsxrnvxg4qua2z6",
            "tokenData": {
                "propertyId": 31
            }
        }
    }
}