📦 Order Management

Order creation, query, and status management endpoints. 21 endpoints available.

🎯 Quick Stats

Total Endpoints: 21
Base URL: https://api.market.decenctype.com
Authentication: Bearer Token / API Key

📊 Methods

📝 POST: 8 endpoints
🔍 GET: 11 endpoints
🗑️ DELETE: 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

Method	Endpoint	Description
📝 `POST`	`/order/card/create`	Create card order
📝 `POST`	`/order/card/bulk-create`	Create bulk card order
🔍 `GET`	`/order/card/{orderId}`	Get card order by id
🔍 `GET`	`/order/card`	Get card order list
📝 `POST`	`/order/card/{orderId}/pay`	Pay Card order
🗑️ `DELETE`	`/order/card/{orderId}/cancel`	Cancel card order
📝 `POST`	`/order/transfer`	Create transfer order
🔍 `GET`	`/order/transfer/list`	Get transfer order list
🔍 `GET`	`/order/transfer/user-stats`	Get transfer user statistics
🔍 `GET`	`/order/transfer/{orderId}`	Get transfer order by id
📝 `POST`	`/order/exchange`	Create exchange order
🔍 `GET`	`/order/exchange/list`	Get exchange order list
🔍 `GET`	`/order/exchange/{orderId}`	Get exchange order by id
📝 `POST`	`/order/deposit`	Create deposit order
🔍 `GET`	`/order/deposit/list`	Get deposit order list
🔍 `GET`	`/order/deposit/{orderId}`	Get deposit order by id
📝 `POST`	`/order/kyc`	Create KYC order
🔍 `GET`	`/order/kyc/list`	Get KYC order list
🔍 `GET`	`/order/kyc/{orderId}`	Get KYC order by id
✏️ `PUT`	`/order/kyc/{orderId}/review`	Review KYC order
📝 `POST`	`/order/kyc/seed`	Seed KYC orders for testing

📖 Detailed Documentation

Create card order

POST/order/card/create

Full URL

https://api.market.decenctype.com/order/card/create

📝 Request Body Parameters

Parameter	Type	Required	Description
`userId`	`string (uuid)`	✅	用户ID
`cardProductId`	`string (uuid)`	✅	卡片产品ID
`quantity`	`number`	❌	数量, 用于批量创建卡片 (默认: 1) (最小: 1, 最大: 10)
`promotionCodeId`	`string`	❌	促销代码, 用于单卡创建使用
`paymentMethod`	`string (crypto, fiat)`	✅	支付方式
`currency`	`string (USD, EUR, BTC, ETH, USDT, USDC)`	❌	货币用于支付 (默认: 加密货币使用USDT，法币使用USD)
`remark`	`string`	❌	备注

Description: Create card order

Operation ID: createCardOrder

Response Status:

✅ 200: The detail of card order
✅ 201: Success

📋 Response Examples

response.json

1{
2  "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
3  "status": "pending",
4  "operatorId": "operator-123",
5  "userId": "example-id",
6  "type": "standard",
7  "kycType": "standard",
8  "cardProductId": "example-id",
9  "cardId": "example-id",
10  "quantity": 1,
11  "price": 1,
12  "priceTotal": 1,
13  "priceCurrency": "example-priceCurrency",
14  "discount": 0,
15  "promotionCodeId": "example-id",
16  "paymentMethod": "crypto",
17  "orderSnapshot": {},
18  "kycOrderIds": [
19    "example-item"
20  ],
21  "remark": "example-remark",
22  "reason": "Risk control",
23  "user": "example-user",
24  "cardProduct": "example-cardProduct",
25  "card": "example-card",
26  "bulkCardRecords": [
27    {
28      "recordId": "123e4567-e89b-12d3-a456-426614174000",
29      "orderId": "123e4567-e89b-12d3-a456-426614174000",
30      "status": "pending"
31    }
32  ]
33}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/order/card/create" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "userId": "12345678-1234-1234-1234-123456789abc",
  "cardProductId": "12345678-1234-1234-1234-123456789abc",
  "paymentMethod": "crypto"
}'

Create bulk card order

POST/order/card/bulk-create

Full URL

https://api.market.decenctype.com/order/card/bulk-create

