Skip to main content

send

Transfer tokens from the wallets available balance to a recipient.

Parameters​

  • recipient: (string) [required] The address of the recipient.
  • currency: (string) [required] The currency of tokens to send.
  • amount: (string) [required] The amount of tokens to send.
  • comment: (string) [optional] An optional transaction comment only visible to the wallet owner.
  • destination_tag: (int) [optional] An arbitrary unsigned integer attached to the transaction on the blockchain.
  • invoice_id: (string) [optional] An arbitrary 256-bit hash attached to the transaction on the blockchain.

Returns​

A transaction object.

Example​

Request​

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "send",
  "params": {
    "recipient": "rpxH1mgodXi34x7GxTk6m8TmShgc7xuwSu",
    "currency": "XRP",
    "amount": "5.0",
    "comment": "test transaction",
    "destination_tag": 32143,
  }
}

Response​

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": "<TRANSACTION_OBJECT>,
}