Volcano API
πŸš€ API Endpoints

πŸ’° Fee Management

Fee configuration and rate management endpoints. 4 endpoints available.

🎯 Quick Stats

πŸ“Š Methods

  • πŸ” GET: 2 endpoints
  • πŸ“ POST: 1 endpoints
  • ✏️ PUT: 1 endpoints

πŸ” Authentication

All endpoints in this section use the same authentication methods. Choose one:

πŸ”‘ Bearer Token (Recommended)

For user session authentication

Add to request headers:

Authorization: Bearer YOUR_TOKEN

πŸ”§ API Key

For server-side authentication

Add to request headers:

X-API-KEY: YOUR_API_KEY

⚠️ Important: Do not use both authentication methods simultaneously in the same request.

πŸ”— Endpoints Overview

MethodEndpointDescription
πŸ” GET/fee/user/{userId}Get user fee rate
πŸ” GET/feeGet fee configurations list
πŸ“ POST/feeCreate fee configuration
✏️ PUT/fee/{feeId}Update fee configuration

πŸ“– Detailed Documentation

Get user fee rate

GET/fee/user/{userId}
Full URL
https://api.market.decenctype.com/fee/user/{userId}

🎯 Path Parameters

  • userId (string) - βœ… Required: User ID

πŸ“‹ Query Parameters

ParameterTypeRequiredDescription
feeTypestring❌Fee type (e.g., exchange, withdrawal) (η€ΊδΎ‹: exchange)
accountTypestring❌Account type

Description: Get user fee rate

Operation ID: getUserFeeRate

Response Status:

  • βœ… 200: User fee rate retrieved successfully

πŸ“‹ Response Examples

response.json
1{
2 "id": "123e4567-e89b-12d3-a456-426614174000",
3 "type": "exchange",
4 "level": 1,
5 "exchangeFee": 0.025,
6 "minFee": 2,
7 "maxFee": 100,
8 "groupId": "123e4567-e89b-12d3-a456-426614174000",
9 "merchantId": "123e4567-e89b-12d3-a456-426614174000",
10 "status": "active",
11 "description": "Standard exchange fee for level 1 users",
12 "userGroup": "example-userGroup",
13 "merchant": "example-merchant"
14}

πŸ“ Example Request

curl -X GET "https://api.market.decenctype.com/fee/user/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Get fee configurations list

GET/fee
Full URL
https://api.market.decenctype.com/fee

πŸ“‹ Query Parameters

ParameterTypeRequiredDescription
merchantIdstring❌Filter by merchant ID
groupIdstring❌Filter by user group ID
typestring❌Filter by fee type
statusstring❌Filter by status
pagenumber❌No description
pageSizenumber❌No description

Description: Get fee configurations list

Operation ID: getFeeConfigurations

Response Status:

  • βœ… 200: Fee configurations retrieved successfully

πŸ“‹ Response Examples

response.json
1{
2 "rows": [
3 {
4 "id": "123e4567-e89b-12d3-a456-426614174000",
5 "type": "exchange",
6 "level": 1,
7 "exchangeFee": 0.025,
8 "minFee": 2,
9 "status": "active",
10 "userGroup": "example-userGroup",
11 "merchant": "example-merchant"
12 }
13 ],
14 "count": 1
15}

πŸ“ Example Request

curl -X GET "https://api.market.decenctype.com/fee" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Create fee configuration

POST/fee
Full URL
https://api.market.decenctype.com/fee

πŸ“ Request Body Parameters

ParameterTypeRequiredDescription
typestring (exchange, withdrawal, deposit, transfer)βœ…θ΄ΉηŽ‡η±»εž‹
levelnumberβŒθ΄ΉηŽ‡η­‰ηΊ§ (ζœ€ε°: 0, ζœ€ε€§: 10)
exchangeFeenumberβœ…δΊ€ζ˜“θ΄ΉηŽ‡ (η™Ύεˆ†ζ―”) (ζœ€ε°: 0, ζœ€ε€§: 100)
minFeenumberβœ…ζœ€ε°θ΄Ήη”¨ (ζœ€ε°: 0)
maxFeenumberβŒζœ€ε€§θ΄Ήη”¨ (ζœ€ε°: 0)
groupIdstringβŒη”¨ζˆ·η»„ID
merchantIdstringβŒε•†ζˆ·ID
statusstring (active, inactive)βŒθ΄ΉηŽ‡ηŠΆζ€
descriptionstringβŒθ΄ΉηŽ‡ζθΏ° (ζœ€ε€§ι•ΏεΊ¦: 500)

Description: Create fee configuration

Operation ID: createFeeConfiguration

Response Status:

  • βœ… 201: Fee configuration created successfully

πŸ“‹ Response Examples

response.json
1{
2 "id": "123e4567-e89b-12d3-a456-426614174000",
3 "type": "exchange",
4 "level": 1,
5 "exchangeFee": 0.025,
6 "minFee": 2,
7 "maxFee": 100,
8 "groupId": "123e4567-e89b-12d3-a456-426614174000",
9 "merchantId": "123e4567-e89b-12d3-a456-426614174000",
10 "status": "active",
11 "description": "Standard exchange fee for level 1 users",
12 "userGroup": "example-userGroup",
13 "merchant": "example-merchant"
14}

πŸ“ Example Request

curl -X POST "https://api.market.decenctype.com/fee" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "type": "exchange",
  "exchangeFee": 0.1,
  "minFee": 1
}'

Update fee configuration

PUT/fee/{feeId}
Full URL
https://api.market.decenctype.com/fee/{feeId}

🎯 Path Parameters

  • feeId (string) - βœ… Required: Fee configuration ID

πŸ“ Request Body Parameters

ParameterTypeRequiredDescription
typestring (exchange, withdrawal, deposit, transfer)βŒθ΄ΉηŽ‡η±»εž‹
levelnumberβŒθ΄ΉηŽ‡η­‰ηΊ§ (ζœ€ε°: 0, ζœ€ε€§: 10)
exchangeFeenumberβŒδΊ€ζ˜“θ΄ΉηŽ‡ (η™Ύεˆ†ζ―”) (ζœ€ε°: 0, ζœ€ε€§: 100)
minFeenumberβŒζœ€ε°θ΄Ήη”¨ (ζœ€ε°: 0)
maxFeenumberβŒζœ€ε€§θ΄Ήη”¨ (ζœ€ε°: 0)
groupIdstringβŒη”¨ζˆ·η»„ID
merchantIdstringβŒε•†ζˆ·ID
statusstring (active, inactive)βŒθ΄ΉηŽ‡ηŠΆζ€
descriptionstringβŒθ΄ΉηŽ‡ζθΏ° (ζœ€ε€§ι•ΏεΊ¦: 500)

Description: Update fee configuration

Operation ID: updateFeeConfiguration

Response Status:

  • βœ… 200: Fee configuration updated successfully

πŸ“‹ Response Examples

response.json
1{
2 "id": "123e4567-e89b-12d3-a456-426614174000",
3 "type": "exchange",
4 "level": 1,
5 "exchangeFee": 0.025,
6 "minFee": 2,
7 "maxFee": 100,
8 "groupId": "123e4567-e89b-12d3-a456-426614174000",
9 "merchantId": "123e4567-e89b-12d3-a456-426614174000",
10 "status": "active",
11 "description": "Standard exchange fee for level 1 users",
12 "userGroup": "example-userGroup",
13 "merchant": "example-merchant"
14}

πŸ“ Example Request

curl -X PUT "https://api.market.decenctype.com/fee/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{}'