📝 Request Body Parameters

Parameter	Type	Required	Description
`userId`	`string (uuid)`	✅	用户ID
`cardProductId`	`string (uuid)`	✅	卡片产品ID
`quantity`	`number`	❌	数量, 用于批量创建卡片 (默认: 1) (最小: 1, 最大: 10)
`promotionCodeId`	`string`	❌	促销代码, 用于单卡创建使用
`paymentMethod`	`string (crypto, fiat)`	✅	支付方式
`currency`	`string (USD, EUR, BTC, ETH, USDT, USDC)`	❌	货币用于支付 (默认: 加密货币使用USDT，法币使用USD)
`remark`	`string`	❌	备注
`kycType`	`string (standard, specify, pool)`	❌	KycType (默认: pool)
`kycOrderIds`	`array`	❌	Kyc Order Id, for existing KYC orders, for bulk card creation, only required if kycType is "specify"

Description: Create bulk card order

Operation ID: createBulkCardOrder

Response Status:

✅ 200: The detail of bulk card order
✅ 201: Success

📋 Response Examples

response.json

1{
2  "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
3  "status": "pending",
4  "operatorId": "operator-123",
5  "userId": "example-id",
6  "type": "standard",
7  "kycType": "standard",
8  "cardProductId": "example-id",
9  "cardId": "example-id",
10  "quantity": 1,
11  "price": 1,
12  "priceTotal": 1,
13  "priceCurrency": "example-priceCurrency",
14  "discount": 0,
15  "promotionCodeId": "example-id",
16  "paymentMethod": "crypto",
17  "orderSnapshot": {},
18  "kycOrderIds": [
19    "example-item"
20  ],
21  "remark": "example-remark",
22  "reason": "Risk control",
23  "user": "example-user",
24  "cardProduct": "example-cardProduct",
25  "card": "example-card",
26  "bulkCardRecords": [
27    {
28      "recordId": "123e4567-e89b-12d3-a456-426614174000",
29      "orderId": "123e4567-e89b-12d3-a456-426614174000",
30      "status": "pending"
31    }
32  ]
33}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/order/card/bulk-create" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "userId": "12345678-1234-1234-1234-123456789abc",
  "cardProductId": "12345678-1234-1234-1234-123456789abc",
  "paymentMethod": "crypto"
}'

Get card order by id

GET/order/card/{orderId}

Full URL

https://api.market.decenctype.com/order/card/{orderId}

🎯 Path Parameters

orderId (string) - ✅ Required: No description

Description: Get card order by id

Operation ID: getCardOrder

Response Status:

✅ 200: The detail of card order

📋 Response Examples

response.json

1{
2  "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
3  "status": "pending",
4  "operatorId": "operator-123",
5  "userId": "example-id",
6  "type": "standard",
7  "kycType": "standard",
8  "cardProductId": "example-id",
9  "cardId": "example-id",
10  "quantity": 1,
11  "price": 1,
12  "priceTotal": 1,
13  "priceCurrency": "example-priceCurrency",
14  "discount": 0,
15  "promotionCodeId": "example-id",
16  "paymentMethod": "crypto",
17  "orderSnapshot": {},
18  "kycOrderIds": [
19    "example-item"
20  ],
21  "remark": "example-remark",
22  "reason": "Risk control",
23  "user": "example-user",
24  "cardProduct": "example-cardProduct",
25  "card": "example-card",
26  "bulkCardRecords": [
27    {
28      "recordId": "123e4567-e89b-12d3-a456-426614174000",
29      "orderId": "123e4567-e89b-12d3-a456-426614174000",
30      "status": "pending"
31    }
32  ]
33}

📝 Example Request

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

Get card order list

GET/order/card

Full URL

https://api.market.decenctype.com/order/card

📋 Query Parameters

Parameter	Type	Required	Description
`sortField`	`string`	❌	排序字段
`sort`	`string`	❌	排序方式
`page`	`number`	❌	页码（从1开始）
`pageSize`	`number`	❌	每页条数
`orderId`	`string`	❌	Order ID (示例: `123456`)
`status`	`string`	❌	Order status (示例: `pending`)
`userId`	`string`	❌	User ID (示例: `user123`)
`startDate`	`string`	❌	Start date for order creation (示例: `2023-01-01T00:00:00Z`)
`endDate`	`string`	❌	End date for order creation (示例: `2023-12-31T23:59:59Z`)
`transferDirection`	`string`	❌	Transfer direction (only for transfer orders) (示例: `in`)

