/sendPayloadToBeSigned

1 min

POST

Send payload to be signed for a specified account.

Note: Success or failure in this API call does not necessarily mean success or failure in the transaction itself. For example, the transaction may work, but the response to the client can be lost in communication (e.g., if the internet is down for the client). Another example is that the transaction was approved here but failed in the signing process. To know the status of the transaction, you can access the function getTransactionByToken. To get the token to send those functions, you should call getCurrentToken one action BEFORE sendTransaction: myTokenToStoreInTheDb = user.getCurrentToken() sendPayloadToBeSigned(...) user.getTransactionByToken(myTokenToStoreInTheDb, "XLM")

return: Regular response if successful, else error.

example: sendPayloadToBeSigned(1, "ETH", "acc25...915","0x5471...5De", "Test transaction")

account_idintegerThe account that holds the address to send from.

coin_typestring<p>One of the coins (currently supporting XLM, ETH, and NEAR).</p>

bytesToSignstring64 hexadecimal chars to sign on without 0x.

from_addressstring<p>The address to send the transaction from (optional).</p>

descriptionstringFree text description for the transaction.

acceptstringGenerated from available response content types

bodyobjectRequest data for signing a transaction.

200success

curl --request POST \
     --url '/sendPayloadToBeSigned?account_id=1&coin_type=XLM&bytesToSign=233c83369d1afc58bfca8a62bf227ed264b07810bfd3075113d4c5a587a4f859&from_address=GBMDG2KCYGH3CKERPIVY6W7KG2MQOP7DNT3SGF2X3E6UTDZ3RKBAAUXQ&description=example' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "AccountId": 1,
     "BytesToSign": "233c83369d1afc58bfca8a62bf227ed264b07810bfd3075113d4c5a587a4f859",
     "CoinType": "XLM",
     "SpecificFromAddress": "GBMDG2KCYGH3CKERPIVY6W7KG2MQOP7DNT3SGF2X3E6UTDZ3RKBAAUXQ",
     "UserDescription": "example",
     "Meta": {
     "FunctionName": "sendPayloadToBeSigned",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'