Api/KeyManagementSystemApi
Key Management System API Reference
// Set your API Keys 👇 here
$sdk = new \Tatum\Sdk();
// MainNet API Call
$sdk->mainnet()->api()->keyManagementSystem();
// TestNet API Call
$sdk->testnet()->api()->keyManagementSystem();
Methods
| Method | Description |
|---|---|
| completePendingSignature() | Complete pending transaction to sign |
| deletePendingTransactionToSign() | Delete transaction |
| getPendingTransactionToSign() | Get transaction details |
| getPendingTransactionsToSign() | Get pending transactions to sign |
| receivePendingTransactionsToSign() | Get pending transactions to sign |
completePendingSignature()
Example
#️⃣ Execute command in terminal
Request
PUT
/v3/kms/{id}/{txId}
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->keyManagementSystem()->completePendingSignature(
string $id,
string $tx_id
)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $id | string | ID of pending transaction | |
| $tx_id | string | transaction ID of blockchain transaction |
Return type
void (empty response body)
Description
Complete pending transaction to sign
2 credits per API call.
Mark pending transaction to sign as a complete and update it with a transactionID from the blockchain.
deletePendingTransactionToSign()
Example
#️⃣ Execute command in terminal
Request
DELETE
/v3/kms/{id}
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->keyManagementSystem()->deletePendingTransactionToSign(
string $id,
[ bool $revert = true ]
)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $id | string | ID of transaction | |
| $revert | bool | Defines whether fee should be reverted to account balance as well as amount. Defaults to true. Revert true would be typically used when withdrawal was not broadcast to blockchain. False is used usually for Ethereum ERC20 based currencies. | [optional] [default to true] |
Return type
void (empty response body)
Description
Delete transaction
2 credits per API call.
Delete transaction to be signed. When deleting offchain transaction, linked withdrawal will be cancelled automatically.
getPendingTransactionToSign()
Example
#️⃣ Execute command in terminal
Request
GET
/v3/kms/{id}
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->keyManagementSystem()->getPendingTransactionToSign(
string $id
): \Tatum\Model\PendingTransaction
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $id | string | ID of transaction |
Return type
\Tatum\Model\PendingTransaction
Description
Get transaction details
1 credit per API call.
Get detail of transaction to be signed / that was already signed and contains transactionId.
getPendingTransactionsToSign()
Example
#️⃣ Execute command in terminal
Request
GET
/v3/kms/pending/{chain}
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->keyManagementSystem()->getPendingTransactionsToSign(
string $chain,
[ string $signatures ]
): \Tatum\Model\PendingTransaction[]
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $chain | string | Blockchain to get pending transactions for. | |
| $signatures | string | Signature IDs of the KMS which invokes this endpoint. If multiple, they should be separated by comma. | [optional] |
Return type
\Tatum\Model\PendingTransaction[]
Description
Get pending transactions to sign
1 credit per API call
Get the list of pending transactions to sign and broadcast using KMS.
receivePendingTransactionsToSign()
Example
#️⃣ Execute command in terminal
Request
POST
/v3/kms/pending/{chain}
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->keyManagementSystem()->receivePendingTransactionsToSign(
string $chain,
[ \Tatum\Model\KmsSignatureIds $kms_signature_ids ]
): \Tatum\Model\PendingTransaction[]
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| $chain | string | Blockchain to get pending transactions for. | |
| $kms_signature_ids | \Tatum\Model\KmsSignatureIds | Signature IDs of the KMS which invokes this endpoint. | [optional] |
Return type
\Tatum\Model\PendingTransaction[]
Description
Get pending transactions to sign
1 credit for every 500 signature IDs per API call
Get the list of pending transactions to sign and broadcast using KMS.
NOTE: This API works only in KMS v5.0 or later. If you use KMS older than v5.0, use this API instead.