Description: Get card order list

Operation ID: getAllCardOrder

Response Status:

✅ 200: The list of card orders

📋 Response Examples

response.json

1{
2  "items": [
3    {
4      "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
5      "status": "pending",
6      "userId": "example-id",
7      "type": "standard",
8      "cardProductId": "example-id",
9      "quantity": 1,
10      "price": 1,
11      "priceTotal": 1,
12      "priceCurrency": "example-priceCurrency",
13      "discount": 0,
14      "paymentMethod": "crypto",
15      "orderSnapshot": {},
16      "user": "example-user",
17      "cardProduct": "example-cardProduct"
18    }
19  ],
20  "meta": "example-meta"
21}

📝 Example Request

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

Pay Card order

POST/order/card/{orderId}/pay

Full URL

https://api.market.decenctype.com/order/card/{orderId}/pay

🎯 Path Parameters

orderId (string) - ✅ Required: No description

Description: Pay Card order

Operation ID: payCardOrder

Response Status:

✅ 201: Success

📝 Example Request

curl -X POST "https://api.market.decenctype.com/order/card/example-id/pay" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Cancel card order

DELETE/order/card/{orderId}/cancel

Full URL

https://api.market.decenctype.com/order/card/{orderId}/cancel

🎯 Path Parameters

orderId (string) - ✅ Required: No description

Description: Cancel card order

Operation ID: deleteCardOrder

Response Status:

✅ 200: Success

📝 Example Request

curl -X DELETE "https://api.market.decenctype.com/order/card/example-id/cancel" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Create transfer order

POST/order/transfer

Full URL

https://api.market.decenctype.com/order/transfer

📝 Request Body Parameters

Parameter	Type	Required	Description
`transferType`	`string (email, phone, user_id, invite_code)`	✅	Transfer Type
`type`	`string (user, merchant)`	✅	Type
`paymentMethod`	`string (crypto, fiat)`	✅	支付方式
`currency`	`string (USD, EUR, BTC, ETH, USDT, USDC)`	✅	货币
`toEmail`	`string (email)`	✅	Target User Email
`toPhone`	`string (phone)`	✅	Target User Phone
`toId`	`string`	✅	Target 用户ID
`toInviteCode`	`string`	✅	Target User Invite Code
`amount`	`number`	✅	Amount

Description: Create transfer order

Operation ID: createTransferOrder

Response Status:

✅ 200: The detail of transfer order
✅ 201: Success

📋 Response Examples

response.json

1{
2  "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
3  "status": "pending",
4  "operatorId": "operator-123",
5  "type": "user",
6  "transferType": "email",
7  "paymentMethod": "crypto",
8  "fromAccountId": "example-id",
9  "toAccountId": "example-id",
10  "amount": 1,
11  "currency": "USD"
12}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/order/transfer" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "transferType": "email",
  "type": "user",
  "paymentMethod": "crypto",
  "currency": "USD",
  "toEmail": "user@example.com",
  "toPhone": "example-toPhone",
  "toId": "example-id",
  "toInviteCode": "example-toInviteCode",
  "amount": 1
}'

Get transfer order list

GET/order/transfer/list

Full URL

https://api.market.decenctype.com/order/transfer/list

📋 Query Parameters

Parameter	Type	Required	Description
`sortField`	`string`	❌	排序字段
`sort`	`string`	❌	排序方式
`page`	`number`	❌	页码（从1开始）
`pageSize`	`number`	❌	每页条数
`orderId`	`string`	❌	Order ID (示例: `123456`)
`status`	`string`	❌	Order status (示例: `pending`)
`userId`	`string`	❌	User ID (示例: `user123`)
`startDate`	`string`	❌	Start date for order creation (示例: `2023-01-01T00:00:00Z`)
`endDate`	`string`	❌	End date for order creation (示例: `2023-12-31T23:59:59Z`)
`transferDirection`	`string`	❌	Transfer direction (only for transfer orders) (示例: `in`)

