Skip to main content

Get Wallet Rule

GET /v1/wallets/{wallet_id}/rules/{id}

Retrieves detailed information about a wallet rule, including its sub-rule configurations.

Headers

HeaderRequiredValue
AuthorizationYesBearer <token>
X-Target-ServerYeswallet-rules

Path Parameters

ParameterTypeRequiredDescription
wallet_idstring (UUID)YesWallet ID
idstring (UUID)YesWallet rule ID

Response

200 OK

The response includes the base rule plus the applicable sub-rule detail. Only the relevant sub-rule fields are populated based on the rule type.

Auto-Transfer Rule Detail:

{
"id": "aab8400-e29b-41d4-a716-446655440000",
"created_by_user_id": "110e8400-e29b-41d4-a716-446655440000",
"wallet_id": "990e8400-e29b-41d4-a716-446655440000",
"name": "Low Balance Auto-Refill",
"type": "auto_transfer",
"network_id": "770e8400-e29b-41d4-a716-446655440000",
"network_currency_id": "880e8400-e29b-41d4-a716-446655440000",
"priority": 1,
"auto_transfer_type": "auto_with_approve",
"auto_transfer_id": "ddb8400-e29b-41d4-a716-446655440000",
"auto_transfer_target_wallet_id": "990e8400-e29b-41d4-a716-446655440001",
"sign_and_approve_rule_id": "eeb8400-e29b-41d4-a716-446655440000",
"permissionless_transfer_limit_id": null,
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-01-01T00:00:00Z",
"deleted_at": null,
"target_wallet_account_id": "660e8400-e29b-41d4-a716-446655440001",
"auto_transfer": {
"id": "ddb8400-e29b-41d4-a716-446655440000",
"rule_logic": {
"field": "target.balance",
"op": "<",
"value": 100,
"network_currency_id": "880e8400-e29b-41d4-a716-446655440000"
},
"amount": 500.0,
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-01-01T00:00:00Z",
"deleted_at": null
},
"sign_and_approve_rule": {
"id": "eeb8400-e29b-41d4-a716-446655440000",
"mandatory_user_id": null,
"min_priority": 1,
"max_priority": 50,
"min_user_count": 2,
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-01-01T00:00:00Z",
"deleted_at": null
},
"permissionless_transfer_limit": null
}

Permissionless Transfer Limit Detail:

{
"id": "aab8400-e29b-41d4-a716-446655440001",
"wallet_id": "990e8400-e29b-41d4-a716-446655440000",
"name": "Daily Transfer Limit",
"type": "permissionless_transfer_limit",
"auto_transfer": null,
"sign_and_approve_rule": null,
"permissionless_transfer_limit": {
"id": "ccb8400-e29b-41d4-a716-446655440000",
"wallet_id": "990e8400-e29b-41d4-a716-446655440000",
"max_amount": 10000,
"time_period": "day",
"time_period_value": 1,
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-01-01T00:00:00Z",
"deleted_at": null
}
}

401 Unauthorized

404 Not Found

Wallet rule not found.

500 Internal Server Error