v1 .2024-05-09

Jump to

Ctrl

General Information

Rest APIs

Vaults

Transactions

Addresses

Create Account Based Transaction Request from Address

POST

/vaults/{vaultId}/{blockchain}/{network}/addresses/{address}/transaction-requests

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

Path Parameters

address string Required

Defines the specific source address for the transaction.

blockchain string Required

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

network string Required

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.

vaultId string Required

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

Query Parameters

context string Optional

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.

Request Body Schema application/json

context string Optional

data object Required

item object Required

amount string Required

Represents the specific amount of the transaction.

feePriority string Required

Represents the fee priority of the automation, whether it is "slow", "standard" or "fast".

note string Optional

Represents an optional note to add a free text in, explaining or providing additional detail on the transaction request.

recipientAddress string Required

Defines the specific recipient address for the transaction.

Response Schema

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2024-05-09

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

data object Required

item object Required

addressTag integer Optional

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.

3999472835

classicAddress string Optional

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.

rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z

feePriority string Required

Represents the fee priority of the automation, whether it is "slow", "standard" or "fast".

standard

note string Optional

Represents an optional note to add a free text in, explaining or providing additional detail on the transaction request.

yourAdditionalInformationhere

recipients array Items (object) Required

Defines the destination for the transaction, i.e. the recipient(s).

address string Required

Defines the destination address.

0xc6d46aba0c6e2eb6358c4e24804158cc4d847922

addressTag integer Optional

3999472835

amount string Required

Defines the amount sent to the destination address.

0.0023

classicAddress string Optional

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.

rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z

senders object Required

Defines details about the source, i.e. the sender.

address string Required

Defines the sender's public address.

0x0902a667d6a3f287835e0a4593cae4167384abc6

transactionRequestId string Required

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.

6017dd02a309213863be9e55

transactionRequestStatus string Required

Defines the status of the transaction request, e.g. "created".

created

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2024-05-09

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

code string Required

Specifies an error code, e.g. error 404.

uri_not_found

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

The specified URI has not been found. Check the URI and try again.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2024-05-09

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

code string Required

Specifies an error code, e.g. error 404.

banned_ip_address

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

This IP address has been banned. To check the reason for that, please contact our team via email.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2024-05-09

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

code string Required

Specifies an error code, e.g. error 404.

invalid_data

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

The data provided seems to be invalid.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

Was this page helpful?

Yes

Language

URL

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

{
    "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"
            }
        ]
    }
}

Create Account Based Transaction Request from Address

Path Parameters

Query Parameters

Request Body Schema application/json

Response Schema

Security schema

URL Schema

Request