Jump to
Ctrl
+
/

Create Automatic Coins Forwarding

POST
/blockchain-automations/{blockchain}/{network}/coins-forwarding/automations

Through this endpoint customers can set up an automatic forwarding function specifically for coins (not tokens). They can have a toAddress which is essentially the main address and the destination for the automatic coins 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 coins 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.

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 network like "testnet" is a test network.

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

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.

data object Required
item object Required
callbackSecretKey string Required

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

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.

3
createdTimestamp integer Required

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

1611238648
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 currency.

mzAsK3csTnozLnYVdca4gaoH1btBZBC6QB
minimumTransferAmount string Required

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

0.0002
referenceId string Required

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

6017c964973cdcf4d4f69e29
toAddress string Required

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

mzYijhgmzZrmuB7wBDazRKirnChKyow4M3

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.

COINS_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

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.

testnet
fromAddress string Required

Represents the hash of the address that provides the coins.

mmd963W1fECjLyaDCHcioSCZYHkRwjkGST
toAddress string Required

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

ms4KNsbNpoU8g424pzmEjbkFbfAHae1msB
forwardedAmount string Required

Represents the amount of coins that have been forwarded.

00059441
forwardedUnit string Required

Represents the unit of coins that have been forwarded, e.g. BTC.

BTC
spentFeesAmount string Required

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

0.00022827
spentFeesUnit string Required

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

BTC
triggerTransactionId string Required

Defines the unique Transaction ID that triggered the coin forwarding.

86a7546bde4ac28b34504909d138592a6d6fc1277ea1f8f2f9c75dc04bdf3b7b
forwardingTransactionId string Required

Defines the unique Transaction ID that forwarded the coins.

2241b5264fac8acb92e9fc597035b99cdd22f6578d63c6f52b099729f7c4f979

Credits Cost : 1000 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": 3,
            "createdTimestamp": 1611238648,
            "feePriority": "standard",
            "fromAddress": "mzAsK3csTnozLnYVdca4gaoH1btBZBC6QB",
            "minimumTransferAmount": "0.0002",
            "referenceId": "6017c964973cdcf4d4f69e29",
            "toAddress": "mzYijhgmzZrmuB7wBDazRKirnChKyow4M3"
        }
    }
}
{
    "apiVersion": "2021-03-20",
    "referenceId": "6038d09050653d1f0e40584c",
    "idempotencyKey": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c",
    "data": {
        "product": "BLOCKCHAIN_AUTOMATIONS",
        "event": "COINS_FORWARDING_SUCCESS",
        "item": {
            "blockchain": "bitcoin",
            "network": "testnet",
            "fromAddress": "mmd963W1fECjLyaDCHcioSCZYHkRwjkGST",
            "toAddress": "ms4KNsbNpoU8g424pzmEjbkFbfAHae1msB",
            "forwardedAmount": "00059441",
            "forwardedUnit": "BTC",
            "spentFeesAmount": "0.00022827",
            "spentFeesUnit": "BTC",
            "triggerTransactionId": "86a7546bde4ac28b34504909d138592a6d6fc1277ea1f8f2f9c75dc04bdf3b7b",
            "forwardingTransactionId": "2241b5264fac8acb92e9fc597035b99cdd22f6578d63c6f52b099729f7c4f979"
        }
    }
}