REST API›Wallet & Transact›Address

POST

Forward tokens from address

This API call is to manually forward tokens from an ETH or CELO address

Path Params

  • coin string required
    A cryptocurrency symbol or token ticker symbol
  • walletId string required

    matches ^[0-9a-f]{32}$

  • addressId string required
    Address or Id which will be used for information lookup

    matches ^[0-9a-f]{32}$

Body Params

object

  • tokenName string
    Name of token that needs to be forwarded from the address
  • forceFlush boolean
    Use forceFlush: true to flush the tokens from forwarder irrespective of the balance of the forwarders

    Defaults to false

  • gasPrice number
    Explicit gas price to use when forwarding token from the forwarder contract (ETH and Celo only). If not given, defaults to the current estimated network gas price.
  • eip1559 object
    Specify eip1559 fee parameters in token forwarding transaction.
    eip1559 object
    • maxFeePerGas number required
      Max total gasPrice for EIP1559 transactions. Only for ETH and ERC20 tokens.
    • maxPriorityFeePerGas number required
      Max priority tip price for EIP1559 transactions. Only for ETH and ERC20 tokens.

Responses

200
OK

Response Body

object

  • txId string required
400
Bad Request

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
401
Unauthorized

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id