Pert API 1.0
Token
POST /api/v1/auth/access-token
Get access token using device authentication
Description
Base URL: https://auth.stage.wallet.paranoid.security
Authenticate a device using signed data and Ed25519 signature verification
The client must sign a JSON payload containing: - client_type: device | user - client_id: Device UUID or API User UUID - timestamp: Unix timestamp (must be within 5 minutes) - nonce: Random string to prevent replay attacks
The signature is verified using the client's public key stored during pairing.
Request body
{
"data": "string",
"signature": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"data": {
"type": "string"
},
"signature": {
"description": "Base64 encoded Ed25519 signature of data",
"type": "string"
}
}
}
Responses
{
"access_token": "string",
"expires_at": "1777300943056"
}
Schema of the response body
{
"type": "object",
"properties": {
"access_token": {
"type": "string"
},
"expires_at": {
"type": "string",
"example": "1777300943056"
}
}
}
{
"code": 0,
"details": [
{
"type_url": "string",
"value": [
0
]
}
],
"message": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AnypbAny"
}
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.",
"type": "string"
}
}
}
{
"code": 0,
"details": [
{
"type_url": "string",
"value": [
0
]
}
],
"message": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AnypbAny"
}
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.",
"type": "string"
}
}
}
{
"code": 0,
"details": [
{
"type_url": "string",
"value": [
0
]
}
],
"message": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AnypbAny"
}
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.",
"type": "string"
}
}
}
{
"code": 0,
"details": [
{
"type_url": "string",
"value": [
0
]
}
],
"message": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AnypbAny"
}
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.",
"type": "string"
}
}
}
POST /api/v2/auth/introspect
Introspect access token
Description
Base URL: https://auth.stage.wallet.paranoid.security
Get detailed information about an access token
Returns token metadata including validity status, expiration times, user information, and associated permissions. Useful for validating tokens and understanding user access rights.
Note: expires_at and issued_at are unix-millisecond timestamps serialized as JSON strings.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
Responses
{
"accesses": [
{
"permissions": [
"string"
],
"role": "ROLE_EDITOR",
"role_status": "ROLE_STATUS_ACTIVE",
"workspace_uuid": "string"
}
],
"active": true,
"audience": [
"string"
],
"email": "string",
"expires_at": "1777300943056",
"issued_at": "1777299043056",
"issuer": "string",
"jti": "string",
"subject": "string",
"subject_type": "string",
"subject_uuid": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"accesses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthAccess"
}
},
"active": {
"type": "boolean"
},
"audience": {
"type": "array",
"items": {
"type": "string"
}
},
"email": {
"type": "string"
},
"expires_at": {
"type": "string",
"example": "1777300943056"
},
"issued_at": {
"type": "string",
"example": "1777299043056"
},
"issuer": {
"type": "string"
},
"jti": {
"type": "string"
},
"subject": {
"type": "string"
},
"subject_type": {
"type": "string"
},
"subject_uuid": {
"type": "string"
}
}
}
{
"code": 0,
"details": [
{
"type_url": "string",
"value": [
0
]
}
],
"message": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AnypbAny"
}
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.",
"type": "string"
}
}
}
{
"code": 0,
"details": [
{
"type_url": "string",
"value": [
0
]
}
],
"message": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AnypbAny"
}
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.",
"type": "string"
}
}
}
Devices
POST /api/v1/auth/devices/pairing/initiate
Initiate device pairing process
Description
Base URL: https://auth.stage.wallet.paranoid.security
Start the device pairing process for a specific workspace
This endpoint creates a pairing token and QR code data that can be used by a mobile device to complete the pairing process. The pairing token expires after a certain period (typically 5 minutes).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
Request body
{
"workspace_uuid": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"workspace_uuid": {
"type": "string"
}
}
}
Responses
{
"expires_at": 0,
"pairing_token": "string",
"qr_data": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"expires_at": {
"type": "integer"
},
"pairing_token": {
"type": "string"
},
"qr_data": {
"type": "string"
}
}
}
{
"code": 0,
"details": [
{
"type_url": "string",
"value": [
0
]
}
],
"message": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AnypbAny"
}
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.",
"type": "string"
}
}
}
{
"code": 0,
"details": [
{
"type_url": "string",
"value": [
0
]
}
],
"message": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AnypbAny"
}
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.",
"type": "string"
}
}
}
{
"code": 0,
"details": [
{
"type_url": "string",
"value": [
0
]
}
],
"message": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AnypbAny"
}
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.",
"type": "string"
}
}
}
POST /api/v2/auth/devices/pairing/initiate
Initiate device pairing process
Description
Base URL: https://auth.stage.wallet.paranoid.security
Start the device pairing process for a specific workspace
This endpoint creates a pairing token and QR code data that can be used by a mobile device to complete the pairing process. The pairing token expires after a certain period (typically 5 minutes).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
Request body
{
"workspace_uuid": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"workspace_uuid": {
"type": "string"
}
}
}
Responses
{
"expires_at": 0,
"pairing_token": "string",
"qr_data": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"expires_at": {
"type": "integer"
},
"pairing_token": {
"type": "string"
},
"qr_data": {
"type": "string"
}
}
}
{
"code": 0,
"details": [
{
"type_url": "string",
"value": [
0
]
}
],
"message": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AnypbAny"
}
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.",
"type": "string"
}
}
}
{
"code": 0,
"details": [
{
"type_url": "string",
"value": [
0
]
}
],
"message": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AnypbAny"
}
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.",
"type": "string"
}
}
}
{
"code": 0,
"details": [
{
"type_url": "string",
"value": [
0
]
}
],
"message": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AnypbAny"
}
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.",
"type": "string"
}
}
}
auth
POST /api/v1/auth/introspect
Introspect access token
Description
Base URL: https://auth.stage.wallet.paranoid.security
Get detailed information about an access token
Returns token metadata including validity status, expiration times, user information, and associated permissions. Useful for validating tokens and understanding user access rights.
Note: expires_at and issued_at are unix-millisecond timestamps serialized as JSON strings.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
Responses
{
"accesses": [
{
"permissions": [
"string"
],
"role": "ROLE_EDITOR",
"role_status": "ROLE_STATUS_ACTIVE",
"workspace_uuid": "string"
}
],
"active": true,
"audience": [
"string"
],
"email": "string",
"expires_at": "1777300943056",
"issued_at": "1777299043056",
"issuer": "string",
"jti": "string",
"subject": "string",
"subject_type": "string",
"subject_uuid": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"accesses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthAccess"
}
},
"active": {
"type": "boolean"
},
"audience": {
"type": "array",
"items": {
"type": "string"
}
},
"email": {
"type": "string"
},
"expires_at": {
"type": "string",
"example": "1777300943056"
},
"issued_at": {
"type": "string",
"example": "1777299043056"
},
"issuer": {
"type": "string"
},
"jti": {
"type": "string"
},
"subject": {
"type": "string"
},
"subject_type": {
"type": "string"
},
"subject_uuid": {
"type": "string"
}
}
}
{
"code": 0,
"details": [
{
"type_url": "string",
"value": [
0
]
}
],
"message": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AnypbAny"
}
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.",
"type": "string"
}
}
}
{
"code": 0,
"details": [
{
"type_url": "string",
"value": [
0
]
}
],
"message": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AnypbAny"
}
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.",
"type": "string"
}
}
}
Other
GET /api/v1/auth/time
Get current server time
Description
Base URL: https://auth.stage.wallet.paranoid.security
Get the current server time in milliseconds since Unix epoch
Responses
{
"unix_milliseconds": "string",
"unix_seconds": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"unix_milliseconds": {
"type": "string"
},
"unix_seconds": {
"type": "string"
}
}
}
wallet
GET /api/v1/asset
List assets
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
limit |
query | integer | No | Limit | |
offset |
query | integer | No | Offset | |
vaultID |
query | string | No | Filter by vault ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"assets": [
{
"balances": {
"available": "string",
"available_atomic": "string",
"frozen": "string",
"frozen_atomic": "string",
"total": "string",
"total_atomic": "string"
},
"converted_balances": null,
"created_at": "string",
"currency": {
"blockchain_icon_url": "string",
"blockchain_name": "string",
"decimals": 0,
"descriptor": "string",
"icon_url": "string",
"id": "string",
"symbol": "string"
},
"decimals": 6,
"id": "string",
"primary_address": null,
"status": "string",
"updated_at": "string",
"vault_id": "string",
"workspace_id": "string"
}
],
"offset": 0,
"total": 0
}
Schema of the response body
{
"type": "object",
"required": [
"assets",
"offset",
"total"
],
"properties": {
"assets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WalletAssetView"
}
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
GET /api/v1/asset/balances
Assets totals amounts
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"converted_balances": {
"available": "string",
"frozen": "string",
"relevant_on": "string",
"symbol": "string",
"total": "string"
},
"symbol_balances": [
{
"available": "string",
"available_atomic": "string",
"decimals": 0,
"frozen": "string",
"frozen_atomic": "string",
"icon_url": "string",
"symbol": "string",
"total": "string",
"total_atomic": "string"
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"symbol_balances"
],
"properties": {
"converted_balances": {
"$ref": "#/components/schemas/WalletConvertedBalancesView"
},
"symbol_balances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BalanceSymbolBalanceView"
}
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
GET /api/v1/currencies
List available currencies in system
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
Responses
[
{
"blockchain_icon_url": "string",
"blockchain_name": "string",
"decimals": 0,
"descriptor": "string",
"icon_url": "string",
"id": "string",
"symbol": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/CurrencyView"
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
POST /api/v1/wallet
Create wallet
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Request body
{
"currency_id": "string",
"vault_id": "string"
}
Schema of the request body
{
"type": "object",
"required": [
"currency_id",
"vault_id"
],
"properties": {
"currency_id": {
"type": "string"
},
"vault_id": {
"type": "string"
}
}
}
Responses
{
"assets": [
{
"balances": {
"available": "string",
"available_atomic": "string",
"frozen": "string",
"frozen_atomic": "string",
"total": "string",
"total_atomic": "string"
},
"converted_balances": null,
"created_at": "string",
"currency": {
"blockchain_icon_url": "string",
"blockchain_name": "string",
"decimals": 0,
"descriptor": "string",
"icon_url": "string",
"id": "string",
"symbol": "string"
},
"decimals": 6,
"id": "string",
"primary_address": null,
"status": "string",
"updated_at": "string",
"vault_id": "string",
"workspace_id": "string"
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"assets"
],
"properties": {
"assets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WalletAssetView"
}
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
gas_station
GET /api/v1/gas_station
Get gas station for the workspace
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Returns the gas station status for the current workspace. If no gas station is configured, responds 200 with {configured: false}.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"configured": true,
"gas_station": {
"assets": [
{
"cap": "string",
"currency_id": "string",
"gas_station_id": "string",
"max_gas_price": "string",
"threshold": "string"
}
],
"id": "string",
"vault_id": "string",
"workspace_id": "string"
}
}
Schema of the response body
{
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"gas_station": {
"$ref": "#/components/schemas/ModelGasStationView"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
PUT /api/v1/gas_station/configuration/currency/{cid}
Update gas station currency configuration
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Partial update; omitted fields are left unchanged.
Поле max_gas_price: - не указано — значение не меняется - "-1" — без ограничения (разрешены любые комиссии) - "0" — комиссия не допускается
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
cid |
path | string | No | Currency ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Request body
{
"cap": "string",
"max_gas_price": "string",
"threshold": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"cap": {
"type": "string"
},
"max_gas_price": {
"type": "string"
},
"threshold": {
"type": "string"
}
}
}
Responses
{
"cap": "string",
"currency_id": "string",
"gas_station_id": "string",
"max_gas_price": "string",
"threshold": "string"
}
Schema of the response body
{
"type": "object",
"required": [
"currency_id",
"gas_station_id"
],
"properties": {
"cap": {
"type": "string"
},
"currency_id": {
"type": "string"
},
"gas_station_id": {
"type": "string"
},
"max_gas_price": {
"type": "string"
},
"threshold": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
POST /api/v1/gas_station/vault/{vid}
Assign vault as gas station
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
vid |
path | string | No | Vault ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
GET /api/v1/gas_station/{cid}
Get gas station currency configuration
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
cid |
path | string | No | Currency ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"cap": "string",
"currency_id": "string",
"gas_station_id": "string",
"max_gas_price": "string",
"threshold": "string"
}
Schema of the response body
{
"type": "object",
"required": [
"currency_id",
"gas_station_id"
],
"properties": {
"cap": {
"type": "string"
},
"currency_id": {
"type": "string"
},
"gas_station_id": {
"type": "string"
},
"max_gas_price": {
"type": "string"
},
"threshold": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
POST /api/v1/vault/accounts/{vid}/autofuel/activate
Activate auto-refuel for a vault account
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
vid |
path | string | No | Vault ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
POST /api/v1/vault/accounts/{vid}/autofuel/deactivate
Deactivate auto-refuel for a vault account
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
vid |
path | string | No | Vault ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
transaction
POST /api/v1/transaction
Create transaction
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
X-Attempt-Key |
header | string | No | Attempt key for explicit retry on equivalent failed BTC transaction | |
X-Idempotency-Key |
header | string | No | Unique request identifier | |
X-Utxo-Intent-Key |
header | string | No | UTXO intent key for a new BTC payment with same values | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Request body
{
"amount": "string",
"fee": "string",
"fee_rate_sat_per_vb": "string",
"source_wallet_id": "string",
"target_address": "string",
"target_wallet_id": "string",
"target_whitelisted_asset_id": "string"
}
Schema of the request body
{
"type": "object",
"required": [
"amount",
"source_wallet_id",
"target_address"
],
"properties": {
"amount": {
"type": "string"
},
"fee": {
"type": "string"
},
"fee_rate_sat_per_vb": {
"type": "string"
},
"source_wallet_id": {
"type": "string"
},
"target_address": {
"type": "string"
},
"target_wallet_id": {
"type": "string"
},
"target_whitelisted_asset_id": {
"type": "string"
}
}
}
Responses
{
"aml_screening": {
"direction": "string",
"id": "string",
"post_screening_action": "string",
"pre_screening_action": "string",
"risk_level": "string",
"risk_score": 10.12,
"status": "string"
},
"amount": "string",
"blockchain_name": "string",
"blockman_tx_id": "string",
"created_at": "string",
"decimals": 0,
"descriptor": "string",
"fee": "string",
"fee_asset_id": "string",
"fee_limit": "string",
"formatted_amount": "string",
"formatted_fee": "string",
"from": {
"address": "string",
"balance": {},
"external": true,
"vault_id": "string",
"vault_name": "string",
"whitelisted_wallet_name": "string",
"workspace_id": "string",
"workspace_name": "string"
},
"id": "string",
"idempotency_key": "string",
"status": "pending",
"symbol": "string",
"to": null,
"tx_hash": "string",
"updated_at": "string"
}
Schema of the response body
{
"type": "object",
"required": [
"amount",
"created_at",
"decimals",
"fee",
"fee_limit",
"formatted_amount",
"formatted_fee",
"from",
"id",
"status",
"symbol",
"to",
"updated_at"
],
"properties": {
"aml_screening": {
"$ref": "#/components/schemas/TransactionAMLScreeningView"
},
"amount": {
"type": "string"
},
"blockchain_name": {
"type": "string"
},
"blockman_tx_id": {
"type": "string"
},
"created_at": {
"type": "string"
},
"decimals": {
"type": "integer"
},
"descriptor": {
"type": "string"
},
"fee": {
"type": "string"
},
"fee_asset_id": {
"type": "string"
},
"fee_limit": {
"type": "string"
},
"formatted_amount": {
"type": "string"
},
"formatted_fee": {
"type": "string"
},
"from": {
"$ref": "#/components/schemas/TransactionWallet"
},
"id": {
"type": "string"
},
"idempotency_key": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/TransactionStatus"
},
"symbol": {
"type": "string"
},
"to": {
"$ref": "#/components/schemas/TransactionWallet"
},
"tx_hash": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
GET /api/v1/transactions
List transactions
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Get a paginated list of transactions with optional filters
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
currency_id |
query | string | No | Filter by currency ID | |
from |
query | string | No | Filter by period start (RFC3339 format, e.g. 2023-01-01T00:00:00Z). Inclusive. Applied to the field selected by order_by. | |
from_address |
query | string | No | Filter by source address | |
from_vault_id |
query | string | No | Filter by source vault ID | |
limit |
query | integer | No | Limit results (default 15, max 100) | |
offset |
query | integer | No | Offset for pagination (default 0) | |
order_by |
query | string | No | Order results by timestamp (default created_at) | |
order_dir |
query | string | No | Sort direction (default desc) | |
status |
query | array | No | Filter by status (repeat param) | |
to |
query | string | No | Filter by period end (RFC3339 format, e.g. 2023-12-31T23:59:59.999Z). Inclusive. For end-of-day filtering, specify time as 23:59:59.999Z. Applied to the field selected by order_by. | |
to_address |
query | string | No | Filter by destination address | |
to_vault_id |
query | string | No | Filter by target vault ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"limit": 0,
"offset": 0,
"total": 0,
"transactions": [
{
"aml_screening": {
"direction": "string",
"id": "string",
"post_screening_action": "string",
"pre_screening_action": "string",
"risk_level": "string",
"risk_score": 10.12,
"status": "string"
},
"amount": "string",
"blockchain_name": "string",
"blockman_tx_id": "string",
"created_at": "string",
"decimals": 0,
"descriptor": "string",
"fee": "string",
"fee_asset_id": "string",
"fee_limit": "string",
"formatted_amount": "string",
"formatted_fee": "string",
"from": {
"address": "string",
"balance": {},
"external": true,
"vault_id": "string",
"vault_name": "string",
"whitelisted_wallet_name": "string",
"workspace_id": "string",
"workspace_name": "string"
},
"id": "string",
"idempotency_key": "string",
"status": "pending",
"symbol": "string",
"to": null,
"tx_hash": "string",
"updated_at": "string"
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"limit",
"offset",
"total",
"transactions"
],
"properties": {
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TransactionView"
}
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
POST /api/v1/transactions/fee
Show transaction fee
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Request body
{
"amount": "string",
"source_wallet_id": "string",
"target_address": "string",
"target_wallet_id": "string",
"target_whitelisted_asset_id": "string"
}
Schema of the request body
{
"type": "object",
"required": [
"amount",
"source_wallet_id"
],
"properties": {
"amount": {
"type": "string"
},
"source_wallet_id": {
"type": "string"
},
"target_address": {
"type": "string"
},
"target_wallet_id": {
"type": "string"
},
"target_whitelisted_asset_id": {
"type": "string"
}
}
}
Responses
{
"effective": {
"base": {
"amount": "string",
"name": "string"
},
"fee_rate_sat_per_vb": "string",
"resource": null,
"tech": null
},
"max": null,
"min": null
}
Schema of the response body
{
"type": "object",
"properties": {
"effective": {
"$ref": "#/components/schemas/TransactionFeeGroupView"
},
"max": {
"$ref": "#/components/schemas/TransactionFeeGroupView"
},
"min": {
"$ref": "#/components/schemas/TransactionFeeGroupView"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
GET /api/v1/transactions/{id}
Get transaction by ID
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Get a single transaction by its ID
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
id |
path | string | No | Transaction ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"aml_screening": {
"direction": "string",
"id": "string",
"post_screening_action": "string",
"pre_screening_action": "string",
"risk_level": "string",
"risk_score": 10.12,
"status": "string"
},
"amount": "string",
"blockchain_name": "string",
"blockman_tx_id": "string",
"created_at": "string",
"decimals": 0,
"descriptor": "string",
"fee": "string",
"fee_asset_id": "string",
"fee_limit": "string",
"formatted_amount": "string",
"formatted_fee": "string",
"from": {
"address": "string",
"balance": {},
"external": true,
"vault_id": "string",
"vault_name": "string",
"whitelisted_wallet_name": "string",
"workspace_id": "string",
"workspace_name": "string"
},
"id": "string",
"idempotency_key": "string",
"status": "pending",
"symbol": "string",
"to": null,
"tx_hash": "string",
"updated_at": "string"
}
Schema of the response body
{
"type": "object",
"required": [
"amount",
"created_at",
"decimals",
"fee",
"fee_limit",
"formatted_amount",
"formatted_fee",
"from",
"id",
"status",
"symbol",
"to",
"updated_at"
],
"properties": {
"aml_screening": {
"$ref": "#/components/schemas/TransactionAMLScreeningView"
},
"amount": {
"type": "string"
},
"blockchain_name": {
"type": "string"
},
"blockman_tx_id": {
"type": "string"
},
"created_at": {
"type": "string"
},
"decimals": {
"type": "integer"
},
"descriptor": {
"type": "string"
},
"fee": {
"type": "string"
},
"fee_asset_id": {
"type": "string"
},
"fee_limit": {
"type": "string"
},
"formatted_amount": {
"type": "string"
},
"formatted_fee": {
"type": "string"
},
"from": {
"$ref": "#/components/schemas/TransactionWallet"
},
"id": {
"type": "string"
},
"idempotency_key": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/TransactionStatus"
},
"symbol": {
"type": "string"
},
"to": {
"$ref": "#/components/schemas/TransactionWallet"
},
"tx_hash": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
POST /api/v1/transactions/{id}/unfreeze
Unfreeze transaction by ID
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
id |
path | string | No | Transaction ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"aml_screening": {
"direction": "string",
"id": "string",
"post_screening_action": "string",
"pre_screening_action": "string",
"risk_level": "string",
"risk_score": 10.12,
"status": "string"
},
"amount": "string",
"blockchain_name": "string",
"blockman_tx_id": "string",
"created_at": "string",
"decimals": 0,
"descriptor": "string",
"fee": "string",
"fee_asset_id": "string",
"fee_limit": "string",
"formatted_amount": "string",
"formatted_fee": "string",
"from": {
"address": "string",
"balance": {},
"external": true,
"vault_id": "string",
"vault_name": "string",
"whitelisted_wallet_name": "string",
"workspace_id": "string",
"workspace_name": "string"
},
"id": "string",
"idempotency_key": "string",
"status": "pending",
"symbol": "string",
"to": null,
"tx_hash": "string",
"updated_at": "string"
}
Schema of the response body
{
"type": "object",
"required": [
"amount",
"created_at",
"decimals",
"fee",
"fee_limit",
"formatted_amount",
"formatted_fee",
"from",
"id",
"status",
"symbol",
"to",
"updated_at"
],
"properties": {
"aml_screening": {
"$ref": "#/components/schemas/TransactionAMLScreeningView"
},
"amount": {
"type": "string"
},
"blockchain_name": {
"type": "string"
},
"blockman_tx_id": {
"type": "string"
},
"created_at": {
"type": "string"
},
"decimals": {
"type": "integer"
},
"descriptor": {
"type": "string"
},
"fee": {
"type": "string"
},
"fee_asset_id": {
"type": "string"
},
"fee_limit": {
"type": "string"
},
"formatted_amount": {
"type": "string"
},
"formatted_fee": {
"type": "string"
},
"from": {
"$ref": "#/components/schemas/TransactionWallet"
},
"id": {
"type": "string"
},
"idempotency_key": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/TransactionStatus"
},
"symbol": {
"type": "string"
},
"to": {
"$ref": "#/components/schemas/TransactionWallet"
},
"tx_hash": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
vault
GET /api/v1/vault
Show workspace vaults
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
active_only |
query | boolean | No | Only active vaults and assets | |
currency_id |
query | string | No | Currency | |
extended |
query | boolean | No | Show extended information | |
limit |
query | integer | No | Limit | |
offset |
query | integer | No | Offset | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"offset": 0,
"total": 0,
"vaults": [
{
"assets": [
{
"balances": {
"available": "string",
"available_atomic": "string",
"frozen": "string",
"frozen_atomic": "string",
"total": "string",
"total_atomic": "string"
},
"converted_balances": null,
"created_at": "string",
"currency": {
"blockchain_icon_url": "string",
"blockchain_name": "string",
"decimals": 0,
"descriptor": "string",
"icon_url": "string",
"id": "string",
"symbol": "string"
},
"decimals": 6,
"id": "string",
"primary_address": null,
"status": "string",
"updated_at": "string",
"vault_id": "string",
"workspace_id": "string"
}
],
"auto_fuel": true,
"converted_balances": {
"available": "string",
"frozen": "string",
"relevant_on": "string",
"symbol": "string",
"total": "string"
},
"created_at": "string",
"id": "string",
"name": "string",
"status": "string",
"updated_at": "string",
"workspace_id": "string"
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"offset",
"total",
"vaults"
],
"properties": {
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"vaults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VaultextView"
}
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
POST /api/v1/vault
Create vault
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Request body
{
"auto_fuel": true,
"name": "string"
}
Schema of the request body
{
"type": "object",
"required": [
"name"
],
"properties": {
"auto_fuel": {
"type": "boolean"
},
"name": {
"type": "string"
}
}
}
Responses
{
"auto_fuel": true,
"converted_balances": {
"available": "string",
"frozen": "string",
"relevant_on": "string",
"symbol": "string",
"total": "string"
},
"created_at": "string",
"id": "string",
"name": "string",
"status": "string",
"updated_at": "string",
"workspace_id": "string"
}
Schema of the response body
{
"type": "object",
"required": [
"created_at",
"id",
"name",
"status",
"updated_at",
"workspace_id"
],
"properties": {
"auto_fuel": {
"type": "boolean"
},
"converted_balances": {
"$ref": "#/components/schemas/VaultConvertedBalancesView"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"workspace_id": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
GET /api/v1/vault/by-name
Get vault by name
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Returns a vault for the current workspace looked up by its unique name. Use the extended flag to also include assets.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
extended |
query | boolean | No | Show extended information | |
name |
query | string | No | Vault name | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"assets": [
{
"balances": {
"available": "string",
"available_atomic": "string",
"frozen": "string",
"frozen_atomic": "string",
"total": "string",
"total_atomic": "string"
},
"converted_balances": null,
"created_at": "string",
"currency": {
"blockchain_icon_url": "string",
"blockchain_name": "string",
"decimals": 0,
"descriptor": "string",
"icon_url": "string",
"id": "string",
"symbol": "string"
},
"decimals": 6,
"id": "string",
"primary_address": null,
"status": "string",
"updated_at": "string",
"vault_id": "string",
"workspace_id": "string"
}
],
"auto_fuel": true,
"converted_balances": {
"available": "string",
"frozen": "string",
"relevant_on": "string",
"symbol": "string",
"total": "string"
},
"created_at": "string",
"id": "string",
"name": "string",
"status": "string",
"updated_at": "string",
"workspace_id": "string"
}
Schema of the response body
{
"type": "object",
"required": [
"created_at",
"id",
"name",
"status",
"updated_at",
"workspace_id"
],
"properties": {
"assets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WalletAssetView"
}
},
"auto_fuel": {
"type": "boolean"
},
"converted_balances": {
"$ref": "#/components/schemas/VaultConvertedBalancesView"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"workspace_id": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
PUT /api/v1/vault/{vid}/rename
Rename vault
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
vid |
path | string | No | Vault ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Request body
{
"name": "string"
}
Schema of the request body
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
}
}
Responses
{
"auto_fuel": true,
"converted_balances": {
"available": "string",
"frozen": "string",
"relevant_on": "string",
"symbol": "string",
"total": "string"
},
"created_at": "string",
"id": "string",
"name": "string",
"status": "string",
"updated_at": "string",
"workspace_id": "string"
}
Schema of the response body
{
"type": "object",
"required": [
"created_at",
"id",
"name",
"status",
"updated_at",
"workspace_id"
],
"properties": {
"auto_fuel": {
"type": "boolean"
},
"converted_balances": {
"$ref": "#/components/schemas/VaultConvertedBalancesView"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"workspace_id": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
PUT /api/v1/vault/{vid}/unfreeze
Unfreeze vault
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
vid |
path | string | No | Vault ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"auto_fuel": true,
"converted_balances": {
"available": "string",
"frozen": "string",
"relevant_on": "string",
"symbol": "string",
"total": "string"
},
"created_at": "string",
"id": "string",
"name": "string",
"status": "string",
"updated_at": "string",
"workspace_id": "string"
}
Schema of the response body
{
"type": "object",
"required": [
"created_at",
"id",
"name",
"status",
"updated_at",
"workspace_id"
],
"properties": {
"auto_fuel": {
"type": "boolean"
},
"converted_balances": {
"$ref": "#/components/schemas/VaultConvertedBalancesView"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"workspace_id": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
whitelisted-wallets
GET /api/v1/whitelisted-wallets
List whitelisted wallets
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
currency_id |
query | string | No | Filter by currency | |
limit |
query | integer | No | Limit | |
offset |
query | integer | No | Offset | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"offset": 0,
"total": 0,
"wallets": [
{
"addresses": [
{
"address": "string",
"asset": {
"created_at": "string",
"decimals": 0,
"descriptor": "string",
"ext_asset_id": "string",
"icon_url": "string",
"id": "string",
"is_base": true,
"status": "string",
"symbol": "string",
"updated_at": "string",
"whitelisted_wallet_id": "string"
},
"asset_id": "string",
"balance": "string",
"converted_balance": {
"formatted_value": "string",
"relevant_on": "string",
"symbol": "string"
},
"created_at": "string",
"id": "string",
"updated_at": "string",
"whitelisted_wallet_id": "string",
"whitelisted_wallet_type": "internal"
}
],
"created_at": "string",
"id": "string",
"name": "string",
"total_balance": null,
"type": null,
"updated_at": "string",
"workspace_id": "string"
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"offset",
"total",
"wallets"
],
"properties": {
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"wallets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressWhitelistedWallet"
}
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
POST /api/v1/whitelisted-wallets
Create whitelisted wallet
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Request body
{
"name": "string",
"type": null
}
Schema of the request body
{
"type": "object",
"required": [
"name",
"type"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"internal",
"external",
"contract"
],
"allOf": [
{
"$ref": "#/components/schemas/AddressWalletType"
}
]
}
}
}
Responses
{
"addresses": [
{
"address": "string",
"asset": {
"created_at": "string",
"decimals": 0,
"descriptor": "string",
"ext_asset_id": "string",
"icon_url": "string",
"id": "string",
"is_base": true,
"status": "string",
"symbol": "string",
"updated_at": "string",
"whitelisted_wallet_id": "string"
},
"asset_id": "string",
"balance": "string",
"converted_balance": {
"formatted_value": "string",
"relevant_on": "string",
"symbol": "string"
},
"created_at": "string",
"id": "string",
"updated_at": "string",
"whitelisted_wallet_id": "string",
"whitelisted_wallet_type": "internal"
}
],
"created_at": "string",
"id": "string",
"name": "string",
"total_balance": null,
"type": null,
"updated_at": "string",
"workspace_id": "string"
}
Schema of the response body
{
"type": "object",
"required": [
"created_at",
"id",
"name",
"type",
"updated_at",
"workspace_id"
],
"properties": {
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressAddress"
}
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"total_balance": {
"$ref": "#/components/schemas/PricesConvertedAmount"
},
"type": {
"$ref": "#/components/schemas/AddressWalletType"
},
"updated_at": {
"type": "string"
},
"workspace_id": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
GET /api/v1/whitelisted-wallets/{wallet_id}
Get whitelisted wallet by ID
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
wallet_id |
path | string | No | Wallet ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"addresses": [
{
"address": "string",
"asset": {
"created_at": "string",
"decimals": 0,
"descriptor": "string",
"ext_asset_id": "string",
"icon_url": "string",
"id": "string",
"is_base": true,
"status": "string",
"symbol": "string",
"updated_at": "string",
"whitelisted_wallet_id": "string"
},
"asset_id": "string",
"balance": "string",
"converted_balance": {
"formatted_value": "string",
"relevant_on": "string",
"symbol": "string"
},
"created_at": "string",
"id": "string",
"updated_at": "string",
"whitelisted_wallet_id": "string",
"whitelisted_wallet_type": "internal"
}
],
"created_at": "string",
"id": "string",
"name": "string",
"total_balance": null,
"type": null,
"updated_at": "string",
"workspace_id": "string"
}
Schema of the response body
{
"type": "object",
"required": [
"created_at",
"id",
"name",
"type",
"updated_at",
"workspace_id"
],
"properties": {
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressAddress"
}
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"total_balance": {
"$ref": "#/components/schemas/PricesConvertedAmount"
},
"type": {
"$ref": "#/components/schemas/AddressWalletType"
},
"updated_at": {
"type": "string"
},
"workspace_id": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
PUT /api/v1/whitelisted-wallets/{wallet_id}
Update whitelisted wallet
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
wallet_id |
path | string | No | Wallet ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Request body
{
"name": "string"
}
Schema of the request body
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
}
}
Responses
{
"addresses": [
{
"address": "string",
"asset": {
"created_at": "string",
"decimals": 0,
"descriptor": "string",
"ext_asset_id": "string",
"icon_url": "string",
"id": "string",
"is_base": true,
"status": "string",
"symbol": "string",
"updated_at": "string",
"whitelisted_wallet_id": "string"
},
"asset_id": "string",
"balance": "string",
"converted_balance": {
"formatted_value": "string",
"relevant_on": "string",
"symbol": "string"
},
"created_at": "string",
"id": "string",
"updated_at": "string",
"whitelisted_wallet_id": "string",
"whitelisted_wallet_type": "internal"
}
],
"created_at": "string",
"id": "string",
"name": "string",
"total_balance": null,
"type": null,
"updated_at": "string",
"workspace_id": "string"
}
Schema of the response body
{
"type": "object",
"required": [
"created_at",
"id",
"name",
"type",
"updated_at",
"workspace_id"
],
"properties": {
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressAddress"
}
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"total_balance": {
"$ref": "#/components/schemas/PricesConvertedAmount"
},
"type": {
"$ref": "#/components/schemas/AddressWalletType"
},
"updated_at": {
"type": "string"
},
"workspace_id": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
DELETE /api/v1/whitelisted-wallets/{wallet_id}
Delete whitelisted wallet
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
wallet_id |
path | string | No | Wallet ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
POST /api/v1/whitelisted-wallets/{wallet_id}/addresses
Add address to whitelisted wallet
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
wallet_id |
path | string | No | Wallet ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Request body
{
"address": "string",
"currency_id": "string"
}
Schema of the request body
{
"type": "object",
"required": [
"address"
],
"properties": {
"address": {
"type": "string"
},
"currency_id": {
"type": "string"
}
}
}
Responses
{
"address": "string",
"asset": {
"created_at": "string",
"decimals": 0,
"descriptor": "string",
"ext_asset_id": "string",
"icon_url": "string",
"id": "string",
"is_base": true,
"status": "string",
"symbol": "string",
"updated_at": "string",
"whitelisted_wallet_id": "string"
},
"asset_id": "string",
"balance": "string",
"converted_balance": {
"formatted_value": "string",
"relevant_on": "string",
"symbol": "string"
},
"created_at": "string",
"id": "string",
"updated_at": "string",
"whitelisted_wallet_id": "string",
"whitelisted_wallet_type": "internal"
}
Schema of the response body
{
"type": "object",
"required": [
"address",
"asset_id",
"created_at",
"id",
"updated_at"
],
"properties": {
"address": {
"type": "string"
},
"asset": {
"$ref": "#/components/schemas/AddressAsset"
},
"asset_id": {
"type": "string"
},
"balance": {
"type": "string"
},
"converted_balance": {
"$ref": "#/components/schemas/PricesConvertedAmount"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"whitelisted_wallet_id": {
"type": "string"
},
"whitelisted_wallet_type": {
"$ref": "#/components/schemas/AddressWalletType"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
DELETE /api/v1/whitelisted-wallets/{wallet_id}/addresses/{address_id}
Delete address from whitelisted wallet
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
address_id |
path | string | No | Address ID | |
wallet_id |
path | string | No | Wallet ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
workspace
GET /api/v1/workspace
Show available workspaces list
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
company_id |
query | string | No | Company ID | |
limit |
query | integer | No | Limit | |
offset |
query | integer | No | Offset | |
search_name |
query | string | No | Search by workspace name | |
status |
query | string | No | Filter by status (new, active, disabled, blocked) |
Responses
{
"offset": 0,
"total": 0,
"workspaces": [
{
"company_id": "string",
"created_at": "string",
"id": "string",
"name": "string",
"status": "new",
"updated_at": "string"
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"offset",
"total",
"workspaces"
],
"properties": {
"offset": {
"type": "integer"
},
"total": {
"type": "integer"
},
"workspaces": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkspaceView"
}
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
GET /api/v1/workspace/{id}
Show workspace info
Description
Base URL: https://wallet.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
id |
path | string | No | Workspace ID |
Responses
{
"company_id": "string",
"created_at": "string",
"id": "string",
"name": "string",
"status": "new",
"updated_at": "string"
}
Schema of the response body
{
"type": "object",
"required": [
"company_id",
"created_at",
"id",
"name",
"status",
"updated_at"
],
"properties": {
"company_id": {
"type": "string"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/WorkspaceStatus"
},
"updated_at": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
webhook
GET /api/v1/webhooks
List webhooks for current workspace
Description
Base URL: https://gateway.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
[
{
"categories": [
"string"
],
"created_at": "string",
"created_by": "string",
"description": "string",
"id": "string",
"status": "string",
"updated_at": "string",
"url": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookWebhookResponse"
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
POST /api/v1/webhooks
Create a webhook
Description
Base URL: https://gateway.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Request body
{
"categories": [
"string"
],
"description": "string",
"status": "active",
"url": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
],
"example": "active"
},
"url": {
"type": "string"
}
}
}
Responses
{
"categories": [
"string"
],
"created_at": "string",
"created_by": "string",
"description": "string",
"id": "string",
"status": "string",
"updated_at": "string",
"url": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string"
},
"created_by": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
GET /api/v1/webhooks/categories
List available webhook categories
Description
Base URL: https://gateway.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
[
{
"name": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookCategoryResponse"
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
GET /api/v1/webhooks/signing-key
Get webhook signing public key
Description
Base URL: https://gateway.stage.wallet.paranoid.security
Returns the base64-encoded public key used to verify webhook signatures
Responses
{
"algorithm": "string",
"public_key": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"algorithm": {
"type": "string"
},
"public_key": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
GET /api/v1/webhooks/{id}
Get a webhook by ID
Description
Base URL: https://gateway.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
id |
path | string | No | Webhook ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"categories": [
"string"
],
"created_at": "string",
"created_by": "string",
"description": "string",
"id": "string",
"status": "string",
"updated_at": "string",
"url": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string"
},
"created_by": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
PUT /api/v1/webhooks/{id}
Update a webhook
Description
Base URL: https://gateway.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
id |
path | string | No | Webhook ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Request body
{
"categories": [
"string"
],
"description": "string",
"status": "active",
"url": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
],
"example": "active"
},
"url": {
"type": "string"
}
}
}
Responses
{
"categories": [
"string"
],
"created_at": "string",
"created_by": "string",
"description": "string",
"id": "string",
"status": "string",
"updated_at": "string",
"url": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string"
},
"created_by": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
DELETE /api/v1/webhooks/{id}
Delete a webhook
Description
Base URL: https://gateway.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
id |
path | string | No | Webhook ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
GET /api/v1/webhooks/{id}/deliveries
List webhook delivery attempts
Description
Base URL: https://gateway.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
id |
path | string | No | Webhook ID | |
limit |
query | integer | No | Limit (max 100, default 50) | |
offset |
query | integer | No | Offset (default 0) | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"items": [
{
"attempt_number": 0,
"category": "string",
"completed_at": "string",
"created_at": "string",
"error_message": "string",
"event_id": "string",
"event_type": "string",
"id": "string",
"response_status_code": 0,
"status": "string"
}
],
"limit": 0,
"offset": 0,
"total_count": 0
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookDeliveryLogResponse"
}
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"total_count": {
"type": "integer"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
POST /api/v1/webhooks/{id}/replay
Replay failed webhook deliveries
Description
Base URL: https://gateway.stage.wallet.paranoid.security
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
BearerAuth |
header | string | N/A | No | API key |
id |
path | string | No | Webhook ID | |
X-Workspace-Id |
header | string | No | Preferred workspace context |
Responses
{
"replayed_count": 0
}
Schema of the response body
{
"type": "object",
"properties": {
"replayed_count": {
"type": "integer"
}
}
}
{
"code": "WEBHOOK_NOT_FOUND",
"details": {},
"error": "webhook not found"
}
Schema of the response body
{
"type": "object",
"properties": {
"code": {
"description": "Машиночитаемый код ошибки. Стабилен между релизами;\nиспользуйте его для условной обработки в клиенте.\nПолный список см. /integration/errors.",
"type": "string",
"example": "WEBHOOK_NOT_FOUND"
},
"details": {
"description": "Опциональные структурированные детали об ошибке: имя поля\nи причина для валидационных ошибок и т. п.",
"type": "object",
"additionalProperties": {}
},
"error": {
"description": "Человекочитаемое сообщение ошибки.",
"type": "string",
"example": "webhook not found"
}
}
}
Schemas
AddressAddress
| Name | Type | Description |
|---|---|---|
address |
string | |
asset |
AddressAsset | |
asset_id |
string | |
balance |
string | |
converted_balance |
PricesConvertedAmount | |
created_at |
string | |
id |
string | |
updated_at |
string | |
whitelisted_wallet_id |
string | |
whitelisted_wallet_type |
AddressWalletType |
AddressAsset
| Name | Type | Description |
|---|---|---|
created_at |
string | |
decimals |
integer | |
descriptor |
string | |
ext_asset_id |
string | |
icon_url |
string | |
id |
string | |
is_base |
boolean | |
status |
string | |
symbol |
string | |
updated_at |
string | |
whitelisted_wallet_id |
string |
AddressCreateWhitelistedAddressRequest
| Name | Type | Description |
|---|---|---|
address |
string | |
currency_id |
string |
AddressCreateWhitelistedWalletRequest
| Name | Type | Description |
|---|---|---|
name |
string | |
type |
AddressListWalletsResponse
| Name | Type | Description |
|---|---|---|
offset |
integer | |
total |
integer | |
wallets |
Array<AddressWhitelistedWallet> |
AddressUpdateWhitelistedWalletRequest
| Name | Type | Description |
|---|---|---|
name |
string |
AddressWalletType
Type: string
AddressWhitelistedWallet
| Name | Type | Description |
|---|---|---|
addresses |
Array<AddressAddress> | |
created_at |
string | |
id |
string | |
name |
string | |
total_balance |
PricesConvertedAmount | |
type |
AddressWalletType | |
updated_at |
string | |
workspace_id |
string |
AnypbAny
| Name | Type | Description |
|---|---|---|
type_url |
string | A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: - If no scheme is provided, `https` is assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. - Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. |
value |
Array<integer> | Must be a valid serialized protocol buffer of the above specified type. |
AuthAccess
| Name | Type | Description |
|---|---|---|
permissions |
Array<string> | |
role |
string | |
role_status |
string | |
workspace_uuid |
string |
AuthGetAccessTokenResponse
| Name | Type | Description |
|---|---|---|
access_token |
string | |
expires_at |
string |
AuthGetServerTimeResponse
| Name | Type | Description |
|---|---|---|
unix_milliseconds |
string | |
unix_seconds |
string |
AuthIntrospectTokenResponse
| Name | Type | Description |
|---|---|---|
accesses |
Array<AuthAccess> | |
active |
boolean | |
audience |
Array<string> | |
email |
string | |
expires_at |
string | |
issued_at |
string | |
issuer |
string | |
jti |
string | |
subject |
string | |
subject_type |
string | |
subject_uuid |
string |
BalanceSymbolBalanceView
| Name | Type | Description |
|---|---|---|
available |
string | |
available_atomic |
string | |
decimals |
integer | |
frozen |
string | |
frozen_atomic |
string | |
icon_url |
string | |
symbol |
string | |
total |
string | |
total_atomic |
string |
CurrencyView
| Name | Type | Description |
|---|---|---|
blockchain_icon_url |
string | |
blockchain_name |
string | |
decimals |
integer | |
descriptor |
string | |
icon_url |
string | |
id |
string | |
symbol |
string |
HttpWebError
| Name | Type | Description |
|---|---|---|
code |
string | Машиночитаемый код ошибки. Стабилен между релизами; используйте его для условной обработки в клиенте. Полный список см. /integration/errors. |
details |
Опциональные структурированные детали об ошибке: имя поля и причина для валидационных ошибок и т. п. | |
error |
string | Человекочитаемое сообщение ошибки. |
ModelGasStationAssetConfigView
| Name | Type | Description |
|---|---|---|
cap |
string | |
currency_id |
string | |
gas_station_id |
string | |
max_gas_price |
string | |
threshold |
string |
ModelGasStationStatusView
| Name | Type | Description |
|---|---|---|
configured |
boolean | |
gas_station |
ModelGasStationView |
ModelGasStationView
| Name | Type | Description |
|---|---|---|
assets |
Array<ModelGasStationAssetConfigView> | |
id |
string | |
vault_id |
string | |
workspace_id |
string |
ModelUpdateConfigBody
| Name | Type | Description |
|---|---|---|
cap |
string | |
max_gas_price |
string | |
threshold |
string |
PricesConvertedAmount
| Name | Type | Description |
|---|---|---|
formatted_value |
string | |
relevant_on |
string | |
symbol |
string |
StatusStatus
| Name | Type | Description |
|---|---|---|
code |
integer | The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. |
details |
Array<AnypbAny> | A list of messages that carry the error details. There is a common set of message types for APIs to use. |
message |
string | A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. |
TransactionAMLScreeningView
| Name | Type | Description |
|---|---|---|
direction |
string | |
id |
string | |
post_screening_action |
string | |
pre_screening_action |
string | |
risk_level |
string | |
risk_score |
number | |
status |
string |
TransactionCreateRequest
| Name | Type | Description |
|---|---|---|
amount |
string | |
fee |
string | |
fee_rate_sat_per_vb |
string | |
source_wallet_id |
string | |
target_address |
string | |
target_wallet_id |
string | |
target_whitelisted_asset_id |
string |
TransactionFeeGroupView
| Name | Type | Description |
|---|---|---|
base |
TransactionFeeValueView | |
fee_rate_sat_per_vb |
string | |
resource |
TransactionFeeValueView | |
tech |
TransactionFeeValueView |
TransactionFeeRequest
| Name | Type | Description |
|---|---|---|
amount |
string | |
source_wallet_id |
string | |
target_address |
string | |
target_wallet_id |
string | |
target_whitelisted_asset_id |
string |
TransactionFeeValueView
| Name | Type | Description |
|---|---|---|
amount |
string | |
name |
string |
TransactionFeeView
| Name | Type | Description |
|---|---|---|
effective |
TransactionFeeGroupView | |
max |
TransactionFeeGroupView | |
min |
TransactionFeeGroupView |
TransactionListView
| Name | Type | Description |
|---|---|---|
limit |
integer | |
offset |
integer | |
total |
integer | |
transactions |
Array<TransactionView> |
TransactionStatus
Type: string
TransactionView
| Name | Type | Description |
|---|---|---|
aml_screening |
TransactionAMLScreeningView | |
amount |
string | |
blockchain_name |
string | |
blockman_tx_id |
string | |
created_at |
string | |
decimals |
integer | |
descriptor |
string | |
fee |
string | |
fee_asset_id |
string | |
fee_limit |
string | |
formatted_amount |
string | |
formatted_fee |
string | |
from |
TransactionWallet | |
id |
string | |
idempotency_key |
string | |
status |
TransactionStatus | |
symbol |
string | |
to |
TransactionWallet | |
tx_hash |
string | |
updated_at |
string |
TransactionWallet
| Name | Type | Description |
|---|---|---|
address |
string | |
balance |
TypeBigInt | |
external |
boolean | |
vault_id |
string | |
vault_name |
string | |
whitelisted_wallet_name |
string | |
workspace_id |
string | |
workspace_name |
string |
TypeBigInt
V1GetAccessTokenRequest
| Name | Type | Description |
|---|---|---|
data |
string | |
signature |
string | Base64 encoded Ed25519 signature of data |
V1InitiateDevicePairingRequest
| Name | Type | Description |
|---|---|---|
workspace_uuid |
string |
V1InitiateDevicePairingResponse
| Name | Type | Description |
|---|---|---|
expires_at |
integer | |
pairing_token |
string | |
qr_data |
string |
VaultConvertedBalancesView
| Name | Type | Description |
|---|---|---|
available |
string | |
frozen |
string | |
relevant_on |
string | |
symbol |
string | |
total |
string |
VaultCreateRequest
| Name | Type | Description |
|---|---|---|
auto_fuel |
boolean | |
name |
string |
VaultextListExtResponse
| Name | Type | Description |
|---|---|---|
offset |
integer | |
total |
integer | |
vaults |
Array<VaultextView> |
VaultextView
| Name | Type | Description |
|---|---|---|
assets |
Array<WalletAssetView> | |
auto_fuel |
boolean | |
converted_balances |
VaultConvertedBalancesView | |
created_at |
string | |
id |
string | |
name |
string | |
status |
string | |
updated_at |
string | |
workspace_id |
string |
VaultRenameRequest
| Name | Type | Description |
|---|---|---|
name |
string |
VaultView
| Name | Type | Description |
|---|---|---|
auto_fuel |
boolean | |
converted_balances |
VaultConvertedBalancesView | |
created_at |
string | |
id |
string | |
name |
string | |
status |
string | |
updated_at |
string | |
workspace_id |
string |
WalletAddressView
| Name | Type | Description |
|---|---|---|
address |
string | |
created_at |
string |
WalletAssetView
| Name | Type | Description |
|---|---|---|
balances |
WalletBalancesView | |
converted_balances |
||
created_at |
string | |
currency |
CurrencyView | |
decimals |
integer(int32) | |
id |
string | |
primary_address |
||
status |
string | |
updated_at |
string | |
vault_id |
string | |
workspace_id |
string |
WalletBalancesView
| Name | Type | Description |
|---|---|---|
available |
string | |
available_atomic |
string | |
frozen |
string | |
frozen_atomic |
string | |
total |
string | |
total_atomic |
string |
WalletConvertedBalancesView
| Name | Type | Description |
|---|---|---|
available |
string | |
frozen |
string | |
relevant_on |
string | |
symbol |
string | |
total |
string |
WalletCreateRequest
| Name | Type | Description |
|---|---|---|
currency_id |
string | |
vault_id |
string |
WalletCreateResponse
| Name | Type | Description |
|---|---|---|
assets |
Array<WalletAssetView> |
WalletListResponse
| Name | Type | Description |
|---|---|---|
assets |
Array<WalletAssetView> | |
offset |
integer | |
total |
integer |
WalletWorkspaceBalancesView
| Name | Type | Description |
|---|---|---|
converted_balances |
WalletConvertedBalancesView | |
symbol_balances |
Array<BalanceSymbolBalanceView> |
WebhookCategoryResponse
| Name | Type | Description |
|---|---|---|
name |
string |
WebhookCreateWebhookRequest
| Name | Type | Description |
|---|---|---|
categories |
Array<string> | |
description |
string | |
status |
string | |
url |
string |
WebhookDeliveryLogResponse
| Name | Type | Description |
|---|---|---|
attempt_number |
integer | |
category |
string | |
completed_at |
string | |
created_at |
string | |
error_message |
string | |
event_id |
string | |
event_type |
string | |
id |
string | |
response_status_code |
integer | |
status |
string |
WebhookPaginatedResponse-realtime-gateway_internal_feature_webhook_DeliveryLogResponse
| Name | Type | Description |
|---|---|---|
items |
Array<WebhookDeliveryLogResponse> | |
limit |
integer | |
offset |
integer | |
total_count |
integer |
WebhookReplayResponse
| Name | Type | Description |
|---|---|---|
replayed_count |
integer |
WebhookSigningKeyResponse
| Name | Type | Description |
|---|---|---|
algorithm |
string | |
public_key |
string |
WebhookUpdateWebhookRequest
| Name | Type | Description |
|---|---|---|
categories |
Array<string> | |
description |
string | |
status |
string | |
url |
string |
WebhookWebhookResponse
| Name | Type | Description |
|---|---|---|
categories |
Array<string> | |
created_at |
string | |
created_by |
string | |
description |
string | |
id |
string | |
status |
string | |
updated_at |
string | |
url |
string |
WorkspaceListResponse
| Name | Type | Description |
|---|---|---|
offset |
integer | |
total |
integer | |
workspaces |
Array<WorkspaceView> |
WorkspaceStatus
Type: string
WorkspaceView
| Name | Type | Description |
|---|---|---|
company_id |
string | |
created_at |
string | |
id |
string | |
name |
string | |
status |
WorkspaceStatus | |
updated_at |
string |
Security schemes
| Name | Type | Scheme | Description |
|---|---|---|---|
| BearerAuth | apiKey |