Description: Get transfer order list

Operation ID: getTransferOrderList

Response Status:

✅ 200: The list of transfer orders

📋 Response Examples

response.json

1{
2  "items": [
3    {
4      "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
5      "status": "pending",
6      "type": "user",
7      "transferType": "email",
8      "paymentMethod": "crypto",
9      "fromAccountId": "example-id",
10      "toAccountId": "example-id",
11      "amount": 1,
12      "currency": "USD"
13    }
14  ],
15  "meta": "example-meta"
16}

📝 Example Request

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

Get transfer user statistics

GET/order/transfer/user-stats

Full URL

https://api.market.decenctype.com/order/transfer/user-stats

📋 Query Parameters

Parameter	Type	Required	Description
`days`	`string`	❌	Number of days to look back (default: 30) (示例: `30`)
`limit`	`string`	❌	Maximum number of users to return (default: 50) (示例: `50`)

Description: Get transfer user statistics

Operation ID: getTransferUserStats

Response Status:

✅ 200: Transfer user statistics retrieved successfully

📋 Response Examples

response.json

1{
2  "users": [
3    {
4      "userId": "550e8400-e29b-41d4-a716-446655440000",
5      "transferCount": 15,
6      "totalAmount": 1500.5,
7      "currency": "USD",
8      "lastTransferAt": "2023-12-01T10:30:00Z",
9      "transferType": "user_id",
10      "paymentMethod": "crypto"
11    }
12  ],
13  "totalUsers": 100,
14  "totalTransfers": 1500
15}

📝 Example Request

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

Get transfer order by id

GET/order/transfer/{orderId}

Full URL

https://api.market.decenctype.com/order/transfer/{orderId}

🎯 Path Parameters

orderId (string) - ✅ Required: No description

Description: Get transfer order by id

Operation ID: getTransferOrder

Response Status:

✅ 200: The detail of transfer order

📋 Response Examples

response.json

1{
2  "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
3  "status": "pending",
4  "operatorId": "operator-123",
5  "type": "user",
6  "transferType": "email",
7  "paymentMethod": "crypto",
8  "fromAccountId": "example-id",
9  "toAccountId": "example-id",
10  "amount": 1,
11  "currency": "USD"
12}

📝 Example Request

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

Create exchange order

POST/order/exchange

Full URL

https://api.market.decenctype.com/order/exchange

📝 Request Body Parameters

Parameter	Type	Required	Description
`userId`	`string (uuid)`	❌	用户ID, required when using API Key authentication
`from`	`string`	✅	Crypto 货币 type
`to`	`string`	✅	Fiat 货币 type
`cryptoAmount`	`number`	✅	Crypto amount (默认: 0)

Description: Create exchange order

Operation ID: createExchangeOrder

Response Status:

✅ 200: The detail of exchange order
✅ 201: Success

📋 Response Examples

response.json

1{
2  "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
3  "status": "pending",
4  "operatorId": "operator-123",
5  "type": "user",
6  "cryptoAccountId": "example-id",
7  "fiatAccountId": "example-id",
8  "cryptoAmount": 1,
9  "fiatAmount": 1,
10  "fiatAmountTotal": 1,
11  "fee": 1,
12  "rateId": 1,
13  "exchangeRate": 1
14}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/order/exchange" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "from": "example-from",
  "to": "example-to",
  "cryptoAmount": 0
}'

Get exchange order list

GET/order/exchange/list

Full URL

https://api.market.decenctype.com/order/exchange/list

📋 Query Parameters

Parameter	Type	Required	Description
`sortField`	`string`	❌	排序字段
`sort`	`string`	❌	排序方式
`page`	`number`	❌	页码（从1开始）
`pageSize`	`number`	❌	每页条数
`orderId`	`string`	❌	Order ID (示例: `123456`)
`status`	`string`	❌	Order status (示例: `pending`)
`userId`	`string`	❌	User ID (示例: `user123`)
`startDate`	`string`	❌	Start date for order creation (示例: `2023-01-01T00:00:00Z`)
`endDate`	`string`	❌	End date for order creation (示例: `2023-12-31T23:59:59Z`)
`transferDirection`	`string`	❌	Transfer direction (only for transfer orders) (示例: `in`)

