Create Account Based Transaction Request from Address

Through this endpoint users can create a new single transaction request from one address to another.

key.singleItemTitle POST /vaults/{vaultId}/{blockchain}/{network}/addresses/{address}/transaction-requests

Path Parameters

Required
address string

Defines the specific source address for the transaction.

Example : 0x0902a667d6a3f287835e0a4593cae4167384abc6
Required
blockchain string

Represents the specific blockchain protocol name, e.g. Ethereum, Binance Smart Chain, etc.

Example : ethereum

Possible Values : ethereum binance-smart-chain
Required
network string

Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "sepolia" are test networks.

Example : sepolia

Possible Values : mainnet mordor testnet sepolia
Required
vaultId string

Represents the sender's specific and unique Wallet ID of the sender.

Example : 629df9dbae857c00073de9c8

Query Paramaters

Optional
context string

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

Example : yourExampleString

Request Body Schema application/json

Optional
context string

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

Example : yourExampleString
Required
data object
- Required
  item object
  - Required
    amount string
    
    Represents the specific amount of the transaction.
    
    Example : 0.2
  - Required
    feePriority string
    
    Represents the fee priority of the automation, whether it is "slow", "standard" or "fast".
    
    Example : slow
    
    Possible Values : slow standard fast
  - Optional
    note string
    
    Represents an optional note to add a free text in, explaining or providing additional detail on the transaction request.
    
    Example : yourAdditionalInformationhere
  - Required
    recipientAddress string
    
    Defines the specific recipient address for the transaction.
    
    Example : 0xc6d46aba0c6e2eb6358c4e24804158cc4d847922

Response Schema

201 400 401 402 403 409 415 422 429 500

Http Status Code: 201
Content Type: application/json

The resource has been successfully created.

Object :
Required
apiVersion string

Specifies the version of the API that incorporates this endpoint.

Example : 2024-05-09
Required
requestId string

Defines the ID of the request. The requestId is generated by Vaultody and it's unique for every request.

Example : 601c1710034ed6d407996b30
Optional
context string

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

Example : yourExampleString
Required
data
object
- Required
  item object
  
  Optional
  addressTag integer
  
  Defines a specific Tag that is an additional XRP address feature. It helps identify a transaction recipient beyond a wallet address. The tag that was encoded into the x-Address along with the Source Classic Address.
  
  Example : 3999472835
  
  Optional
  classicAddress string
  
  Represents the public address, which is a compressed and shortened form of a public key. The classic address is shown when the source address is an x-Address.
  
  Example : rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z
  
  Required
  feePriority string
  
  Represents the fee priority of the automation, whether it is "slow", "standard" or "fast".
  
  Example : standard
  
  Possible Values : slow standard fast
  
  Optional
  note string
  
  Represents an optional note to add a free text in, explaining or providing additional detail on the transaction request.
  
  Example : yourAdditionalInformationhere
  
  Required
  recipients array
  
  Defines the destination for the transaction, i.e. the recipient(s).
  
  Required
  address string
  
  Defines the destination address.
  
  Example : 0xc6d46aba0c6e2eb6358c4e24804158cc4d847922
  
  Optional
  addressTag integer
  
  Defines a specific Tag that is an additional XRP address feature. It helps identify a transaction recipient beyond a wallet address. The tag that was encoded into the x-Address along with the Source Classic Address.
  
  Example : 3999472835
  
  Required
  amount string
  
  Defines the amount sent to the destination address.
  
  Example : 0.0023
  
  Optional
  classicAddress string
  
  Represents the public address, which is a compressed and shortened form of a public key. The classic address is shown when the source address is an x-Address.
  
  Example : rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z
  
  Required
  senders object
  
  Defines details about the source, i.e. the sender.
  
  Required
  address string
  
  Defines the sender's public address.
  
  Example : 0x0902a667d6a3f287835e0a4593cae4167384abc6
  
  Required
  transactionRequestId string
  
  Represents a unique identifier of the transaction request (the request sent to make a transaction), which helps in identifying which callback and which referenceId concern that specific transaction request.
  
  Example : 6017dd02a309213863be9e55
  
  Required
  transactionRequestStatus string
  
  Defines the status of the transaction request, e.g. "created".
  
  Example : created
  
  Possible Values : created

