Develop & Integrate
Protect & CapitalExplorerTDXUser & Technical Guides

Creating A Single Destination Transaction Request

POST https://your-protect-instance.example.com/api/rest/v1/requests/outgoing

Basic Description

This endpoint is used to create a Single Destination Outgoing Transaction Request in Taurus-PROTECT.
To understand what is a Transaction, what is a Request and the differences between these two concepts, please refer to the following page in the Taurus User Guides.

This endpoint would accept a POST Request with a JSON payload containing the Transaction Request details. The amount, fromAddressId or fromWalletId, and toAddressId or toWhitelistedAddressIdare the only required parameters that must be included within the JSON payload.

Prerequisites

Required Roles

Certain API endpoints require that the user has a specific role in order to access them. Roles are used to restrict access to certain functionality within the system and ensure that only authorized users are able to perform specific actions.

Here is the list of required Roles for this particular endpoint:

  • RequestCreator
  • TPUser

To find out more about roles, please refer to the following page in the Taurus User Guides.

Required Input Parameters

Certain API endpoints require specific input parameters. Here is the list of Required Input Parameters for this particular endpoint:

  • amount: the amount of the selected currency
  • fromAddressId or fromWalletId: the originating Address or Wallet
  • toAddressId or toWhitelistedAddressId: the destination internal or whitelisted external Address

🚧

Differences between fromWalletId and fromAddressId

For this particular endpoint, if you select to use fromAddressId, all the funds will be deducted from one single Address in Taurus-PROTECT.
However, if you select fromWalletId, Taurus-PROTECT will start from the address with the highest amounts of funds within the Wallet and continue to the next address until the required amount of funds is reached.

📘

Preconditions

It is important to note that the selected Wallets and Addresses needs to pre-exist and be active in the system. In addition, the amount within the Transaction Request needs to be smaller than the total amount of funds that is held on the originating Address or Wallet.

Call Example

You can find a basic example in cURL below.
Please note that you will need to update the BASEURL and the APITOKEN for the command to function.
In this example, Taurus-PROTECT has created a new Transaction Request with 1 XKI as the specified amount to be transferred from Address 458136 to Address 458128 and has assigned it a unique ID of 4132225.

export BASEURL=https://taurus-protect-instance.com
export APIToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZXh0ZXJuYWxVc2VySUQiOiJ0ZWFtMUV4dGVybmFsVXNlcklEIiwidGVuYW50SUQiOjEsImNhcGl0YWxUZW5hbnRJRCI6MSwiZmlyc3RuYW1lIjoiSm9obiIsImxhc3RuYW1lIjoiRG9lIiwicm9sZXMiOlsidHB1c2VyIl0sImVtYWlsIjoidGVhbTFAYmFuay5jb20iLCJ1c2VybmFtZSI6InRlYW0xIiwiand0X3JlbmV3YWJsZV9hbW91bnQiOjAsImlzX3RvdHBfZW5hYmxlZCI6ZmFsc2UsImF1dGhfc3RhdHVzIjoiU1VDQ0VTUyIsImxhc3RfbG9naW4iOiIyMDIzLTAxLTAxVDAwOjAwOjAwLjE0OTc0NDIzMloiLCJsb2dnZWRfaW5fd2l0aF9zc28iOmZhbHNlLCJrZXkiOiIiLCJleHAiOjE2ODEyMTkyNzYsImlhdCI6MTY4MTIxNzQ3Nn0.K_85arIrigpkN1yHttCydpeT6oVg2c6PyQnuji907Og
curl --location "$BASEURL/api/rest/v1/requests/outgoing" \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header "Authorization: Bearer $APIToken" \
--data '{
  "amount": "10000000",
  "fromAddressId": "458136",
  "toAddressId": "458128",
  "comment": "API-Documentation - Test 6",
  "useUnconfirmedFunds": true
  }'

This piece of code sends a POST request to https://your-protect-instance.example.comapi/rest/v1/requests/outgoing with the JSON string in the request body.

👍

Call Result

A successful response for the POST call to create a single destination Outgoing Transaction Request might look like this:

