> This page is for Taurus PROTECT, version v3.38. > For other versions, use one of these documentation indexes: > - v3.58 (default): https://taurushq.ferndocs.com/protect-capital/v3.58/llms.txt > - v3.56: https://taurushq.ferndocs.com/protect-capital/v3.56/llms.txt > - v3.54: https://taurushq.ferndocs.com/protect-capital/v3.54/llms.txt > - v3.52: https://taurushq.ferndocs.com/protect-capital/v3.52/llms.txt > - v3.50: https://taurushq.ferndocs.com/protect-capital/v3.50/llms.txt > - v3.48: https://taurushq.ferndocs.com/protect-capital/v3.48/llms.txt > - v3.46: https://taurushq.ferndocs.com/protect-capital/v3.46/llms.txt > - v3.44: https://taurushq.ferndocs.com/protect-capital/v3.44/llms.txt > - v3.42: https://taurushq.ferndocs.com/protect-capital/v3.42/llms.txt > - v3.40: https://taurushq.ferndocs.com/protect-capital/v3.40/llms.txt > - v3.38: https://taurushq.ferndocs.com/protect-capital/v3.38/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://taurushq.ferndocs.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://taurushq.ferndocs.com/_mcp/server. # Create an outgoing request POST https://your-protect-instance.example.com/api/rest/v1/requests/outgoing Content-Type: application/json This endpoint creates an outgoing request. Required role: **RequestCreator**. This API can be made idempotent by generating an ID for the Request beforehand and passing it as the externalRequestId attribute Reference: https://taurushq.ferndocs.com/protect-capital/reference/requests/create-outgoing ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Body (application/json) This endpoint expects a tgvalidatordCreateOutgoingRequestRequest. - `amount` (string, required) — Amount in the smallest currency unit, based on the currency decimals. Example: 1500000000000000000 WEI (smallest ETH unit) corresponds to 1.5 ETH (ETH has 18 decimals places) - `feeLimit` (string, optional) - `fromWalletId` (string, optional) — A source should be specified. Either fromAddressId or fromWalletId. fromWalletId should be used to specify an omnibus wallet only. - `fromAddressId` (string, optional) — A source should be specified. Either fromAddressId or fromWalletId. fromAddressId should be used for using an address as source. - `toAddressId` (string, optional) — A destination should be specified. Either toAddressId or toWhitelistedAddressId. - `toWhitelistedAddressId` (string, optional) — A destination should be specified. Either toAddressId or toWhitelistedAddressId. - `gasLimit` (string, optional) - `comment` (string, optional) — A reconciliation notes can be given when initiating a request and this will be included in transaction history. - `useUnconfirmedFunds` (boolean, optional) - `feePaidByReceiver` (boolean, optional) - `transactionComment` (string, optional) - `useAllFunds` (boolean, optional) — If set to true, it will send all the funds from an address or from all the addresses of a wallet. If an address in a wallet can't pay the fees, it is skipped. - `feePayerId` (string, optional) - `extendedAmount` (tgvalidatordExtendedAmount, optional) - `transactionReference` (string, optional) — DEPRECATED - use externalRequestId instead - `externalRequestId` (string, optional) — Identifier for the request in the user's system. This must be unique. Attempting to create a request with an existing externalRequestId will do nothing and return the originally created request - `destinationAddressMemo` (string, optional) — A memo can be specified if the destination is a whitelisted address on a blockchain supporting memos. - `opts` (tgvalidatordBlockchainOpts, optional) - `travelRuleDataInput` (tgvalidatordTravelRuleDataInput, optional) ## Response ### 200 A successful response. - `result` (tgvalidatordRequest, optional) ## Errors ### 400 Bad Request Error Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing) - `any` ### 401 Unauthorized Error Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource - `any` ### 403 Forbidden Error Forbidden: indicates that the server understands the request but refuses to authorize it - `any` ### 404 Not Found Error Not Found: indicates that the server cannot find the requested resource - `any` ### 500 Internal Server Error Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request - `any` ### 503 Service Unavailable Error Service Unavailable: indicates that the server is not ready to handle the request. - `any` ## Types ### tgvalidatordExtendedAmount - `kind` (string, optional) - `nft` (tgvalidatordExtendedAmount_NFT, optional) ### tgvalidatordBlockchainOpts - `xlm` (tgvalidatordXLMOpts, optional) ### tgvalidatordTravelRuleDataInput - `originatorPersonTravelRuleData` (tgvalidatordPersonTravelRuleData, optional) - `originatorCompanyTravelRuleData` (tgvalidatordCompanyTravelRuleData, optional) - `beneficiaryCompanyTravelRuleData` (tgvalidatordCompanyTravelRuleData, optional) - `beneficiaryPersonTravelRuleData` (tgvalidatordPersonTravelRuleData, optional) - `provider` (string, optional) — Provider is the type of the travel rule data provider. Supported provider: 'TaurusNetwork' ### tgvalidatordRequest - `id` (string, optional) - `tenantId` (string, optional) - `currency` (string, optional) - `envelope` (string, optional) - `status` (string, optional) - `trails` (list of tgvalidatordRequestTrail, optional) - `signedRequests` (list of RequestSignedRequest, optional) - `creationDate` (datetime, optional) - `updateDate` (datetime, optional) - `metadata` (tgvalidatordMetadata, optional) - `attributes` (list of tgvalidatordRequestAttribute, optional) - `rule` (string, optional) - `approvers` (tgvalidatordApprovers, optional) - `type` (string, optional) - `currencyInfo` (tgvalidatordCurrency, optional) - `needsApprovalFrom` (list of string, optional) - `requestBundleId` (string, optional) - `externalRequestId` (string, optional) — Identifier for the request in the user's system. This must be unique. - `travelRuleDataInput` (tgvalidatordTravelRuleDataInput, optional) ### tgvalidatordExtendedAmount_NFT - `id` (string, optional) - `quantity` (string, optional) ### tgvalidatordXLMOpts - `SponsoredByAddressID` (string, optional) — (XLM Blockchain Field) If set, is the ID of the address who will sponsor the cost of the operation on the minimum balance of the source address ### tgvalidatordPersonTravelRuleData - `name` (string, optional) - `houseNumber` (string, optional) - `street` (string, optional) - `city` (string, optional) - `province` (string, optional) - `postalCode` (string, optional) - `country` (string, optional) - `idNumber` (string, optional) - `externalCustomerID` (string, optional) - `birthdate` (string, optional) - `birthPlace` (string, optional) - `accountNumber` (string, optional) ### tgvalidatordCompanyTravelRuleData - `department` (string, optional) - `buildingNumber` (string, optional) - `street` (string, optional) - `city` (string, optional) - `province` (string, optional) - `postalCode` (string, optional) - `country` (string, optional) - `legalEntityIdentifier` (string, optional) - `businessName` (string, optional) - `accountNumber` (string, optional) ### tgvalidatordRequestTrail - `id` (string, optional) - `userId` (string, optional) - `externalUserId` (string, optional) - `action` (string, optional) - `comment` (string, optional) - `date` (datetime, optional) - `requestStatus` (string, optional) ### RequestSignedRequest - `id` (string, optional) - `signedRequest` (string, optional) - `status` (string, optional) - `hash` (string, optional) - `block` (long, optional) - `details` (string, optional) - `creationDate` (datetime, optional) - `updateDate` (datetime, optional) - `broadcastDate` (datetime, optional) - `confirmationDate` (datetime, optional) - `attributes` (list of tgvalidatordSignedRequestAttribute, optional) ### tgvalidatordMetadata - `hash` (string, optional) - `payload` (any, optional) - `payloadAsString` (string, optional) ### tgvalidatordRequestAttribute - `id` (string, optional) - `key` (string, optional) - `value` (string, optional) - `contentType` (string, optional) ### tgvalidatordApprovers - `parallel` (list of tgvalidatordParallelApproversGroups, optional) ### tgvalidatordCurrency - `name` (string, optional) - `symbol` (string, optional) - `coinTypeIndex` (string, optional) - `blockchain` (string, optional) - `isToken` (boolean, optional) - `isERC20` (boolean, optional) - `decimals` (string, optional) - `contractAddress` (string, optional) - `hasStaking` (boolean, optional) - `isUTXOBased` (boolean, optional) - `isAccountBased` (boolean, optional) - `isFiat` (boolean, optional) - `isFA12` (boolean, optional) - `isFA20` (boolean, optional) - `isNFT` (boolean, optional) - `enabled` (boolean, optional) - `id` (string, optional) - `displayName` (string, optional) - `type` (string, optional) - `wlcaId` (string, optional) - `network` (string, optional) - `tokenID` (string, optional) - `logo` (string, optional) — Data URI Scheme (e.g. 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==') ### tgvalidatordSignedRequestAttribute - `id` (string, optional) - `key` (string, optional) - `value` (string, optional) - `contentType` (string, optional) ### tgvalidatordParallelApproversGroups - `sequential` (list of tgvalidatordApproversGroup, optional) ### tgvalidatordApproversGroup - `externalGroupID` (string, optional) - `minimumSignatures` (long, optional) ## Examples **Request** ```json { "amount": "100000", "fromAddressId": "1", "toAddressId": "204", "comment": "Ich bin eine flying Roasted Butternut Squash Boodles", "useUnconfirmedFunds": true, "feePaidByReceiver": true, "fee": "4865" } ``` **Response** ```json { "result": { "id": "442", "tenantId": "1", "currency": "BTC", "envelope": "CgM0NDIQmfGjk6Ops/oVGAEqmgUSrAEKPwoPbS80NCcvMCcvMCcvMC8wGiAeyruP7CoNYcGISzRo8iZmuVnV6M9gLiZuShy7aDtKKiABKNHEFDD/////DxIoCiIxQ3Zoeml0ZFZMUGhOVGZ3NU5rUm9YWHZveldacGZhWXQ2EJ/nBRoVCg9tLzQ0Jy8wJy8wJy8wLzAYsbcOMig0NDI6NDY5ZTMxOGUtYjcxZC00MGUwLTg0ZjctNzVlOGQwOWE3Yzg2IhMKCnJlcXVlc3RfaWQQARoDNDQyIhIKCXJ1bGVzX2tleRABGgNCVEMiEQoIY3VycmVuY3kQARoDQlRDIlsKBnNvdXJjZRAEGkcIARJDCAESIjFKTUJZTU1pOWlqSlJlVFlxdEZUU2RlVkJ6azhOSGRzVHUaCm5vc3RybyBCVEMiD20vNDQnLzAnLzAnLzAvMCIGc291cmNlImIKC2Rlc3RpbmF0aW9uEAUaRBJCCMwBEiIxQ3Zoeml0ZFZMUGhOVGZ3NU5rUm9YWHZveldacGZhWXQ2GghteSBsYWJlbCIPbS80NCcvMCcvMCcvMC84IgtkZXN0aW5hdGlvbiKeAQoGYW1vdW50EAoaiQEKAwGGoBIHMTAuMDQzMBoKMTAwNDIuOTcwMCAIKgNCVEMyA0NIRjphCh12YWxpZGF0b3ItY29yZUB0YXVydXNncm91cC5jaBJAffe4nBGVSajYYQxxzEZbQuj0snr8WOC1P506eXRn2EUsDrAnkWvNW9wfU+pwUoBVUaXl/veYW/6m/DJsEKijLCIGYW1vdW50Ih4KEXRvdGFsX2ZpYXRfYW1vdW50EAEaBzEwLjA0MzAiCwoDZmVlEAIaAhMBIh4KFGZlZV9wYWlkX2J5X3JlY2VpdmVyEAEaBHRydWU=", "status": "CREATED", "trails": [ { "userId": "11", "externalUserId": "team1@bank.com", "action": "created", "comment": "Ich bin eine flying Roasted Butternut Squash Boodles", "requestStatus": "CREATED" }, { "userId": "1", "externalUserId": "validator-core@taurusgroup.ch", "action": "approvers_assigned", "comment": "rule = [source: any, destination: any, amount: 10.0000], approvals = ['team1': 1 sig, 'team2': 1 sig]", "requestStatus": "CREATED" } ], "rule": "rule = [source: any, destination: any, amount: 10.0000], approvals = ['team1': 1 sig, 'team2': 1 sig]", "approvers": { "parallel": [ { "sequential": [ { "externalGroupID": "team1", "minimumSignatures": 1 }, { "externalGroupID": "team2", "minimumSignatures": 1 } ] } ] } } } ``` **SDK Code** ```python import requests url = "https://your-protect-instance.example.com/api/rest/v1/requests/outgoing" payload = { "amount": "100000", "fromAddressId": "1", "toAddressId": "204", "comment": "Ich bin eine flying Roasted Butternut Squash Boodles", "useUnconfirmedFunds": True, "feePaidByReceiver": True, "fee": "4865" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://your-protect-instance.example.com/api/rest/v1/requests/outgoing'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"amount":"100000","fromAddressId":"1","toAddressId":"204","comment":"Ich bin eine flying Roasted Butternut Squash Boodles","useUnconfirmedFunds":true,"feePaidByReceiver":true,"fee":"4865"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://your-protect-instance.example.com/api/rest/v1/requests/outgoing" payload := strings.NewReader("{\n \"amount\": \"100000\",\n \"fromAddressId\": \"1\",\n \"toAddressId\": \"204\",\n \"comment\": \"Ich bin eine flying Roasted Butternut Squash Boodles\",\n \"useUnconfirmedFunds\": true,\n \"feePaidByReceiver\": true,\n \"fee\": \"4865\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://your-protect-instance.example.com/api/rest/v1/requests/outgoing") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"amount\": \"100000\",\n \"fromAddressId\": \"1\",\n \"toAddressId\": \"204\",\n \"comment\": \"Ich bin eine flying Roasted Butternut Squash Boodles\",\n \"useUnconfirmedFunds\": true,\n \"feePaidByReceiver\": true,\n \"fee\": \"4865\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://your-protect-instance.example.com/api/rest/v1/requests/outgoing") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"amount\": \"100000\",\n \"fromAddressId\": \"1\",\n \"toAddressId\": \"204\",\n \"comment\": \"Ich bin eine flying Roasted Butternut Squash Boodles\",\n \"useUnconfirmedFunds\": true,\n \"feePaidByReceiver\": true,\n \"fee\": \"4865\"\n}") .asString(); ``` ```php request('POST', 'https://your-protect-instance.example.com/api/rest/v1/requests/outgoing', [ 'body' => '{ "amount": "100000", "fromAddressId": "1", "toAddressId": "204", "comment": "Ich bin eine flying Roasted Butternut Squash Boodles", "useUnconfirmedFunds": true, "feePaidByReceiver": true, "fee": "4865" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://your-protect-instance.example.com/api/rest/v1/requests/outgoing"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"amount\": \"100000\",\n \"fromAddressId\": \"1\",\n \"toAddressId\": \"204\",\n \"comment\": \"Ich bin eine flying Roasted Butternut Squash Boodles\",\n \"useUnconfirmedFunds\": true,\n \"feePaidByReceiver\": true,\n \"fee\": \"4865\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "amount": "100000", "fromAddressId": "1", "toAddressId": "204", "comment": "Ich bin eine flying Roasted Butternut Squash Boodles", "useUnconfirmedFunds": true, "feePaidByReceiver": true, "fee": "4865" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://your-protect-instance.example.com/api/rest/v1/requests/outgoing")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```