/sendRippleTransaction

1 min

POST

Send a Ripple (XRP) transaction using the specified parameters.

Use getSuggestedFee to get the current suggested fee before running the transaction.

NOTE: Success or failure in this API call does not necessarily mean success or failure in the transaction itself. For example, the transaction may succeed, but the "success" response to the client can be lost if the client's internet connection is down. To verify the status of the transaction:

Call getCurrentToken and make a note of the return value.
Send your transaction. The transaction created uses the token from step 1.
Call getTransactionByToken using your token from getCurrentToken to track the current status of the transaction you just sent.

This function is part of the transaction flow detailed at https://docs.gk8.io/api-v19/sending-transactions-from-the-api. See the linked article for more details.

return: JSON object containing the transaction details.

example: | sendRippleTransaction(1, [("rHr5Aejv6MGW1Q3tGknsvTbR3fztZ9mH4x", "5", 1)], 10) sendRippleTransaction(1, [("rHr5Aejv6MGW1Q3tGknsvTbR3fztZ9mH4x", "5")], 10)

account_idintegerThe account ID to use in this operation.

outputsarrayList of tuples representing the destination address and amount to transfer. <ul> <li>Format: [(destination_address: str, amount_to_transfer: int)]</li> </ul>

feeintegerThe fee to pay for this transaction, in XRP Drop.

descriptionstringText for describing the transaction in your records. This is not sent to the blockchain.

specificFromAddressstringDeposit address to send from. Cannot be used if the account is defined as an Omnibus account.

acceptstringGenerated from available response content types

bodyobjectRequest data for a Ripple (XRP) transfer.

200success

curl --request POST \
     --url '/sendRippleTransaction?account_id=1&outputs=array&fee=10&description=Test&specificFromAddress=rWuPfXWprH9er4NvbBam4J1KzAQJLnQvb' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "AccountId": 1,
     "CoinType": "XRP",
     "Fee": {
     "Fee": 10
     },
     "SpecificFromAddress": "rWuPfXWprH9er4NvbBam4J1KzAQJLnQvb",
     "Transactions": [
     {
     "AmountToTransfer": "5",
     "DestinationAddress": "rHr5Aejv6MGW1Q3tGknsvTbR3fztZ9mH4x"
     }
     ],
     "UserDescription": "Test",
     "Meta": {
     "FunctionName": "sendRippleTransaction",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'