Description: Get exchange order list

Operation ID: getExchangeOrderList

Response Status:

✅ 200: The list of exchange orders

📋 Response Examples

response.json

1{
2  "items": [
3    {
4      "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
5      "status": "pending",
6      "type": "user",
7      "cryptoAccountId": "example-id",
8      "fiatAccountId": "example-id",
9      "cryptoAmount": 1,
10      "fiatAmount": 1,
11      "fiatAmountTotal": 1,
12      "fee": 1,
13      "rateId": 1,
14      "exchangeRate": 1
15    }
16  ],
17  "meta": "example-meta"
18}

📝 Example Request

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

Get exchange order by id

GET/order/exchange/{orderId}

Full URL

https://api.market.decenctype.com/order/exchange/{orderId}

🎯 Path Parameters

orderId (string) - ✅ Required: No description

Description: Get exchange order by id

Operation ID: getExchangeOrder

Response Status:

✅ 200: The detail of exchange order

📋 Response Examples

response.json

1{
2  "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
3  "status": "pending",
4  "operatorId": "operator-123",
5  "type": "user",
6  "cryptoAccountId": "example-id",
7  "fiatAccountId": "example-id",
8  "cryptoAmount": 1,
9  "fiatAmount": 1,
10  "fiatAmountTotal": 1,
11  "fee": 1,
12  "rateId": 1,
13  "exchangeRate": 1
14}

📝 Example Request

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

Create deposit order

POST/order/deposit

Full URL

https://api.market.decenctype.com/order/deposit

📝 Request Body Parameters

Parameter	Type	Required	Description
`chainId`	`number`	✅	Chain ID
`chainAddress`	`string`	✅	Chain Address
`chainTxnId`	`string`	✅	Chain Transaction ID
`accountToken`	`string`	✅	Account Token
`cryptoAccountId`	`string (uuid)`	✅	Crypto Account ID
`cryptoAmount`	`number`	✅	Crypto Amount

Description: Create deposit order

Operation ID: createDepositOrder

Response Status:

✅ 200: The detail of deposit order
✅ 201: Success

📋 Response Examples

response.json

1{
2  "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
3  "status": "pending",
4  "operatorId": "operator-123",
5  "type": "user",
6  "chainId": 1,
7  "chainAddress": "example-chainAddress",
8  "chainTxnId": "example-id",
9  "accountToken": "example-accountToken",
10  "cryptoAccountId": "example-id",
11  "cryptoAmount": 1,
12  "reason": "example-reason"
13}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/order/deposit" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "chainId": 1,
  "chainAddress": "0x1234567890abcdef",
  "chainTxnId": "0xabcdef1234567890",
  "accountToken": "USDT-ERC20",
  "cryptoAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "cryptoAmount": 0.01
}'

Get deposit order list

GET/order/deposit/list

Full URL

https://api.market.decenctype.com/order/deposit/list

📋 Query Parameters

Parameter	Type	Required	Description
`sortField`	`string`	❌	排序字段
`sort`	`string`	❌	排序方式
`page`	`number`	❌	页码（从1开始）
`pageSize`	`number`	❌	每页条数
`orderId`	`string`	❌	Order ID (示例: `123456`)
`status`	`string`	❌	Order status (示例: `pending`)
`userId`	`string`	❌	User ID (示例: `user123`)
`startDate`	`string`	❌	Start date for order creation (示例: `2023-01-01T00:00:00Z`)
`endDate`	`string`	❌	End date for order creation (示例: `2023-12-31T23:59:59Z`)
`transferDirection`	`string`	❌	Transfer direction (only for transfer orders) (示例: `in`)

Description: Get deposit order list

Operation ID: getDepositOrderList

Response Status:

✅ 200: The list of deposit orders

📋 Response Examples

response.json

1{
2  "items": [
3    {
4      "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
5      "status": "pending",
6      "type": "user",
7      "chainId": 1,
8      "chainAddress": "example-chainAddress",
9      "chainTxnId": "example-id",
10      "accountToken": "example-accountToken",
11      "cryptoAccountId": "example-id",
12      "cryptoAmount": 1
13    }
14  ],
15  "meta": "example-meta"
16}

