/sendCasperTransaction

1 min

POST

Send a Casper (CSPR) transaction using the specified parameters.

Use getSuggestedFee and getGasLimitSuggestedForTransaction to get current fee and gas information before running the transaction.

return: JSON object containing the transaction details.

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

Call /getCurrentToken and store it in the DB.
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.

example: sendCasperTransaction(1, [("01b3...7c8", 2500000000)], 1, 100000000)

account_idintegerThe account ID to use in this operation.

outputsarray<p>List of tuples representing the destination address and amount to transfer.</p> <ul> <li>Format: [(destination_address: str, amount_to_transfer: int)]</li> <li>In CSPR, it is optional to add a destination tag: [(destination_address: str, amount_to_transfer: int, destination_tag: int)]</li> </ul>

gas_priceinteger<p>The amount to pay for a unit of gas, in motes.</p>

payment_amountintegerThe amount of gas to pay.

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 object for initiating a transaction.

200success

curl --request POST \
     --url '/sendCasperTransaction?account_id=1&outputs=array&gas_price=1&payment_amount=100000000&description=Test&specificFromAddress=01e526b1475ea55490e683d169e9a36b347dd69c24ccbaea43ff678aaa4a08a971' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "FunctionData": {
     "AccountId": 1,
     "CoinType": "CSPR",
     "Fee": {
     "GasPrice": "1",
     "PaymentAmount": 100000000
     },
     "Transactions": [
     {
     "AmountToTransfer": "2500000000",
     "DestinationAddress": "01b331699e7581c196288e3183a337bd813f722c913b456a896e18e2790f7ec7c8"
     }
     ]
     }
     }'