Getting Transaction Request Info
Basic Description
This endpoint is used to get information on a specific 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 GET request with one path parameter for the relevant requestId.
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:
- 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:
- requestId: The ID of the requested Address.
Preconditions
It is important to note that the selected Transaction needs to be already created in Taurus-PROTECT. If the given
requestIddoes not exist, the API request will result in an error.
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.
export BASEURL=https://taurus-protect-instance.com
export APIToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZXh0ZXJuYWxVc2VySUQiOiJ0ZWFtMUV4dGVybmFsVXNlcklEIiwidGVuYW50SUQiOjEsImNhcGl0YWxUZW5hbnRJRCI6MSwiZmlyc3RuYW1lIjoiSm9obiIsImxhc3RuYW1lIjoiRG9lIiwicm9sZXMiOlsidHB1c2VyIl0sImVtYWlsIjoidGVhbTFAYmFuay5jb20iLCJ1c2VybmFtZSI6InRlYW0xIiwiand0X3JlbmV3YWJsZV9hbW91bnQiOjAsImlzX3RvdHBfZW5hYmxlZCI6ZmFsc2UsImF1dGhfc3RhdHVzIjoiU1VDQ0VTUyIsImxhc3RfbG9naW4iOiIyMDIzLTAxLTAxVDAwOjAwOjAwLjE0OTc0NDIzMloiLCJsb2dnZWRfaW5fd2l0aF9zc28iOmZhbHNlLCJrZXkiOiIiLCJleHAiOjE2ODEyMTkyNzYsImlhdCI6MTY4MTIxNzQ3Nn0.K_85arIrigpkN1yHttCydpeT6oVg2c6PyQnuji907Og
curl --location "$BASEURL/api/rest/v1/requests/4132225" \
--header 'Accept: application/json' \
--header "Authorization: Bearer $APIToken"
This piece of code submits a GET request to https://your-protect-instance.example.com/api/rest/v1/requests with the relevant Requestid as a path parameter.
Call Result
A successful response for the GET call to get the relevant info for a 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",
"date": "2023-04-03T22:11:48.145742Z",
"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]",
"date": "2023-04-03T22:11:48.188025Z",
"requestStatus": "CREATED"
}
],
"creationDate": "2023-04-03T22:11:46.896502Z",
"updateDate": "2023-04-03T22:11:48.231832Z",
"metadata": {
"hash": "a7798a9f686526c74decb5625fc248e88481b4c2f2e44a168ba431e32d84b174",
"payload": [
{
"column": "",
"key": "request_id",
"type": "String",
"value": "4132225"
},
{
"column": "",
"key": "rules_key",
"type": "String",
"value": "Kichain/Taurus/cosmos.bank.v1beta1.MsgSend(from_address#1:string,to_address#2:string,amount#3:coin)"
},
{
"column": "",
"key": "currency",
"type": "String",
"value": "XKI"
},
{
"column": "",
"key": "fee_paid_by_receiver",
"type": "String",
"value": "false"
},
{
"column": "",
"key": "chain_id",
"type": "String",
"value": "kichain-2"
},
{
"column": "",
"key": "message",
"type": "String",
"value": "cosmos.bank.v1beta1.MsgSend(from_address#1:string,to_address#2:string,amount#3:coin)"
},
{
"column": "",
"key": "signer",
"type": "Source",
"value": {
"payload": {
"address": "ki13zaep06q494zwfjynzwl7pd98cpl6vjx34uca2",
"id": "458136",
"label": "Addr_3",
"path": "m/44'/118'/0'/0'/2'"
},
"type": "SourceInternalAddress"
}
},
{
"column": "source",
"key": "message.from_address",
"type": "Source",
"value": {
"payload": {
"address": "ki13zaep06q494zwfjynzwl7pd98cpl6vjx34uca2",
"id": "458136",
"label": "Addr_3",
"path": "m/44'/118'/0'/0'/2'"
},
"type": "SourceInternalAddress"
}
},
{
"column": "destination",
"key": "message.to_address",
"type": "Destination",
"value": {
"payload": {
"address": "ki1z7vr8lc5eds3l8u5p92ppz9038uyny4d5lvv30",
"id": "458128",
"label": "Test_Duplicate_1",
"path": "m/44'/118'/8'/0'/0'"
},
"type": "DestinationInternalAddress"
}
},
{
"column": "amount",
"key": "message.amount",
"type": "Amount",
"value": {
"currencyFrom": "XKI",
"currencyTo": "CHF",
"decimals": "6",
"rate": "0.093891126",
"valueFrom": "5",
"valueTo": "0.0000"
}
},
{
"column": "",
"key": "total_fiat_amount",
"type": "String",
"value": "0.0000"
},
{
"column": "",
"key": "gas_limit",
"type": "BigInt",
"value": "86686"
},
{
"column": "",
"key": "fee_denom",
"type": "String",
"value": "uxki"
},
{
"column": "",
"key": "fee_limit",
"type": "BigInt",
"value": "6504"
},
{
"column": "",
"key": "use_unconfirmed_funds",
"type": "String",
"value": "true"
},
{
"column": "",
"key": "is_cancel_request",
"type": "String",
"value": "false"
},
{
"column": "",
"key": "transaction_ids",
"type": "StringArray",
"value": [
"458136:1b1a548b-1762-4718-8928-9856f0e9dded"
]
}
],
"payloadAsString": "[{\"key\":\"request_id\",\"type\":\"String\",\"value\":\"4132225\",\"column\":\"\"},{\"key\":\"rules_key\",\"type\":\"String\",\"value\":\"Kichain/Taurus/cosmos.bank.v1beta1.MsgSend(from_address#1:string,to_address#2:string,amount#3:coin)\",\"column\":\"\"},{\"key\":\"currency\",\"type\":\"String\",\"value\":\"XKI\",\"column\":\"\"},{\"key\":\"fee_paid_by_receiver\",\"type\":\"String\",\"value\":\"false\",\"column\":\"\"},{\"key\":\"chain_id\",\"type\":\"String\",\"value\":\"kichain-2\",\"column\":\"\"},{\"key\":\"message\",\"type\":\"String\",\"value\":\"cosmos.bank.v1beta1.MsgSend(from_address#1:string,to_address#2:string,amount#3:coin)\",\"column\":\"\"},{\"key\":\"signer\",\"type\":\"Source\",\"value\":{\"type\":\"SourceInternalAddress\",\"payload\":{\"id\":\"458136\",\"address\":\"ki13zaep06q494zwfjynzwl7pd98cpl6vjx34uca2\",\"label\":\"Addr_3\",\"path\":\"m/44'/118'/0'/0'/2'\"}},\"column\":\"\"},{\"key\":\"message.from_address\",\"type\":\"Source\",\"value\":{\"type\":\"SourceInternalAddress\",\"payload\":{\"id\":\"458136\",\"address\":\"ki13zaep06q494zwfjynzwl7pd98cpl6vjx34uca2\",\"label\":\"Addr_3\",\"path\":\"m/44'/118'/0'/0'/2'\"}},\"column\":\"source\"},{\"key\":\"message.to_address\",\"type\":\"Destination\",\"value\":{\"type\":\"DestinationInternalAddress\",\"payload\":{\"id\":\"458128\",\"address\":\"ki1z7vr8lc5eds3l8u5p92ppz9038uyny4d5lvv30\",\"label\":\"Test_Duplicate_1\",\"path\":\"m/44'/118'/8'/0'/0'\"}},\"column\":\"destination\"},{\"key\":\"message.amount\",\"type\":\"Amount\",\"value\":{\"valueFrom\":\"5\",\"valueTo\":\"0.0000\",\"rate\":\"0.093891126\",\"decimals\":\"6\",\"currencyFrom\":\"XKI\",\"currencyTo\":\"CHF\"},\"column\":\"amount\"},{\"key\":\"total_fiat_amount\",\"type\":\"String\",\"value\":\"0.0000\",\"column\":\"\"},{\"key\":\"gas_limit\",\"type\":\"BigInt\",\"value\":\"86686\",\"column\":\"\"},{\"key\":\"fee_denom\",\"type\":\"String\",\"value\":\"uxki\",\"column\":\"\"},{\"key\":\"fee_limit\",\"type\":\"BigInt\",\"value\":\"6504\",\"column\":\"\"},{\"key\":\"use_unconfirmed_funds\",\"type\":\"String\",\"value\":\"true\",\"column\":\"\"},{\"key\":\"is_cancel_request\",\"type\":\"String\",\"value\":\"false\",\"column\":\"\"},{\"key\":\"transaction_ids\",\"type\":\"StringArray\",\"value\":[\"458136:1b1a548b-1762-4718-8928-9856f0e9dded\"],\"column\":\"\"}]"
},
"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"
},
"needsApprovalFrom": [
"team1",
"team2"
]
}
}
In this example, Taurus-PROTECT responds with a JSON object containing the transaction request details for the given Requestid.
Requirements for Future Use
For this endpoint, the storing requirements vary according to the use case.
You can find the Swagger-generated page for this endpoint in the following link.
Updated 22 days ago