Request Example

Http Java C# PHP Python Ruby Node.js Go

POST

https://rest.vaultody.com/vaults/629df9dbae857c00073de9c8/ethereum/sepolia/addresses/0x0902a667d6a3f287835e0a4593cae4167384abc6/transaction-requests?context=yourExampleString

Headers

Content-Type: application/json

x-api-key: cb233681a8ee35665296c1824c1f67bc46691788

x-api-sign: PSqeqRLap8rBc/wogNU1DeGGUPb2VyVtg6GiBOaBnYQ=

x-api-timestamp: 1681885776

x-api-passphrase: zYgKeueoOq

Request Body

{
    "context": "yourExampleString",
    "data": {
        "item": {
            "amount": "0.2",
            "feePriority": "slow",
            "note": "yourAdditionalInformationhere",
            "recipientAddress": "0xc6d46aba0c6e2eb6358c4e24804158cc4d847922"
        }
    }
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"amount\": \"0.2\",
            \"feePriority\": \"slow\",
            \"note\": \"yourAdditionalInformationhere\",
            \"recipientAddress\": \"0xc6d46aba0c6e2eb6358c4e24804158cc4d847922\"
        }
    }
}");
Request request = new Request.Builder()
  .url("https://rest.vaultody.com/vaults/629df9dbae857c00073de9c8/ethereum/sepolia/addresses/0x0902a667d6a3f287835e0a4593cae4167384abc6/transaction-requests?context=yourExampleString")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("X-API-Key", "my-api-key")
  .build();

Response response = client.newCall(request).execute();

var client = new RestClient("https://rest.vaultody.com/vaults/629df9dbae857c00073de9c8/ethereum/sepolia/addresses/0x0902a667d6a3f287835e0a4593cae4167384abc6/transaction-requests?context=yourExampleString");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader(""X-API-Key", "my-api-key");
request.AddParameter("application/json", "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"amount\": \"0.2\",
            \"feePriority\": \"slow\",
            \"note\": \"yourAdditionalInformationhere\",
            \"recipientAddress\": \"0xc6d46aba0c6e2eb6358c4e24804158cc4d847922\"
        }
    }
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

$request = new HttpRequest();
$request->setUrl('https://rest.vaultody.com/vaults/629df9dbae857c00073de9c8/ethereum/sepolia/addresses/0x0902a667d6a3f287835e0a4593cae4167384abc6/transaction-requests?context=yourExampleString');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
    'Content-Type' => 'application/json',
    'X-API-Key' => 'my-api-key'
));

$request->setBody('{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"amount\": \"0.2\",
            \"feePriority\": \"slow\",
            \"note\": \"yourAdditionalInformationhere\",
            \"recipientAddress\": \"0xc6d46aba0c6e2eb6358c4e24804158cc4d847922\"
        }
    }
}');

try {
    $response = $request->send();

    echo $response->getBody();
} catch (HttpException $ex) {
    echo $ex;
}

import http.client

conn = http.client.HTTPConnection("https://rest.vaultody.com")

payload = "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"amount\": \"0.2\",
            \"feePriority\": \"slow\",
            \"note\": \"yourAdditionalInformationhere\",
            \"recipientAddress\": \"0xc6d46aba0c6e2eb6358c4e24804158cc4d847922\"
        }
    }
}"
    querystring = {"context":"yourExampleString"}
headers = {
  'Content-Type': "application/json",
  'X-API-Key': "my-api-key"
}

conn.request("POST", "vaults,629df9dbae857c00073de9c8,ethereum,sepolia,addresses,0x0902a667d6a3f287835e0a4593cae4167384abc6,transaction-requests",payload, headers=headers  , params=querystring )

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
}

require 'uri'
require 'net/http'

url = URI("https://rest.vaultody.com/vaults/629df9dbae857c00073de9c8/ethereum/sepolia/addresses/0x0902a667d6a3f287835e0a4593cae4167384abc6/transaction-requests?context=yourExampleString")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["X-API-Key"] = 'my-api-key'
request.body = "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"amount\": \"0.2\",
            \"feePriority\": \"slow\",
            \"note\": \"yourAdditionalInformationhere\",
            \"recipientAddress\": \"0xc6d46aba0c6e2eb6358c4e24804158cc4d847922\"
        }
    }
}"

