/sendPayloadToBeSigned

1 min

POST

http://1.1.1.1/sendPayloadToBeSigned

This function is used to send a payload for signing, to check the transaction's status, you can access the getTransactionByToken function using the token generated by getCurrentToken before sending this request.
sendPayloadToBeSigned - for Stellar transactions only at the moment

********** NOTE: success or failure in this api call does not necessarily means success or failure in the transaction itself. for example, the transaction may work by the response to the client can be lost in communication (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,"BTC")

account_idintegerThe account ID we want to use in this operation

coin_typestring<p>Currency to sign with, Currently supported only for XLM.</p>

bytesToSignstring64 hexadecimal chars to sign on without 0x

from_addressstringthe address to send transaction from

descriptionstringfree text for the transaction

bodyobjectRequest data for signing a transaction.

200success

curl --request POST \
     --url 'http://1.1.1.1/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"
     }
     }'

This function is used to send a payload for signing, to check the transaction's status, you can access the getTransactionByToken function using the token generated by getCurrentToken before sending this request.
sendPayloadToBeSigned - for Stellar transactions only at the moment

** NOTE: success or failure in this api call does not necessarily means success or failure in the transaction itself. for example, the transaction may work by the response to the client can be lost in communication (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,"BTC")