/sendPayloadToBeSigned
1 min
POST
http://1.1.1.1/sendPayloadToBeSigned
Query Parameters
- account_idintegerrequiredExampleDescriptionDefault1
- coin_typestringrequiredExampleDescriptionDefaultXLM
- bytesToSignstringrequiredExampleDescriptionDefault233c83369d1afc58bfca8a62bf227ed264b07810bfd3075113d4c5a587a4f859
- from_addressstringExampleDescriptionDefaultGBMDG2KCYGH3CKERPIVY6W7KG2MQOP7DNT3SGF2X3E6UTDZ3RKBAAUXQ
- descriptionstringExampleDescriptionDefaultexample
Body Parameters
- bodysendPayloadToBeSignedRequestDescription
- AccountIdintegerExampleDescriptionDefault1
- BytesToSignstringExampleDescriptionDefault233c83369d1afc58bfca8a62bf227ed264b07810bfd3075113d4c5a587a4f859
- CoinTypestringExampleDescriptionDefaultXLM
- SpecificFromAddressstringExampleDescriptionDefaultGBMDG2KCYGH3CKERPIVY6W7KG2MQOP7DNT3SGF2X3E6UTDZ3RKBAAUXQ
- UserDescriptionstringExampleDescriptionDefaultexample
- MetaMetaTokensendPayloadToBeSigned
- FunctionNamestringExampleDescriptionDefaultsendPayloadToBeSigned
- RandomDatastringExampleDescriptionDefault288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229
- DestinationstringDescriptionDefaultb9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea
- TimestringExampleDescriptionDefault2021-02-07T18:37:46.948Z
- SourcestringDescriptionDefault048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99
- AccessTokenstringExampleDescriptionDefault51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087
Responses
200
- sendPayloadToBeSignedResponse
- FunctionDataobject
- ApprovalRequestStatusintegerExampleDescriptionDefault4
- BytesToSignstringExampleDescriptionDefault233c83369d1afc58bfca8a62bf227ed264b07810bfd3075113d4c5a587a4f859
- MetaMetaResponse
- AccessTokenstringExampleDescriptionDefaulta3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6
- DestinationstringExampleDescriptionDefault042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622
- SourcestringExampleDescriptionDefaultdf4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355
- TimestringExampleDescriptionDefault2021-02-14 09:58:52.320
curl
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"
}
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"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"
}
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("http://1.1.1.1/sendPayloadToBeSigned?account_id=1&coin_type=XLM&bytesToSign=233c83369d1afc58bfca8a62bf227ed264b07810bfd3075113d4c5a587a4f859&from_address=GBMDG2KCYGH3CKERPIVY6W7KG2MQOP7DNT3SGF2X3E6UTDZ3RKBAAUXQ&description=example", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("http://1.1.1.1/sendPayloadToBeSigned?account_id=1&coin_type=XLM&bytesToSign=233c83369d1afc58bfca8a62bf227ed264b07810bfd3075113d4c5a587a4f859&from_address=GBMDG2KCYGH3CKERPIVY6W7KG2MQOP7DNT3SGF2X3E6UTDZ3RKBAAUXQ&description=example")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"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"
}
})
response = http.request(request)
puts response.read_body
python
import requests
import json
url = "http://1.1.1.1/sendPayloadToBeSigned?account_id=1&coin_type=XLM&bytesToSign=233c83369d1afc58bfca8a62bf227ed264b07810bfd3075113d4c5a587a4f859&from_address=GBMDG2KCYGH3CKERPIVY6W7KG2MQOP7DNT3SGF2X3E6UTDZ3RKBAAUXQ&description=example"
payload = json.dumps({
"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"
}
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// success
{
"FunctionData": {
"ApprovalRequestStatus": 4,
"BytesToSign": "233c83369d1afc58bfca8a62bf227ed264b07810bfd3075113d4c5a587a4f859"
},
"Meta": {
"AccessToken": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6",
"Destination": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622",
"Source": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355",
"Time": "2021-02-14 09:58:52.320"
}
}- 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")