📝 Example Request

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

Get deposit order by id

GET/order/deposit/{orderId}

Full URL

https://api.market.decenctype.com/order/deposit/{orderId}

🎯 Path Parameters

orderId (string) - ✅ Required: No description

Description: Get deposit order by id

Operation ID: getDepositOrder

Response Status:

✅ 200: The detail of deposit order

📋 Response Examples

response.json

1{
2  "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
3  "status": "pending",
4  "operatorId": "operator-123",
5  "type": "user",
6  "chainId": 1,
7  "chainAddress": "example-chainAddress",
8  "chainTxnId": "example-id",
9  "accountToken": "example-accountToken",
10  "cryptoAccountId": "example-id",
11  "cryptoAmount": 1,
12  "reason": "example-reason"
13}

📝 Example Request

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

Create KYC order

POST/order/kyc

Full URL

https://api.market.decenctype.com/order/kyc

📝 Request Body Parameters

Parameter	Type	Required	Description
`userId`	`string`	✅	用户ID
`firstName`	`string`	✅	First name (最大长度: 20)
`lastName`	`string`	✅	Last name (最大长度: 20)
`addressCountry`	`string`	✅	Country code (ISO 3166-1 alpha-2/alpha-3)
`addressState`	`string`	❌	State/Province
`addressCity`	`string`	✅	City
`addressLine1`	`string`	✅	Address line 1
`addressLine2`	`string`	❌	Address line 2
`addressPostalCode`	`string`	✅	Postal code
`dialCode`	`string`	✅	Dial code, must include + sign
`phoneNumber`	`string`	✅	Phone number, excluding country code
`dob`	`string`	✅	Date of birth, format: YYYY-MM-DD
`documentType`	`string`	✅	Document type: ID card, passport, or driver license
`documentNumber`	`string`	✅	Document number
`documentFrontImage`	`string`	❌	Front image of document
`documentBackImage`	`string`	❌	Back image of document

Description: Create KYC order

Operation ID: createKycOrder

Response Status:

✅ 200: The detail of kyc order
✅ 201: Success

📋 Response Examples

response.json

1{
2  "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
3  "status": "pending",
4  "operatorId": "operator-123",
5  "userId": "user-123",
6  "firstName": "John",
7  "lastName": "Doe",
8  "addressCountry": "US",
9  "addressState": "California",
10  "addressCity": "Los Angeles",
11  "addressLine1": "123 Main Street",
12  "addressLine2": "Apt 4B",
13  "addressPostalCode": "90001",
14  "dob": "1990-01-01",
15  "dialCode": "1",
16  "phoneNumber": "1234567890",
17  "documentType": "passport",
18  "documentNumber": "P12345678",
19  "documentFrontImage": "https://example.com/front.jpg",
20  "documentBackImage": "https://example.com/back.jpg",
21  "reason": "Invalid document",
22  "type": "user",
23  "channelCode": "common",
24  "user": "example-user"
25}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/order/kyc" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "John",
  "lastName": "Doe",
  "addressCountry": "US",
  "addressCity": "Los Angeles",
  "addressLine1": "123 Main Street",
  "addressPostalCode": "90001",
  "dialCode": "1",
  "phoneNumber": "5551234567",
  "dob": "1990-01-01",
  "documentType": "passport",
  "documentNumber": "P1234567"
}'

Get KYC order list

GET/order/kyc/list

Full URL

https://api.market.decenctype.com/order/kyc/list

📋 Query Parameters

Parameter	Type	Required	Description
`sortField`	`string`	❌	排序字段
`sort`	`string`	❌	排序方式
`page`	`number`	❌	页码（从1开始）
`pageSize`	`number`	❌	每页条数
`orderId`	`string`	❌	Order ID (示例: `123456`)
`status`	`string`	❌	Order status (示例: `pending`)
`userId`	`string`	❌	User ID (示例: `user123`)
`startDate`	`string`	❌	Start date for order creation (示例: `2023-01-01T00:00:00Z`)
`endDate`	`string`	❌	End date for order creation (示例: `2023-12-31T23:59:59Z`)
`transferDirection`	`string`	❌	Transfer direction (only for transfer orders) (示例: `in`)

Description: Get KYC order list