response = http.request(request)
puts response.read_body

var https = require("https");
const querystring = require('node:querystring');
const query = {"context":"yourExampleString"};

var options = {
  "method": "POST",
  "hostname": "rest.vaultody.com",
  "path": "/v2/vaults/629df9dbae857c00073de9c8/ethereum/sepolia/addresses/0x0902a667d6a3f287835e0a4593cae4167384abc6/transaction-requests" + (Object.keys(query).length ? '?' + querystring.stringify(query) : ''),
  "headers": {
    "Content-Type": "application/json",
    "X-API-Key": "my-api-key",
    "X-API-SIGN": signature,
    "X-API-TIMESTAMP": timestamp,
    "X-API-PASSPHRASE": "my-pass-phrase",
  }
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
    "context": "yourExampleString",
    "data": {
        "item": {
            "amount": "0.2",
            "feePriority": "slow",
            "note": "yourAdditionalInformationhere",
            "recipientAddress": "0xc6d46aba0c6e2eb6358c4e24804158cc4d847922"
        }
    }
}));

req.end();

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://rest.vaultody.com/vaults/629df9dbae857c00073de9c8/ethereum/sepolia/addresses/0x0902a667d6a3f287835e0a4593cae4167384abc6/transaction-requests?context=yourExampleString"

  payload := strings.NewReader("{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"amount\": \"0.2\",
            \"feePriority\": \"slow\",
            \"note\": \"yourAdditionalInformationhere\",
            \"recipientAddress\": \"0xc6d46aba0c6e2eb6358c4e24804158cc4d847922\"
        }
    }
}")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("X-API-Key", "my-api-key")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

201 400 401 402 403 409 415 422 429 500

Response Example

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "addressTag": 3999472835,
            "classicAddress": "rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z",
            "feePriority": "standard",
            "note": "yourAdditionalInformationhere",
            "recipients": [
                {
                    "address": "0xc6d46aba0c6e2eb6358c4e24804158cc4d847922",
                    "addressTag": 3999472835,
                    "amount": "0.0023",
                    "classicAddress": "rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z"
                }
            ],
            "senders": {
                "address": "0x0902a667d6a3f287835e0a4593cae4167384abc6"
            },
            "transactionRequestId": "6017dd02a309213863be9e55",
            "transactionRequestStatus": "created"
        }
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "uri_not_found",
        "message": "The specified URI has not been found. Check the URI and try again.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "limit_greater_than_allowed",
        "message": "You have reached the allowed limit. The maximum number of items for this endpoint is {limit}, please use the specific pagination attributes to get the items in portions.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_pagination",
        "message": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "missing_api_key",
        "message": "The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_api_key",
        "message": "The provided API key is invalid. Please, generate a new one from your Dashboard.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "insufficient_credits",
        "message": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "banned_ip_address",
        "message": "This IP address has been banned. To check the reason for that, please contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_plan",
        "message": "This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_api_key",
        "message": "This endpoint is not available for your API key.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "feature_mainnets_not_allowed_for_plan",
        "message": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "wallet_as_a_service_provided_network_is_not_suitable_for_this_wallet_type",
        "message": "This wallet is not for the provided network.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_data",
        "message": "The data provided seems to be invalid.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "wallet_as_a_service_wallet_balance_not_enough",
        "message": "Your wallet balance is insufficient to complete this action. Please check for any pending transaction requests or add more funds.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "wallet_as_a_service_address_balance_not_enough",
        "message": "Your address balance is insufficient to complete this action. Please check for any pending transaction requests or add more funds.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unsupported_media_type",
        "message": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_request_body_structure",
        "message": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "request_limit_reached",
        "message": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unexpected_server_error",
        "message": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

key.key	key.value

Create Account Based Transaction Request from Address

Path Parameters

Query Paramaters

Request Body Schema application/json

Response Schema

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Request Example

Response Example

Try It Out