Module cryptoapis::apis::automatic_tokens_forwarding_api [−][src]
Enums
struct for typed errors of method add_tokens_to_existing_from_address
struct for typed errors of method create_automatic_tokens_forwarding
struct for typed errors of method delete_automatic_tokens_forwarding
struct for typed errors of method get_fee_address_details
struct for typed errors of method list_tokens_forwarding_automations
Functions
Through this endpoint customers can add Automatic Tokens forwardings to an already existing fromAddress. Unlike the "Create Automatic Tokens Forwarding" endpoint, where the fromAddress is generated each time, with this endpoint customers can add an automation from another token to one and the same fromAddress. The fromAddress 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. The toAddress is essentially the main address and 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". For this automatic forwarding the customer can set a callback subscription. {warning}The subscription will work for all incoming transactions until it is deleted. There is no need to do that for every transaction.{/warning}
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. {warning}The subscription will work for all incoming transactions until it is deleted. There is no need to do that for every transaction.{/warning} {note}This endpoint generates a new fromAddress each time.{/note}
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". {warning}The subscription will work for all incoming transactions until it is deleted. There is no need to do that for every transaction.{/warning}
Through this endpoint customers can obtain details about a fee address. Only one fee address per currency per network for a user’s account can be set no matter how many tokens or subscriptions they have or want to automatically forward.
Through this endpoint customers can list all of their tokens forwarding automations (not coins). Customers can set up automatic forwarding functions for tokens by setting a fromAddress and a toAddress, and specifying the amount that 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". {warning}The subscription will work for all incoming transactions until it is deleted. There is no need to do that for every transaction.{/warning} {note}Please note that listing data from the same type will apply pagination on the results.{/note}