Operation ID: getKycOrderList

Response Status:

✅ 200: The list of kyc orders

📋 Response Examples

response.json

1{
2  "items": [
3    {
4      "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
5      "status": "pending",
6      "firstName": "John",
7      "lastName": "Doe",
8      "addressCountry": "US",
9      "addressCity": "Los Angeles",
10      "addressLine1": "123 Main Street",
11      "addressPostalCode": "90001",
12      "dob": "1990-01-01",
13      "dialCode": "1",
14      "phoneNumber": "1234567890",
15      "documentType": "passport",
16      "documentNumber": "P12345678",
17      "type": "user",
18      "channelCode": "common",
19      "user": "example-user"
20    }
21  ],
22  "meta": "example-meta"
23}

📝 Example Request

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

Get KYC order by id

GET/order/kyc/{orderId}

Full URL

https://api.market.decenctype.com/order/kyc/{orderId}

🎯 Path Parameters

orderId (string) - ✅ Required: No description

Description: Get KYC order by id

Operation ID: getKycOrder

Response Status:

✅ 200: The detail of kyc order

📋 Response Examples

response.json

1{
2  "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
3  "status": "pending",
4  "operatorId": "operator-123",
5  "userId": "user-123",
6  "firstName": "John",
7  "lastName": "Doe",
8  "addressCountry": "US",
9  "addressState": "California",
10  "addressCity": "Los Angeles",
11  "addressLine1": "123 Main Street",
12  "addressLine2": "Apt 4B",
13  "addressPostalCode": "90001",
14  "dob": "1990-01-01",
15  "dialCode": "1",
16  "phoneNumber": "1234567890",
17  "documentType": "passport",
18  "documentNumber": "P12345678",
19  "documentFrontImage": "https://example.com/front.jpg",
20  "documentBackImage": "https://example.com/back.jpg",
21  "reason": "Invalid document",
22  "type": "user",
23  "channelCode": "common",
24  "user": "example-user"
25}

📝 Example Request

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

Review KYC order

PUT/order/kyc/{orderId}/review

Full URL

https://api.market.decenctype.com/order/kyc/{orderId}/review

🎯 Path Parameters

orderId (string) - ✅ Required: No description

📝 Request Body Parameters

Parameter	Type	Required	Description
`approve`	`number (true, false)`	✅	Whether the order is approved or rejected
`operatorId`	`string`	✅	The ID of the operator who reviews the order
`comment`	`string`	❌	Additional comments for the review

Description: Review KYC order

Operation ID: reviewKycOrder

Response Status:

✅ 200: The detail of kyc order

This endpoint is used to review KYC orders by Merchant/Admin.

📋 Response Examples

response.json

1{
2  "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
3  "status": "pending",
4  "operatorId": "operator-123",
5  "userId": "user-123",
6  "firstName": "John",
7  "lastName": "Doe",
8  "addressCountry": "US",
9  "addressState": "California",
10  "addressCity": "Los Angeles",
11  "addressLine1": "123 Main Street",
12  "addressLine2": "Apt 4B",
13  "addressPostalCode": "90001",
14  "dob": "1990-01-01",
15  "dialCode": "1",
16  "phoneNumber": "1234567890",
17  "documentType": "passport",
18  "documentNumber": "P12345678",
19  "documentFrontImage": "https://example.com/front.jpg",
20  "documentBackImage": "https://example.com/back.jpg",
21  "reason": "Invalid document",
22  "type": "user",
23  "channelCode": "common",
24  "user": "example-user"
25}

📝 Example Request

curl -X PUT "https://api.market.decenctype.com/order/kyc/example-id/review" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "approve": true,
  "operatorId": "1234567890abcdef"
}'

Seed KYC orders for testing

POST/order/kyc/seed

Full URL

https://api.market.decenctype.com/order/kyc/seed

🔐 Authentication: Required (see authentication section above)

Description: Seed KYC orders for testing

Operation ID: seedKycOrders

Response Status:

✅ 201: Success

📝 Example Request

curl -X POST "https://api.market.decenctype.com/order/kyc/seed" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

📦 Order Management

🎯 Quick Stats

📊 Methods

🔑 Bearer Token (Recommended)

🔧 API Key

On this page