{
    "result": {
        "id": "4132225",
        "tenantId": "1",
        "currency": "XKI",
        "envelope": "Cgc0MTMyMjI1EPfcyP/OiqOpFxgSKoEKCDQS6QEKYwoJa2ljaGFpbi0yEhkKE20vNDQnLzExOCcvMCcvMCcvMicYhJMBGJ6lBSIEdXhraSoCCHhKKzQ1ODEzNjoxYjFhNTQ4Yi0xNzYyLTQ3MTgtODkyOC05ODU2ZjBlOWRkZWRgARKBAQocL2Nvc21vcy5iYW5rLnYxYmV0YTEuTXNnU2VuZBJhCilraTEzemFlcDA2cTQ5NHp3Zmp5bnp3bDdwZDk4Y3BsNnZqeDM0dWNhMhIpa2kxejd2cjhsYzVlZHMzbDh1NXA5MnBwejkwMzh1eW55NGQ1bHZ2MzAaCQoEdXhraRIBNSIXCgpyZXF1ZXN0X2lkEAEaBzQxMzIyMjUicgoJcnVsZXNfa2V5EAEaY0tpY2hhaW4vVGF1cnVzL2Nvc21vcy5iYW5rLnYxYmV0YTEuTXNnU2VuZChmcm9tX2FkZHJlc3MjMTpzdHJpbmcsdG9fYWRkcmVzcyMyOnN0cmluZyxhbW91bnQjMzpjb2luKSIRCghjdXJyZW5jeRABGgNYS0kiHwoUZmVlX3BhaWRfYnlfcmVjZWl2ZXIQARoFZmFsc2UiFwoIY2hhaW5faWQQARoJa2ljaGFpbi0yImEKB21lc3NhZ2UQARpUY29zbW9zLmJhbmsudjFiZXRhMS5Nc2dTZW5kKGZyb21fYWRkcmVzcyMxOnN0cmluZyx0b19hZGRyZXNzIzI6c3RyaW5nLGFtb3VudCMzOmNvaW4pIlwKBnNpZ25lchAEGlAIARJMCJj7GxIpa2kxM3phZXAwNnE0OTR6d2ZqeW56d2w3cGQ5OGNwbDZ2angzNHVjYTIaBkFkZHJfMyITbS80NCcvMTE4Jy8wJy8wJy8yJyJyChRtZXNzYWdlLmZyb21fYWRkcmVzcxAEGlAIARJMCJj7GxIpa2kxM3phZXAwNnE0OTR6d2ZqeW56d2w3cGQ5OGNwbDZ2angzNHVjYTIaBkFkZHJfMyITbS80NCcvMTE4Jy8wJy8wJy8yJyIGc291cmNlIn0KEm1lc3NhZ2UudG9fYWRkcmVzcxAFGlgSVgiQ+xsSKWtpMXo3dnI4bGM1ZWRzM2w4dTVwOTJwcHo5MDM4dXlueTRkNWx2djMwGhBUZXN0X0R1cGxpY2F0ZV8xIhNtLzQ0Jy8xMTgnLzgnLzAnLzAnIgtkZXN0aW5hdGlvbiKkAQoObWVzc2FnZS5hbW91bnQQChqHAQoBBRIGMC4wMDAwGgswLjA5Mzg5MTEyNiAGKgNYS0kyA0NIRjphCh12YWxpZGF0b3ItY29yZUB0YXVydXNncm91cC5jaBJAB9Fy6ShoqgrhyOf0sH9u+laCJknq1OdWFb9rUMYvAgbIC0Uo7/UU7O28KWa1t58UnN89A1KawlNScf1xPN5gqiIGYW1vdW50Ih0KEXRvdGFsX2ZpYXRfYW1vdW50EAEaBjAuMDAwMCISCglnYXNfbGltaXQQAhoDAVKeIhMKCWZlZV9kZW5vbRABGgR1eGtpIhEKCWZlZV9saW1pdBACGgIZaCIfChV1c2VfdW5jb25maXJtZWRfZnVuZHMQARoEdHJ1ZSIcChFpc19jYW5jZWxfcmVxdWVzdBABGgVmYWxzZSJCCg90cmFuc2FjdGlvbl9pZHMQBhotCis0NTgxMzY6MWIxYTU0OGItMTc2Mi00NzE4LTg5MjgtOTg1NmYwZTlkZGVkOgdraWNoYWlu",
        "status": "CREATED",
        "trails": [
            {
                "userId": "11",
                "externalUserId": "[email protected]",
                "action": "created",
                "comment": "API Documentation Test - Call 5",
                "requestStatus": "CREATED"
            },
            {
                "userId": "1",
                "externalUserId": "[email protected]",
                "action": "approvers_assigned",
                "comment": "rule = [source: any, destination: any, amount: any], approvals = ['team1': 1 sig, 'team2': 1 sig]",
                "requestStatus": "CREATED"
            }
        ],
        "rule": "rule = [source: any, destination: any, amount: any], approvals = ['team1': 1 sig, 'team2': 1 sig]",
        "approvers": {
            "parallel": [
                {
                    "sequential": [
                        {
                            "externalGroupID": "team1",
                            "minimumSignatures": 1
                        },
                        {
                            "externalGroupID": "team2",
                            "minimumSignatures": 1
                        }
                    ]
                }
            ]
        },
        "type": "payment",
        "currencyInfo": {
            "name": "Ki",
            "symbol": "XKI",
            "blockchain": "Kichain",
            "isToken": true,
            "decimals": "6",
            "hasStaking": true,
            "isAccountBased": true,
            "enabled": true,
            "id": "195d61a493d1b456400d55de1392fb6ee060454caca885371c97a9ad20ff4006",
            "displayName": "Kichain - XKI",
            "type": "token",
            "network": "kichain"
        }
    }
}

Taurus-PROTECT responds with a JSON object containing the request details, including the Request status and the newly assigned Requestid.

Requirements for Future Use

For this particular endpoint, we need to store the Requestid as it will be required in the next step where we will sign the Transaction Request.

You can find the Swagger-generated page for this endpoint in the following link.

Updated 22 days ago



  © 2025 Taurus SA. All rights reserved.