🃏 Card Management

Card creation, management, and transaction endpoints. 38 endpoints available.

🎯 Quick Stats

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

📊 Methods

📝 POST: 10 endpoints
🔍 GET: 14 endpoints
✏️ PUT: 10 endpoints
🗑️ DELETE: 4 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`	`/card/issuer/create`	Create a new card issuer
🔍 `GET`	`/card/issuer/list`	Get card issuer list
🔍 `GET`	`/card/issuer/{issuerId}`	Get specific card issuer by ID
✏️ `PUT`	`/card/issuer/{issuerId}`	Update an existing card issuer
🗑️ `DELETE`	`/card/issuer/{issuerId}`	Delete a card issuer
📝 `POST`	`/card/{issuerId}/channel/create`	Create a new card channel
🔍 `GET`	`/card/{issuer}/channel/list`	Get card channel list
🔍 `GET`	`/card/channel/bin-list`	Get card channel BIN list
🔍 `GET`	`/card/channel/{channelId}`	Get specific card channel by ID
✏️ `PUT`	`/card/channel/{channelId}`	Update an existing card channel
🗑️ `DELETE`	`/card/channel/{channelId}`	Delete a card channel
📝 `POST`	`/card/product/create`	Create card product for merchant
🔍 `GET`	`/card/products`	Get card product list
🔍 `GET`	`/card/product/{cardProductId}`	Get specific card product by ID
✏️ `PUT`	`/card/product/{cardProductId}`	Update card product for merchant
🗑️ `DELETE`	`/card/product/{cardProductId}`	Delete card product for merchant
✏️ `PUT`	`/card/{cardId}/3ds-forwarding`	Update 3DS forwarding method for a card
🔍 `GET`	`/card/user`	Get cards by user ID
🔍 `GET`	`/card/{cardId}`	Find card by ID
🔍 `GET`	`/card/search`	Search cards by various criteria
✏️ `PUT`	`/card/{cardId}/update`	Update an existing card
✏️ `PUT`	`/card/{cardId}/lock`	Lock a card
✏️ `PUT`	`/card/{cardId}/unlock`	Unlock a card
🗑️ `DELETE`	`/card/{cardId}/delete`	Delete a card
✏️ `PUT`	`/card/{cardId}/activate`	Activate a card
🔍 `GET`	`/card/{cardId}/sensitive-info`	Get card sensitive information
🔍 `GET`	`/card/{cardId}/balance`	Get card balance
🔍 `GET`	`/card/{cardId}/available-balance`	Get card available balance
📝 `POST`	`/card/{cardId}/credit`	Charge a card (add funds)
📝 `POST`	`/card/{cardId}/debit`	Debit a card (deduct funds)
📝 `POST`	`/card/transfer`	Transfer funds between cards
🔍 `GET`	`/card/sunrate/test-connection`	Test Sunrate API connection, IP whitelist and encryption algorithm
📝 `POST`	`/card/sunrate/test-decrypt`	Test endpoint for decrypting a payload.
✏️ `PUT`	`/card/sunrate/velocity-limits/{cardId}`	No description
📝 `POST`	`/card/{cardId}/withdraw`	Withdraw funds from a card
📝 `POST`	`/card/{cardId}/3ds-verification`	Respond to 3DS verification
✏️ `PUT`	`/card/{cardId}/pin`	Update card PIN
📝 `POST`	`/card/bind`	Bind card by last 4 digits and activation code

📖 Detailed Documentation

Create a new card issuer

POST/card/issuer/create

Full URL

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

📝 Request Body Parameters

Parameter	Type	Required	Description
`code`	`string`	✅	发卡机构代码，如: OUITRUST
`description`	`string`	✅	发卡机构描述 (默认: NEW ISSUER)
`status`	`string (ACTIVE, INACTIVE, PENDING, SUSPENDED, DELETED)`	✅	发卡机构状态 (默认: ACTIVE)

Description: Create a new card issuer

Operation ID: createCardIssuer

Response Status:

✅ 200: Create a new card issuer
✅ 201: Success

📋 Response Examples

response.json

1{
2  "issuerId": "example-id",
3  "code": "example-code",
4  "description": "example-description",
5  "status": "example-status",
6  "cardProducts": [
7    {
8      "cardProductId": "example-id",
9      "issuerId": "example-id",
10      "issuer": "example-issuer",
11      "channelId": "example-id",
12      "channel": "example-channel",
13      "status": "example-status",
14      "product": "example-product",
15      "price": 1,
16      "currency": "example-currency",
17      "type": "example-type",
18      "cardDesign": "example-cardDesign",
19      "designId": "example-id",
20      "country": "example-country",
21      "bin": "example-bin",
22      "description": "example-description",
23      "isGlobal": true,
24      "settings": "example-settings"
25    }
26  ],
27  "cardChannels": [
28    {
29      "channelId": "example-id",
30      "issuerId": "example-id",
31      "issuer": "example-issuer",
32      "code": "example-code",
33      "channelConfig": {},
34      "description": "example-description",
35      "status": "example-status",
36      "cardProducts": [
37        {
38          "cardProductId": "example-id",
39          "issuerId": "example-id",
40          "issuer": "example-issuer",
41          "channelId": "example-id",
42          "channel": "example-channel",
43          "status": "example-status",
44          "product": "example-product",
45          "price": 1,
46          "currency": "example-currency",
47          "type": "example-type",
48          "cardDesign": "example-cardDesign",
49          "designId": "example-id",
50          "country": "example-country",
51          "bin": "example-bin",
52          "description": "example-description",
53          "isGlobal": true,
54          "settings": "example-settings"
55        }
56      ],
57      "binList": [
58        "example-item"
59      ]
60    }
61  ]
62}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/card/issuer/create" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "code": "NEW ISSUER",
  "description": "发卡机构描述",
  "status": "ACTIVE"
}'

Get card issuer list

GET/card/issuer/list

Full URL

https://api.market.decenctype.com/card/issuer/list

📋 Query Parameters

Parameter	Type	Required	Description
`code`	`string`	❌	Issuer code to filter the list
`sortField`	`string`	❌	排序字段
`sort`	`string`	❌	排序方式
`page`	`number`	❌	页码（从1开始）
`pageSize`	`number`	❌	每页条数

Description: Get card issuer list

Operation ID: getCardIssuer

Response Status:

✅ 200: List of card channels

📋 Response Examples

response.json

1{
2  "items": [
3    {
4      "issuerId": "example-id",
5      "code": "example-code",
6      "description": "example-description",
7      "status": "example-status",
8      "cardProducts": [
9        {
10          "cardProductId": "example-id",
11          "issuerId": "example-id",
12          "issuer": "example-issuer",
13          "channelId": "example-id",
14          "channel": "example-channel",
15          "status": "example-status",
16          "product": "example-product",
17          "price": 1,
18          "currency": "example-currency",
19          "type": "example-type",
20          "cardDesign": "example-cardDesign",
21          "designId": "example-id",
22          "country": "example-country",
23          "bin": "example-bin",
24          "description": "example-description",
25          "isGlobal": true,
26          "settings": "example-settings"
27        }
28      ],
29      "cardChannels": [
30        {
31          "channelId": "example-id",
32          "issuerId": "example-id",
33          "issuer": "example-issuer",
34          "code": "example-code",
35          "channelConfig": {},
36          "description": "example-description",
37          "status": "example-status",
38          "cardProducts": [
39            {
40              "cardProductId": "example-id",
41              "issuerId": "example-id",
42              "issuer": "example-issuer",
43              "channelId": "example-id",
44              "channel": "example-channel",
45              "status": "example-status",
46              "product": "example-product",
47              "price": 1,
48              "currency": "example-currency",
49              "type": "example-type",
50              "cardDesign": "example-cardDesign",
51              "designId": "example-id",
52              "country": "example-country",
53              "bin": "example-bin",
54              "description": "example-description",
55              "isGlobal": true,
56              "settings": "example-settings"
57            }
58          ],
59          "binList": [
60            "example-item"
61          ]
62        }
63      ]
64    }
65  ],
66  "meta": "example-meta"
67}

📝 Example Request

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

Get specific card issuer by ID

GET/card/issuer/{issuerId}

Full URL

https://api.market.decenctype.com/card/issuer/{issuerId}

🎯 Path Parameters

issuerId (string) - ✅ Required: No description

Description: Get specific card issuer by ID

Operation ID: getCardIssuerById

Response Status:

✅ 200: Card issuer details

📋 Response Examples

response.json

1{
2  "issuerId": "example-id",
3  "code": "example-code",
4  "description": "example-description",
5  "status": "example-status",
6  "cardProducts": [
7    {
8      "cardProductId": "example-id",
9      "issuerId": "example-id",
10      "issuer": "example-issuer",
11      "channelId": "example-id",
12      "channel": "example-channel",
13      "status": "example-status",
14      "product": "example-product",
15      "price": 1,
16      "currency": "example-currency",
17      "type": "example-type",
18      "cardDesign": "example-cardDesign",
19      "designId": "example-id",
20      "country": "example-country",
21      "bin": "example-bin",
22      "description": "example-description",
23      "isGlobal": true,
24      "settings": "example-settings"
25    }
26  ],
27  "cardChannels": [
28    {
29      "channelId": "example-id",
30      "issuerId": "example-id",
31      "issuer": "example-issuer",
32      "code": "example-code",
33      "channelConfig": {},
34      "description": "example-description",
35      "status": "example-status",
36      "cardProducts": [
37        {
38          "cardProductId": "example-id",
39          "issuerId": "example-id",
40          "issuer": "example-issuer",
41          "channelId": "example-id",
42          "channel": "example-channel",
43          "status": "example-status",
44          "product": "example-product",
45          "price": 1,
46          "currency": "example-currency",
47          "type": "example-type",
48          "cardDesign": "example-cardDesign",
49          "designId": "example-id",
50          "country": "example-country",
51          "bin": "example-bin",
52          "description": "example-description",
53          "isGlobal": true,
54          "settings": "example-settings"
55        }
56      ],
57      "binList": [
58        "example-item"
59      ]
60    }
61  ]
62}

📝 Example Request

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

Update an existing card issuer

PUT/card/issuer/{issuerId}

Full URL

https://api.market.decenctype.com/card/issuer/{issuerId}

🎯 Path Parameters

issuerId (string) - ✅ Required: No description

📝 Request Body Parameters

Parameter	Type	Required	Description
`description`	`string`	✅	发卡机构描述
`status`	`string (ACTIVE, INACTIVE, PENDING, SUSPENDED, DELETED)`	✅	发卡机构状态 (默认: ACTIVE)

Description: Update an existing card issuer

Operation ID: updateCardIssuer

Response Status:

✅ 200: Update an existing card issuer

📋 Response Examples

response.json

1{
2  "issuerId": "example-id",
3  "code": "example-code",
4  "description": "example-description",
5  "status": "example-status",
6  "cardProducts": [
7    {
8      "cardProductId": "example-id",
9      "issuerId": "example-id",
10      "issuer": "example-issuer",
11      "channelId": "example-id",
12      "channel": "example-channel",
13      "status": "example-status",
14      "product": "example-product",
15      "price": 1,
16      "currency": "example-currency",
17      "type": "example-type",
18      "cardDesign": "example-cardDesign",
19      "designId": "example-id",
20      "country": "example-country",
21      "bin": "example-bin",
22      "description": "example-description",
23      "isGlobal": true,
24      "settings": "example-settings"
25    }
26  ],
27  "cardChannels": [
28    {
29      "channelId": "example-id",
30      "issuerId": "example-id",
31      "issuer": "example-issuer",
32      "code": "example-code",
33      "channelConfig": {},
34      "description": "example-description",
35      "status": "example-status",
36      "cardProducts": [
37        {
38          "cardProductId": "example-id",
39          "issuerId": "example-id",
40          "issuer": "example-issuer",
41          "channelId": "example-id",
42          "channel": "example-channel",
43          "status": "example-status",
44          "product": "example-product",
45          "price": 1,
46          "currency": "example-currency",
47          "type": "example-type",
48          "cardDesign": "example-cardDesign",
49          "designId": "example-id",
50          "country": "example-country",
51          "bin": "example-bin",
52          "description": "example-description",
53          "isGlobal": true,
54          "settings": "example-settings"
55        }
56      ],
57      "binList": [
58        "example-item"
59      ]
60    }
61  ]
62}

📝 Example Request

curl -X PUT "https://api.market.decenctype.com/card/issuer/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "description": "新的发卡机构",
  "status": "ACTIVE"
}'

Delete a card issuer

DELETE/card/issuer/{issuerId}

Full URL

https://api.market.decenctype.com/card/issuer/{issuerId}

🎯 Path Parameters

issuerId (string) - ✅ Required: No description

Description: Delete a card issuer

Operation ID: deleteCardIssuer

Response Status:

✅ 200: Delete a card issuer

📝 Example Request

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

Create a new card channel

POST/card/{issuerId}/channel/create

Full URL

https://api.market.decenctype.com/card/{issuerId}/channel/create

🎯 Path Parameters

issuerId (string) - ✅ Required: Issuer ID to create the channel for

📝 Request Body Parameters

Parameter	Type	Required	Description
`code`	`string`	✅	渠道代码，如: common, ads
`description`	`string`	✅	渠道描述
`status`	`string (ACTIVE, INACTIVE, PENDING, SUSPENDED, DELETED)`	✅	渠道状态 (默认: ACTIVE)

Description: Create a new card channel

Operation ID: createCardChannel

Response Status:

✅ 200: Create a new card channel
✅ 201: Success

📋 Response Examples

response.json

1{
2  "channelId": "example-id",
3  "issuerId": "example-id",
4  "issuer": "example-issuer",
5  "code": "example-code",
6  "channelConfig": {},
7  "description": "example-description",
8  "status": "example-status",
9  "cardProducts": [
10    {
11      "cardProductId": "example-id",
12      "issuerId": "example-id",
13      "issuer": "example-issuer",
14      "channelId": "example-id",
15      "channel": "example-channel",
16      "status": "example-status",
17      "product": "example-product",
18      "price": 1,
19      "currency": "example-currency",
20      "type": "example-type",
21      "cardDesign": "example-cardDesign",
22      "designId": "example-id",
23      "country": "example-country",
24      "bin": "example-bin",
25      "description": "example-description",
26      "isGlobal": true,
27      "settings": "example-settings"
28    }
29  ],
30  "binList": [
31    "example-item"
32  ]
33}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/card/example-id/channel/create" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "code": "NEW CHANNEL",
  "description": "这是一个新渠道",
  "status": "ACTIVE"
}'

Get card channel list

GET/card/{issuer}/channel/list

Full URL

https://api.market.decenctype.com/card/{issuer}/channel/list

🎯 Path Parameters

issuer (string) - ✅ Required: Issuer ID to filter the list

📋 Query Parameters

Parameter	Type	Required	Description
`code`	`string`	❌	Channel code to filter the list
`sortField`	`string`	❌	排序字段
`sort`	`string`	❌	排序方式
`page`	`number`	❌	页码（从1开始）
`pageSize`	`number`	❌	每页条数

Description: Get card channel list

Operation ID: getCardChannel

Response Status:

✅ 200: List of card channels

📋 Response Examples

response.json

1{
2  "items": [
3    {
4      "channelId": "example-id",
5      "issuerId": "example-id",
6      "issuer": "example-issuer",
7      "code": "example-code",
8      "channelConfig": {},
9      "description": "example-description",
10      "status": "example-status",
11      "cardProducts": [
12        {
13          "cardProductId": "example-id",
14          "issuerId": "example-id",
15          "issuer": "example-issuer",
16          "channelId": "example-id",
17          "channel": "example-channel",
18          "status": "example-status",
19          "product": "example-product",
20          "price": 1,
21          "currency": "example-currency",
22          "type": "example-type",
23          "cardDesign": "example-cardDesign",
24          "designId": "example-id",
25          "country": "example-country",
26          "bin": "example-bin",
27          "description": "example-description",
28          "isGlobal": true,
29          "settings": "example-settings"
30        }
31      ],
32      "binList": [
33        "example-item"
34      ]
35    }
36  ],
37  "meta": "example-meta"
38}

📝 Example Request

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

Get card channel BIN list

GET/card/channel/bin-list

Full URL

https://api.market.decenctype.com/card/channel/bin-list

🔐 Authentication: Required (see authentication section above)

Description: Get card channel BIN list

Operation ID: getCardChannelBinList

Response Status:

✅ 200: BIN list for specific card channel

This endpoint retrieves the BIN list for a specific card channel and issuer.

📝 Example Request

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

Get specific card channel by ID

GET/card/channel/{channelId}

Full URL

https://api.market.decenctype.com/card/channel/{channelId}

🎯 Path Parameters

channelId (string) - ✅ Required: No description

Description: Get specific card channel by ID

Operation ID: getCardChannelById

Response Status:

✅ 200: Card channel details

📋 Response Examples

response.json

1{
2  "channelId": "example-id",
3  "issuerId": "example-id",
4  "issuer": "example-issuer",
5  "code": "example-code",
6  "channelConfig": {},
7  "description": "example-description",
8  "status": "example-status",
9  "cardProducts": [
10    {
11      "cardProductId": "example-id",
12      "issuerId": "example-id",
13      "issuer": "example-issuer",
14      "channelId": "example-id",
15      "channel": "example-channel",
16      "status": "example-status",
17      "product": "example-product",
18      "price": 1,
19      "currency": "example-currency",
20      "type": "example-type",
21      "cardDesign": "example-cardDesign",
22      "designId": "example-id",
23      "country": "example-country",
24      "bin": "example-bin",
25      "description": "example-description",
26      "isGlobal": true,
27      "settings": "example-settings"
28    }
29  ],
30  "binList": [
31    "example-item"
32  ]
33}

📝 Example Request

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

Update an existing card channel

PUT/card/channel/{channelId}

Full URL

https://api.market.decenctype.com/card/channel/{channelId}

🎯 Path Parameters

channelId (string) - ✅ Required: No description

📝 Request Body Parameters

Parameter	Type	Required	Description
`name`	`string`	✅	渠道名称
`description`	`string`	✅	渠道描述
`status`	`string (ACTIVE, INACTIVE, PENDING, SUSPENDED, DELETED)`	✅	渠道状态 (默认: ACTIVE)

Description: Update an existing card channel

Operation ID: updateCardChannel

Response Status:

✅ 200: Update an existing card channel

📋 Response Examples

response.json

1{
2  "channelId": "example-id",
3  "issuerId": "example-id",
4  "issuer": "example-issuer",
5  "code": "example-code",
6  "channelConfig": {},
7  "description": "example-description",
8  "status": "example-status",
9  "cardProducts": [
10    {
11      "cardProductId": "example-id",
12      "issuerId": "example-id",
13      "issuer": "example-issuer",
14      "channelId": "example-id",
15      "channel": "example-channel",
16      "status": "example-status",
17      "product": "example-product",
18      "price": 1,
19      "currency": "example-currency",
20      "type": "example-type",
21      "cardDesign": "example-cardDesign",
22      "designId": "example-id",
23      "country": "example-country",
24      "bin": "example-bin",
25      "description": "example-description",
26      "isGlobal": true,
27      "settings": "example-settings"
28    }
29  ],
30  "binList": [
31    "example-item"
32  ]
33}

📝 Example Request

curl -X PUT "https://api.market.decenctype.com/card/channel/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "name": "更新的渠道名称",
  "description": "更新的渠道描述",
  "status": "ACTIVE"
}'

Delete a card channel

DELETE/card/channel/{channelId}

Full URL

https://api.market.decenctype.com/card/channel/{channelId}

🎯 Path Parameters

channelId (string) - ✅ Required: No description

Description: Delete a card channel

Operation ID: deleteCardChannel

Response Status:

✅ 200: Delete a card channel

📝 Example Request

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

Create card product for merchant

POST/card/product/create

Full URL

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

📝 Request Body Parameters

Parameter	Type	Required	Description
`merchantId`	`string`	❌	商户 ID
`issuerId`	`string`	✅	发卡方ID
`channelId`	`string`	✅	渠道ID
`product`	`string`	✅	产品名称
`price`	`number`	✅	产品价格
`currency`	`string`	✅	货币类型
`type`	`string (PHYSICAL_CARD, VIRTUAL_CARD)`	✅	卡类型
`cardDesign`	`string`	❌	卡片设计
`country`	`string`	❌	国家代码
`bin`	`string`	❌	卡BIN
`description`	`string`	❌	描述信息
`isGlobal`	`boolean`	❌	是否全局可用 (默认: false)
`status`	`string (ACTIVE, INACTIVE, SUSPENDED)`	❌	卡产品状态 (默认: ACTIVE)
`settings`	`object`	❌	卡产品特定配置

Description: Create card product for merchant

Operation ID: createCardProductForMerchant

Response Status:

✅ 200: Create card for merchant
✅ 201: Success

A merchantId is only required when creating a card product not through an oauth app of specified merchant

📋 Response Examples

response.json

1{
2  "cardProductId": "example-id",
3  "issuerId": "example-id",
4  "issuer": "example-issuer",
5  "channelId": "example-id",
6  "channel": "example-channel",
7  "merchantId": "example-id",
8  "merchant": "example-merchant",
9  "status": "example-status",
10  "product": "example-product",
11  "price": 1,
12  "currency": "example-currency",
13  "type": "example-type",
14  "cardDesign": "example-cardDesign",
15  "designId": "example-id",
16  "country": "example-country",
17  "bin": "example-bin",
18  "description": "example-description",
19  "isGlobal": true,
20  "settings": "example-settings"
21}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/card/product/create" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "issuerId": "example-id",
  "channelId": "example-id",
  "product": "example-product",
  "price": 1,
  "currency": "example-currency",
  "type": "PHYSICAL_CARD"
}'

Get card product list

GET/card/products

Full URL

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

📋 Query Parameters

Parameter	Type	Required	Description
`sortField`	`string`	❌	排序字段
`sort`	`string`	❌	排序方式
`page`	`number`	❌	页码（从1开始）
`pageSize`	`number`	❌	每页条数
`product`	`string`	❌	产品名称关键字
`currency`	`string`	❌	货币类型
`type`	`string`	❌	卡类型
`issuerCode`	`string`	❌	发卡方代号
`channelCode`	`string`	❌	渠道代号
`includeGlobal`	`boolean`	❌	是否包括全局卡产品
`status`	`string`	❌	卡产品状态

Description: Get card product list

Operation ID: getCardProduct

Response Status:

✅ 200: List of card products

📋 Response Examples

response.json

1{
2  "items": [
3    {
4      "cardProductId": "example-id",
5      "issuerId": "example-id",
6      "issuer": "example-issuer",
7      "channelId": "example-id",
8      "channel": "example-channel",
9      "status": "example-status",
10      "product": "example-product",
11      "price": 1,
12      "currency": "example-currency",
13      "type": "example-type",
14      "cardDesign": "example-cardDesign",
15      "designId": "example-id",
16      "country": "example-country",
17      "bin": "example-bin",
18      "description": "example-description",
19      "isGlobal": true,
20      "settings": "example-settings"
21    }
22  ],
23  "meta": "example-meta"
24}

📝 Example Request

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

Get specific card product by ID

GET/card/product/{cardProductId}

Full URL

https://api.market.decenctype.com/card/product/{cardProductId}

🎯 Path Parameters

cardProductId (string) - ✅ Required: No description

Description: Get specific card product by ID

Operation ID: getCardProductById

Response Status:

✅ 200: Card product details

📋 Response Examples

response.json

1{
2  "cardProductId": "example-id",
3  "issuerId": "example-id",
4  "issuer": "example-issuer",
5  "channelId": "example-id",
6  "channel": "example-channel",
7  "merchantId": "example-id",
8  "merchant": "example-merchant",
9  "status": "example-status",
10  "product": "example-product",
11  "price": 1,
12  "currency": "example-currency",
13  "type": "example-type",
14  "cardDesign": "example-cardDesign",
15  "designId": "example-id",
16  "country": "example-country",
17  "bin": "example-bin",
18  "description": "example-description",
19  "isGlobal": true,
20  "settings": "example-settings"
21}

📝 Example Request

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

Update card product for merchant

PUT/card/product/{cardProductId}

Full URL

https://api.market.decenctype.com/card/product/{cardProductId}

🎯 Path Parameters

cardProductId (string) - ✅ Required: No description

📝 Request Body Parameters

Parameter	Type	Required	Description
`merchantId`	`string`	❌	商户 ID
`issuerId`	`string`	✅	发卡方ID
`channelId`	`string`	✅	渠道ID
`product`	`string`	✅	产品名称
`price`	`number`	✅	产品价格
`currency`	`string`	✅	货币类型
`type`	`string (PHYSICAL_CARD, VIRTUAL_CARD)`	✅	卡类型
`cardDesign`	`string`	❌	卡片设计
`country`	`string`	❌	国家代码
`bin`	`string`	❌	卡BIN
`description`	`string`	❌	描述信息
`isGlobal`	`boolean`	❌	是否全局可用 (默认: false)
`status`	`string (ACTIVE, INACTIVE, SUSPENDED)`	❌	卡产品状态 (默认: ACTIVE)
`settings`	`object`	❌	卡产品特定配置

Description: Update card product for merchant

Operation ID: updateCardProductForMerchant

Response Status:

✅ 200: Update card for merchant

📋 Response Examples

response.json

1{
2  "cardProductId": "example-id",
3  "issuerId": "example-id",
4  "issuer": "example-issuer",
5  "channelId": "example-id",
6  "channel": "example-channel",
7  "merchantId": "example-id",
8  "merchant": "example-merchant",
9  "status": "example-status",
10  "product": "example-product",
11  "price": 1,
12  "currency": "example-currency",
13  "type": "example-type",
14  "cardDesign": "example-cardDesign",
15  "designId": "example-id",
16  "country": "example-country",
17  "bin": "example-bin",
18  "description": "example-description",
19  "isGlobal": true,
20  "settings": "example-settings"
21}

📝 Example Request

curl -X PUT "https://api.market.decenctype.com/card/product/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "issuerId": "example-id",
  "channelId": "example-id",
  "product": "example-product",
  "price": 1,
  "currency": "example-currency",
  "type": "PHYSICAL_CARD"
}'

Delete card product for merchant

DELETE/card/product/{cardProductId}

Full URL

https://api.market.decenctype.com/card/product/{cardProductId}

🎯 Path Parameters

cardProductId (string) - ✅ Required: No description

Description: Delete card product for merchant

Operation ID: deleteCardProductForMerchant

Response Status:

✅ 200: Delete card for merchant

📋 Response Examples

response.json

1{
2  "cardProductId": "example-id",
3  "issuerId": "example-id",
4  "issuer": "example-issuer",
5  "channelId": "example-id",
6  "channel": "example-channel",
7  "merchantId": "example-id",
8  "merchant": "example-merchant",
9  "status": "example-status",
10  "product": "example-product",
11  "price": 1,
12  "currency": "example-currency",
13  "type": "example-type",
14  "cardDesign": "example-cardDesign",
15  "designId": "example-id",
16  "country": "example-country",
17  "bin": "example-bin",
18  "description": "example-description",
19  "isGlobal": true,
20  "settings": "example-settings"
21}

📝 Example Request

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

Update 3DS forwarding method for a card

PUT/card/{cardId}/3ds-forwarding

Full URL

https://api.market.decenctype.com/card/{cardId}/3ds-forwarding

🎯 Path Parameters

cardId (string) - ✅ Required: No description

📝 Request Body Parameters

Parameter	Type	Required	Description
`method`	`string (enroll, biometricEnroll, smsEnroll)`	✅	The ID of the card to update (默认: enroll)

Description: Update 3DS forwarding method for a card

Operation ID: update3dsForwarding

Response Status:

✅ 200: Success

This is used to update the 3DS forwarding method for a card, only support cards from Reap for now

📝 Example Request

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

Get cards by user ID

GET/card/user

Full URL

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

📋 Query Parameters

Parameter	Type	Required	Description
`sortField`	`string`	❌	排序字段
`sort`	`string`	❌	排序方式
`page`	`number`	❌	页码（从1开始）
`pageSize`	`number`	❌	每页条数
`userId`	`string`	✅	The ID of the user (示例: `123e4567-e89b-12d3-a456-426614174000`)
`status`	`string`	❌	The status of the card (示例: `ACTIVE`)

Description: Get cards by user ID

Operation ID: getCardsByUserId

Response Status:

✅ 200: 获取指定用户的所有卡片

📋 Response Examples

response.json

1{
2  "items": [
3    {
4      "cardId": "123e4567-e89b-12d3-a456-426614174000",
5      "orderCard": {},
6      "pan": "4111111111111111",
7      "expiryDate": "12/28",
8      "cvv": "123",
9      "pin": "0000",
10      "nameOnCard": "JOHN DOE",
11      "accountingMode": "fiat",
12      "fiatBalance": 1000.5,
13      "fiatAmountTopUp": 5000,
14      "fiatAmountSpent": 4000.5,
15      "fiatCurrency": "USD",
16      "cryptoBalance": 0.12345678,
17      "cryptoAmountTopUp": 1,
18      "cryptoAmountSpent": 0.87654321,
19      "type": "VIRTUAL_CARD",
20      "status": "ACTIVE",
21      "rejectedCount": 2,
22      "cardProductId": "PROD-VISA-PREMIUM",
23      "cardProduct": {},
24      "user": {},
25      "dailyVolume": 1500,
26      "monthlyVolume": 25000,
27      "monthlyTopup": 30000,
28      "securityMethod": "enroll",
29      "cardType": "Recurring",
30      "managementFeeCharged": true,
31      "isDelivery": true,
32      "physicalActivate": true,
33      "last4": "1234",
34      "accountBalance": 1000.5,
35      "amountTopUp": 5000,
36      "amountSpent": 4000.5,
37      "currency": "USD",
38      "balanceRatio": 0.8,
39      "accountingModeDisplay": "Fiat Currency",
40      "isCryptoMode": false,
41      "isFiatMode": true
42    }
43  ],
44  "meta": "example-meta"
45}

📝 Example Request

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

Find card by ID

GET/card/{cardId}

Full URL

https://api.market.decenctype.com/card/{cardId}

🎯 Path Parameters

cardId (string) - ✅ Required: No description

Description: Find card by ID

Operation ID: getCardById

Response Status:

✅ 200: Card details

📋 Response Examples

response.json

1{
2  "cardId": "123e4567-e89b-12d3-a456-426614174000",
3  "orderId": "ORD-2023-12345",
4  "orderCard": {},
5  "pan": "4111111111111111",
6  "expiryDate": "12/28",
7  "cvv": "123",
8  "pin": "0000",
9  "nameOnCard": "JOHN DOE",
10  "alias": "My Shopping Card",
11  "accountingMode": "fiat",
12  "fiatBalance": 1000.5,
13  "fiatAmountTopUp": 5000,
14  "fiatAmountSpent": 4000.5,
15  "fiatCurrency": "USD",
16  "cryptoBalance": 0.12345678,
17  "cryptoAmountTopUp": 1,
18  "cryptoAmountSpent": 0.87654321,
19  "cryptoCurrency": "BTC",
20  "type": "VIRTUAL_CARD",
21  "activateCode": "ACT123456",
22  "status": "ACTIVE",
23  "actionReason": "Customer request",
24  "rejectedCount": 2,
25  "cardProductId": "PROD-VISA-PREMIUM",
26  "cardProduct": {},
27  "userId": "usr_12345678",
28  "user": {},
29  "tagId": "123e4567-e89b-12d3-a456-426614174001",
30  "dailyVolume": 1500,
31  "monthlyVolume": 25000,
32  "monthlyTopup": 30000,
33  "securityMethod": "enroll",
34  "shipmentId": "SHIP-12345-6789",
35  "cardType": "Recurring",
36  "managementFeeCharged": true,
37  "isDelivery": true,
38  "physicalActivate": true,
39  "last4": "1234",
40  "accountBalance": 1000.5,
41  "amountTopUp": 5000,
42  "amountSpent": 4000.5,
43  "currency": "USD",
44  "balanceRatio": 0.8,
45  "accountingModeDisplay": "Fiat Currency",
46  "isCryptoMode": false,
47  "isFiatMode": true
48}

📝 Example Request

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

Search cards by various criteria

GET/card/search

Full URL

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

📋 Query Parameters

Parameter	Type	Required	Description
`sortField`	`string`	❌	排序字段
`sort`	`string`	❌	排序方式
`page`	`number`	❌	页码（从1开始）
`pageSize`	`number`	❌	每页条数
`status`	`string`	❌	The status of the card (示例: `ACTIVE`)
`search`	`string`	❌	Condition to search for, e.g. card number, card holder name, etc. (示例: `3456`)

Description: Search cards by various criteria

Operation ID: searchCards

Response Status:

✅ 200: 根据条件搜索卡片

📋 Response Examples

response.json

1{
2  "items": [
3    {
4      "cardId": "123e4567-e89b-12d3-a456-426614174000",
5      "orderCard": {},
6      "pan": "4111111111111111",
7      "expiryDate": "12/28",
8      "cvv": "123",
9      "pin": "0000",
10      "nameOnCard": "JOHN DOE",
11      "accountingMode": "fiat",
12      "fiatBalance": 1000.5,
13      "fiatAmountTopUp": 5000,
14      "fiatAmountSpent": 4000.5,
15      "fiatCurrency": "USD",
16      "cryptoBalance": 0.12345678,
17      "cryptoAmountTopUp": 1,
18      "cryptoAmountSpent": 0.87654321,
19      "type": "VIRTUAL_CARD",
20      "status": "ACTIVE",
21      "rejectedCount": 2,
22      "cardProductId": "PROD-VISA-PREMIUM",
23      "cardProduct": {},
24      "user": {},
25      "dailyVolume": 1500,
26      "monthlyVolume": 25000,
27      "monthlyTopup": 30000,
28      "securityMethod": "enroll",
29      "cardType": "Recurring",
30      "managementFeeCharged": true,
31      "isDelivery": true,
32      "physicalActivate": true,
33      "last4": "1234",
34      "accountBalance": 1000.5,
35      "amountTopUp": 5000,
36      "amountSpent": 4000.5,
37      "currency": "USD",
38      "balanceRatio": 0.8,
39      "accountingModeDisplay": "Fiat Currency",
40      "isCryptoMode": false,
41      "isFiatMode": true
42    }
43  ],
44  "meta": "example-meta"
45}

📝 Example Request

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

Update an existing card

PUT/card/{cardId}/update

Full URL

https://api.market.decenctype.com/card/{cardId}/update

🎯 Path Parameters

cardId (string) - ✅ Required: No description

📝 Request Body Parameters

Parameter	Type	Required	Description
`status`	`string`	❌

Description: Update an existing card

Operation ID: updateCard

Response Status:

✅ 200: Card updated successfully

📋 Response Examples

response.json

1{
2  "cardId": "123e4567-e89b-12d3-a456-426614174000",
3  "orderId": "ORD-2023-12345",
4  "orderCard": {},
5  "pan": "4111111111111111",
6  "expiryDate": "12/28",
7  "cvv": "123",
8  "pin": "0000",
9  "nameOnCard": "JOHN DOE",
10  "alias": "My Shopping Card",
11  "accountingMode": "fiat",
12  "fiatBalance": 1000.5,
13  "fiatAmountTopUp": 5000,
14  "fiatAmountSpent": 4000.5,
15  "fiatCurrency": "USD",
16  "cryptoBalance": 0.12345678,
17  "cryptoAmountTopUp": 1,
18  "cryptoAmountSpent": 0.87654321,
19  "cryptoCurrency": "BTC",
20  "type": "VIRTUAL_CARD",
21  "activateCode": "ACT123456",
22  "status": "ACTIVE",
23  "actionReason": "Customer request",
24  "rejectedCount": 2,
25  "cardProductId": "PROD-VISA-PREMIUM",
26  "cardProduct": {},
27  "userId": "usr_12345678",
28  "user": {},
29  "tagId": "123e4567-e89b-12d3-a456-426614174001",
30  "dailyVolume": 1500,
31  "monthlyVolume": 25000,
32  "monthlyTopup": 30000,
33  "securityMethod": "enroll",
34  "shipmentId": "SHIP-12345-6789",
35  "cardType": "Recurring",
36  "managementFeeCharged": true,
37  "isDelivery": true,
38  "physicalActivate": true,
39  "last4": "1234",
40  "accountBalance": 1000.5,
41  "amountTopUp": 5000,
42  "amountSpent": 4000.5,
43  "currency": "USD",
44  "balanceRatio": 0.8,
45  "accountingModeDisplay": "Fiat Currency",
46  "isCryptoMode": false,
47  "isFiatMode": true
48}

📝 Example Request

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

Lock a card

PUT/card/{cardId}/lock

Full URL

https://api.market.decenctype.com/card/{cardId}/lock

🎯 Path Parameters

cardId (string) - ✅ Required: No description

Description: Lock a card

Operation ID: lockCard

Response Status:

✅ 200: Card locked successfully

📋 Response Examples

response.json

1{
2  "cardId": "123e4567-e89b-12d3-a456-426614174000",
3  "orderId": "ORD-2023-12345",
4  "orderCard": {},
5  "pan": "4111111111111111",
6  "expiryDate": "12/28",
7  "cvv": "123",
8  "pin": "0000",
9  "nameOnCard": "JOHN DOE",
10  "alias": "My Shopping Card",
11  "accountingMode": "fiat",
12  "fiatBalance": 1000.5,
13  "fiatAmountTopUp": 5000,
14  "fiatAmountSpent": 4000.5,
15  "fiatCurrency": "USD",
16  "cryptoBalance": 0.12345678,
17  "cryptoAmountTopUp": 1,
18  "cryptoAmountSpent": 0.87654321,
19  "cryptoCurrency": "BTC",
20  "type": "VIRTUAL_CARD",
21  "activateCode": "ACT123456",
22  "status": "ACTIVE",
23  "actionReason": "Customer request",
24  "rejectedCount": 2,
25  "cardProductId": "PROD-VISA-PREMIUM",
26  "cardProduct": {},
27  "userId": "usr_12345678",
28  "user": {},
29  "tagId": "123e4567-e89b-12d3-a456-426614174001",
30  "dailyVolume": 1500,
31  "monthlyVolume": 25000,
32  "monthlyTopup": 30000,
33  "securityMethod": "enroll",
34  "shipmentId": "SHIP-12345-6789",
35  "cardType": "Recurring",
36  "managementFeeCharged": true,
37  "isDelivery": true,
38  "physicalActivate": true,
39  "last4": "1234",
40  "accountBalance": 1000.5,
41  "amountTopUp": 5000,
42  "amountSpent": 4000.5,
43  "currency": "USD",
44  "balanceRatio": 0.8,
45  "accountingModeDisplay": "Fiat Currency",
46  "isCryptoMode": false,
47  "isFiatMode": true
48}

📝 Example Request

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

Unlock a card

PUT/card/{cardId}/unlock

Full URL

https://api.market.decenctype.com/card/{cardId}/unlock

🎯 Path Parameters

cardId (string) - ✅ Required: No description

Description: Unlock a card

Operation ID: unlockCard

Response Status:

✅ 200: Card unlocked successfully

📋 Response Examples

response.json

1{
2  "cardId": "123e4567-e89b-12d3-a456-426614174000",
3  "orderId": "ORD-2023-12345",
4  "orderCard": {},
5  "pan": "4111111111111111",
6  "expiryDate": "12/28",
7  "cvv": "123",
8  "pin": "0000",
9  "nameOnCard": "JOHN DOE",
10  "alias": "My Shopping Card",
11  "accountingMode": "fiat",
12  "fiatBalance": 1000.5,
13  "fiatAmountTopUp": 5000,
14  "fiatAmountSpent": 4000.5,
15  "fiatCurrency": "USD",
16  "cryptoBalance": 0.12345678,
17  "cryptoAmountTopUp": 1,
18  "cryptoAmountSpent": 0.87654321,
19  "cryptoCurrency": "BTC",
20  "type": "VIRTUAL_CARD",
21  "activateCode": "ACT123456",
22  "status": "ACTIVE",
23  "actionReason": "Customer request",
24  "rejectedCount": 2,
25  "cardProductId": "PROD-VISA-PREMIUM",
26  "cardProduct": {},
27  "userId": "usr_12345678",
28  "user": {},
29  "tagId": "123e4567-e89b-12d3-a456-426614174001",
30  "dailyVolume": 1500,
31  "monthlyVolume": 25000,
32  "monthlyTopup": 30000,
33  "securityMethod": "enroll",
34  "shipmentId": "SHIP-12345-6789",
35  "cardType": "Recurring",
36  "managementFeeCharged": true,
37  "isDelivery": true,
38  "physicalActivate": true,
39  "last4": "1234",
40  "accountBalance": 1000.5,
41  "amountTopUp": 5000,
42  "amountSpent": 4000.5,
43  "currency": "USD",
44  "balanceRatio": 0.8,
45  "accountingModeDisplay": "Fiat Currency",
46  "isCryptoMode": false,
47  "isFiatMode": true
48}

📝 Example Request

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

Delete a card

DELETE/card/{cardId}/delete

Full URL

https://api.market.decenctype.com/card/{cardId}/delete

🎯 Path Parameters

cardId (string) - ✅ Required: No description

Description: Delete a card

Operation ID: deleteCard

Response Status:

✅ 200: Card deleted successfully

📋 Response Examples

response.json

1{
2  "cardId": "123e4567-e89b-12d3-a456-426614174000",
3  "orderId": "ORD-2023-12345",
4  "orderCard": {},
5  "pan": "4111111111111111",
6  "expiryDate": "12/28",
7  "cvv": "123",
8  "pin": "0000",
9  "nameOnCard": "JOHN DOE",
10  "alias": "My Shopping Card",
11  "accountingMode": "fiat",
12  "fiatBalance": 1000.5,
13  "fiatAmountTopUp": 5000,
14  "fiatAmountSpent": 4000.5,
15  "fiatCurrency": "USD",
16  "cryptoBalance": 0.12345678,
17  "cryptoAmountTopUp": 1,
18  "cryptoAmountSpent": 0.87654321,
19  "cryptoCurrency": "BTC",
20  "type": "VIRTUAL_CARD",
21  "activateCode": "ACT123456",
22  "status": "ACTIVE",
23  "actionReason": "Customer request",
24  "rejectedCount": 2,
25  "cardProductId": "PROD-VISA-PREMIUM",
26  "cardProduct": {},
27  "userId": "usr_12345678",
28  "user": {},
29  "tagId": "123e4567-e89b-12d3-a456-426614174001",
30  "dailyVolume": 1500,
31  "monthlyVolume": 25000,
32  "monthlyTopup": 30000,
33  "securityMethod": "enroll",
34  "shipmentId": "SHIP-12345-6789",
35  "cardType": "Recurring",
36  "managementFeeCharged": true,
37  "isDelivery": true,
38  "physicalActivate": true,
39  "last4": "1234",
40  "accountBalance": 1000.5,
41  "amountTopUp": 5000,
42  "amountSpent": 4000.5,
43  "currency": "USD",
44  "balanceRatio": 0.8,
45  "accountingModeDisplay": "Fiat Currency",
46  "isCryptoMode": false,
47  "isFiatMode": true
48}

📝 Example Request

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

Activate a card

PUT/card/{cardId}/activate

Full URL

https://api.market.decenctype.com/card/{cardId}/activate

🎯 Path Parameters

cardId (string) - ✅ Required: No description

📝 Request Body Parameters

Parameter	Type	Required	Description
`code`	`string`	✅	The activation code for the card
`pin`	`string`	❌	Pin code to set (最小长度: 4, 最大长度: 6)
`cardId`	`string`	✅

Description: Activate a card

Operation ID: activateCard

Response Status:

✅ 200: Card activated successfully

📋 Response Examples

response.json

1{
2  "cardId": "123e4567-e89b-12d3-a456-426614174000",
3  "orderId": "ORD-2023-12345",
4  "orderCard": {},
5  "pan": "4111111111111111",
6  "expiryDate": "12/28",
7  "cvv": "123",
8  "pin": "0000",
9  "nameOnCard": "JOHN DOE",
10  "alias": "My Shopping Card",
11  "accountingMode": "fiat",
12  "fiatBalance": 1000.5,
13  "fiatAmountTopUp": 5000,
14  "fiatAmountSpent": 4000.5,
15  "fiatCurrency": "USD",
16  "cryptoBalance": 0.12345678,
17  "cryptoAmountTopUp": 1,
18  "cryptoAmountSpent": 0.87654321,
19  "cryptoCurrency": "BTC",
20  "type": "VIRTUAL_CARD",
21  "activateCode": "ACT123456",
22  "status": "ACTIVE",
23  "actionReason": "Customer request",
24  "rejectedCount": 2,
25  "cardProductId": "PROD-VISA-PREMIUM",
26  "cardProduct": {},
27  "userId": "usr_12345678",
28  "user": {},
29  "tagId": "123e4567-e89b-12d3-a456-426614174001",
30  "dailyVolume": 1500,
31  "monthlyVolume": 25000,
32  "monthlyTopup": 30000,
33  "securityMethod": "enroll",
34  "shipmentId": "SHIP-12345-6789",
35  "cardType": "Recurring",
36  "managementFeeCharged": true,
37  "isDelivery": true,
38  "physicalActivate": true,
39  "last4": "1234",
40  "accountBalance": 1000.5,
41  "amountTopUp": 5000,
42  "amountSpent": 4000.5,
43  "currency": "USD",
44  "balanceRatio": 0.8,
45  "accountingModeDisplay": "Fiat Currency",
46  "isCryptoMode": false,
47  "isFiatMode": true
48}

📝 Example Request

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

Get card sensitive information

GET/card/{cardId}/sensitive-info

Full URL

https://api.market.decenctype.com/card/{cardId}/sensitive-info

🎯 Path Parameters

cardId (string) - ✅ Required: No description

Description: Get card sensitive information

Operation ID: getCardSensitiveInfo

Response Status:

✅ 200: Card sensitive information retrieved

📋 Response Examples

response.json

1{
2  "pan": "example-pan",
3  "cvv": "example-cvv",
4  "expiryDate": "example-expiryDate",
5  "pin": "example-pin",
6  "accessUrl": "https://example.com"
7}

📝 Example Request

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

Get card balance

GET/card/{cardId}/balance

Full URL

https://api.market.decenctype.com/card/{cardId}/balance

🎯 Path Parameters

cardId (string) - ✅ Required: No description

Description: Get card balance

Operation ID: getCardBalance

Response Status:

✅ 200: Card balance retrieved

📋 Response Examples

response.json

1{
2  "cardId": "123e4567-e89b-12d3-a456-426614174000",
3  "orderId": "ORD-2023-12345",
4  "orderCard": {},
5  "pan": "4111111111111111",
6  "expiryDate": "12/28",
7  "cvv": "123",
8  "pin": "0000",
9  "nameOnCard": "JOHN DOE",
10  "alias": "My Shopping Card",
11  "accountingMode": "fiat",
12  "fiatBalance": 1000.5,
13  "fiatAmountTopUp": 5000,
14  "fiatAmountSpent": 4000.5,
15  "fiatCurrency": "USD",
16  "cryptoBalance": 0.12345678,
17  "cryptoAmountTopUp": 1,
18  "cryptoAmountSpent": 0.87654321,
19  "cryptoCurrency": "BTC",
20  "type": "VIRTUAL_CARD",
21  "activateCode": "ACT123456",
22  "status": "ACTIVE",
23  "actionReason": "Customer request",
24  "rejectedCount": 2,
25  "cardProductId": "PROD-VISA-PREMIUM",
26  "cardProduct": {},
27  "userId": "usr_12345678",
28  "user": {},
29  "tagId": "123e4567-e89b-12d3-a456-426614174001",
30  "dailyVolume": 1500,
31  "monthlyVolume": 25000,
32  "monthlyTopup": 30000,
33  "securityMethod": "enroll",
34  "shipmentId": "SHIP-12345-6789",
35  "cardType": "Recurring",
36  "managementFeeCharged": true,
37  "isDelivery": true,
38  "physicalActivate": true,
39  "last4": "1234",
40  "accountBalance": 1000.5,
41  "amountTopUp": 5000,
42  "amountSpent": 4000.5,
43  "currency": "USD",
44  "balanceRatio": 0.8,
45  "accountingModeDisplay": "Fiat Currency",
46  "isCryptoMode": false,
47  "isFiatMode": true
48}

📝 Example Request

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

Get card available balance

GET/card/{cardId}/available-balance

Full URL

https://api.market.decenctype.com/card/{cardId}/available-balance

🎯 Path Parameters

cardId (string) - ✅ Required: No description

Description: Get card available balance

Operation ID: getCardAvailableBalance

Response Status:

✅ 200: Card available balance retrieved

📋 Response Examples

response.json

1{
2  "cardId": "123e4567-e89b-12d3-a456-426614174000",
3  "orderId": "ORD-2023-12345",
4  "orderCard": {},
5  "pan": "4111111111111111",
6  "expiryDate": "12/28",
7  "cvv": "123",
8  "pin": "0000",
9  "nameOnCard": "JOHN DOE",
10  "alias": "My Shopping Card",
11  "accountingMode": "fiat",
12  "fiatBalance": 1000.5,
13  "fiatAmountTopUp": 5000,
14  "fiatAmountSpent": 4000.5,
15  "fiatCurrency": "USD",
16  "cryptoBalance": 0.12345678,
17  "cryptoAmountTopUp": 1,
18  "cryptoAmountSpent": 0.87654321,
19  "cryptoCurrency": "BTC",
20  "type": "VIRTUAL_CARD",
21  "activateCode": "ACT123456",
22  "status": "ACTIVE",
23  "actionReason": "Customer request",
24  "rejectedCount": 2,
25  "cardProductId": "PROD-VISA-PREMIUM",
26  "cardProduct": {},
27  "userId": "usr_12345678",
28  "user": {},
29  "tagId": "123e4567-e89b-12d3-a456-426614174001",
30  "dailyVolume": 1500,
31  "monthlyVolume": 25000,
32  "monthlyTopup": 30000,
33  "securityMethod": "enroll",
34  "shipmentId": "SHIP-12345-6789",
35  "cardType": "Recurring",
36  "managementFeeCharged": true,
37  "isDelivery": true,
38  "physicalActivate": true,
39  "last4": "1234",
40  "accountBalance": 1000.5,
41  "amountTopUp": 5000,
42  "amountSpent": 4000.5,
43  "currency": "USD",
44  "balanceRatio": 0.8,
45  "accountingModeDisplay": "Fiat Currency",
46  "isCryptoMode": false,
47  "isFiatMode": true
48}

📝 Example Request

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

Charge a card (add funds)

POST/card/{cardId}/credit

Full URL

https://api.market.decenctype.com/card/{cardId}/credit

🎯 Path Parameters

cardId (string) - ✅ Required: No description

📝 Request Body Parameters

Parameter	Type	Required	Description
`amount`	`number`	✅	Amount to charge to the card (最小: 0.01)
`paymentMethod`	`string (crypto, fiat)`	❌	支付方式 for the charge
`description`	`string`	❌	Optional description for the charge

Description: Charge a card (add funds)

Operation ID: chargeCard

Response Status:

✅ 200: Card charged successfully
✅ 201: Success

📝 Example Request

curl -X POST "https://api.market.decenctype.com/card/example-id/credit" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "amount": 100.5
}'

Debit a card (deduct funds)

POST/card/{cardId}/debit

Full URL

https://api.market.decenctype.com/card/{cardId}/debit

🎯 Path Parameters

cardId (string) - ✅ Required: No description

📝 Request Body Parameters

Parameter	Type	Required	Description
`amount`	`number`	✅	Amount to debit from the card (最小: 0.01)
`description`	`string`	❌	Optional description for the debit

Description: Debit a card (deduct funds)

Operation ID: debitCard

Response Status:

✅ 200: Card debited successfully
✅ 201: Success

📝 Example Request

curl -X POST "https://api.market.decenctype.com/card/example-id/debit" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "amount": 50.25
}'

Transfer funds between cards

POST/card/transfer

Full URL

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

📝 Request Body Parameters

Parameter	Type	Required	Description
`fromCardId`	`string`	✅	ID of the source card
`toCardId`	`string`	✅	ID of the destination card
`amount`	`number`	✅	Amount to transfer (最小: 0.01)
`description`	`string`	❌	Optional description for the transfer

Description: Transfer funds between cards

Operation ID: transferCard

Response Status:

✅ 200: Card transfer completed successfully
✅ 201: Success

📝 Example Request

curl -X POST "https://api.market.decenctype.com/card/transfer" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "fromCardId": "123e4567-e89b-12d3-a456-426614174001",
  "toCardId": "123e4567-e89b-12d3-a456-426614174001",
  "amount": 75
}'

Test Sunrate API connection, IP whitelist and encryption algorithm

GET/card/sunrate/test-connection

Full URL

https://api.market.decenctype.com/card/sunrate/test-connection

🔐 Authentication: Required (see authentication section above)

Description: Test Sunrate API connection, IP whitelist and encryption algorithm

Operation ID: testSunrateConnection

Response Status:

✅ 200: Sunrate API test results

📝 Example Request

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

Test endpoint for decrypting a payload.

POST/card/sunrate/test-decrypt

Full URL

https://api.market.decenctype.com/card/sunrate/test-decrypt

📝 Request Body Parameters

Parameter	Type	Required	Description
`code`	`string`	✅	Response code from Sunrate API
`key`	`string`	❌	Encrypted AES key (Base64 encoded) if the responseBody is encrypted.
`msg`	`string`	✅	Response message from Sunrate API
`msgId`	`string`	✅	Unique message ID for the request/response pair
`responseBody`	`string`	❌	Encrypted response body (Base64 encoded) or plain JSON string.
`sign`	`string`	✅	Signature of the response parameters (Base64 encoded).
`timestamp`	`string`	✅	Timestamp of the response from Sunrate API (ISO 8601 format)
`requestBody`	`string`	❌	Encrypted response body (Base64 encoded) or plain JSON string.

Description: Test endpoint for decrypting a payload.

Operation ID: testDecrypt

Response Status:

✅ 201: Success

📝 Example Request

curl -X POST "https://api.market.decenctype.com/card/sunrate/test-decrypt" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "code": "000000",
  "msg": "成功",
  "msgId": "1928366834062913538",
  "sign": "kZYFOPXZewXszTAstzBGarpv9t4QgRWIwK/qMS6XdRYUoMvYFszXifY0i472WpE+rp+39Iz4cciLjoAxxTFlOwCLEa+82V4GqUIIWxOjMBSOfCrJJXGEk/cHCd4A7j2w/+iiWJVFAn8ggjzlmweuUHfraRKinCGZK6oX6v/cdsqMm6S0jWhrgCxFGTy9AKIILFJl0qzNPKobPG42/fJ+JSuwN525vbMET2omySRtJ+cDYLMAZ+HePB/MVR/6bx0J4kQPm591Gx8xnkV7MRWkC7bQPSG0373dmKXbihGiF6C8Y34rmo4Vsc2L9piOJD+J+2vwQyqkAsexCpZcGGpjsg==",
  "timestamp": "2025-05-30T16:24:15.220"
}'

PUT /card/sunrate/velocity-limits/{cardId}

PUT/card/sunrate/velocity-limits/{cardId}

Full URL

https://api.market.decenctype.com/card/sunrate/velocity-limits/{cardId}

🎯 Path Parameters

cardId (string) - ✅ Required: No description

📝 Request Body Parameters

Parameter	Type	Required	Description
`dailyMaxTrans`	`number`	❌	Daily maximum transaction count (最小: 0)
`monthlyMaxTrans`	`number`	❌	Monthly maximum transaction count (最小: 0)
`cycleMaxTrans`	`number`	❌	Cycle maximum transaction count (最小: 0)

Operation ID: updateSunrateVelocityLimits

Response Status:

✅ 200: Sunrate velocity limits updated successfully

📝 Example Request

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

Withdraw funds from a card

POST/card/{cardId}/withdraw

Full URL

https://api.market.decenctype.com/card/{cardId}/withdraw

🎯 Path Parameters

cardId (string) - ✅ Required: No description

📝 Request Body Parameters

Parameter	Type	Required	Description
`amount`	`number`	❌	Amount to withdraw from the card (最小: 0.01)
`description`	`string`	❌	Optional description for the withdrawal
`fullWithdrawal`	`boolean`	❌	Whether this is a full withdrawal (withdraw all balance)

Description: Withdraw funds from a card

Operation ID: withdrawFromCard

Response Status:

✅ 200: Card withdrawal completed successfully
✅ 201: Success

📝 Example Request

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

Respond to 3DS verification

POST/card/{cardId}/3ds-verification

Full URL

https://api.market.decenctype.com/card/{cardId}/3ds-verification

🎯 Path Parameters

cardId (string) - ✅ Required: No description

📝 Request Body Parameters

Parameter	Type	Required	Description
`initiateActionId`	`string`	✅	The ID of the initiate action
`approve`	`boolean`	✅	Whether to approve the 3DS verification

Description: Respond to 3DS verification

Operation ID: respond3DSVerification

Response Status:

✅ 200: 3DS verification completed successfully
✅ 201: Success

📝 Example Request

curl -X POST "https://api.market.decenctype.com/card/example-id/3ds-verification" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "initiateActionId": "123e4567-e89b-12d3-a456-426614174000",
  "approve": true
}'

Update card PIN

PUT/card/{cardId}/pin

Full URL

https://api.market.decenctype.com/card/{cardId}/pin

🎯 Path Parameters

cardId (string) - ✅ Required: Card ID

📝 Request Body Parameters

Parameter	Type	Required	Description
`pin`	`string`	✅	New PIN for the card (4-12 digits) (最小长度: 4, 最大长度: 12)

Description: Update card PIN

Operation ID: updateCardPin

Response Status:

✅ 200: Card PIN updated successfully

📋 Response Examples

response.json

1{
2  "before": "example-before",
3  "after": "example-after"
4}

📝 Example Request

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

Bind card by last 4 digits and activation code

POST/card/bind

Full URL

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

📝 Request Body Parameters

Parameter	Type	Required	Description
`last4`	`string`	✅	Last 4 digits of the card PAN (最小长度: 4, 最大长度: 4)
`activateCode`	`string`	✅	Card activation code
`pin`	`string`	❌	Card PIN (optional) (最小长度: 4, 最大长度: 6)

Description: Bind card by last 4 digits and activation code

Operation ID: bindCardByLast4Digits

Response Status:

✅ 200: Card bound successfully
✅ 201: Success

📋 Response Examples

response.json

1{
2  "cardId": "123e4567-e89b-12d3-a456-426614174000",
3  "orderId": "ORD-2023-12345",
4  "orderCard": {},
5  "pan": "4111111111111111",
6  "expiryDate": "12/28",
7  "cvv": "123",
8  "pin": "0000",
9  "nameOnCard": "JOHN DOE",
10  "alias": "My Shopping Card",
11  "accountingMode": "fiat",
12  "fiatBalance": 1000.5,
13  "fiatAmountTopUp": 5000,
14  "fiatAmountSpent": 4000.5,
15  "fiatCurrency": "USD",
16  "cryptoBalance": 0.12345678,
17  "cryptoAmountTopUp": 1,
18  "cryptoAmountSpent": 0.87654321,
19  "cryptoCurrency": "BTC",
20  "type": "VIRTUAL_CARD",
21  "activateCode": "ACT123456",
22  "status": "ACTIVE",
23  "actionReason": "Customer request",
24  "rejectedCount": 2,
25  "cardProductId": "PROD-VISA-PREMIUM",
26  "cardProduct": {},
27  "userId": "usr_12345678",
28  "user": {},
29  "tagId": "123e4567-e89b-12d3-a456-426614174001",
30  "dailyVolume": 1500,
31  "monthlyVolume": 25000,
32  "monthlyTopup": 30000,
33  "securityMethod": "enroll",
34  "shipmentId": "SHIP-12345-6789",
35  "cardType": "Recurring",
36  "managementFeeCharged": true,
37  "isDelivery": true,
38  "physicalActivate": true,
39  "last4": "1234",
40  "accountBalance": 1000.5,
41  "amountTopUp": 5000,
42  "amountSpent": 4000.5,
43  "currency": "USD",
44  "balanceRatio": 0.8,
45  "accountingModeDisplay": "Fiat Currency",
46  "isCryptoMode": false,
47  "isFiatMode": true
48}

response.json

1{
2  "cardId": "123e4567-e89b-12d3-a456-426614174000",
3  "orderId": "ORD-2023-12345",
4  "orderCard": {},
5  "pan": "4111111111111111",
6  "expiryDate": "12/28",
7  "cvv": "123",
8  "pin": "0000",
9  "nameOnCard": "JOHN DOE",
10  "alias": "My Shopping Card",
11  "accountingMode": "fiat",
12  "fiatBalance": 1000.5,
13  "fiatAmountTopUp": 5000,
14  "fiatAmountSpent": 4000.5,
15  "fiatCurrency": "USD",
16  "cryptoBalance": 0.12345678,
17  "cryptoAmountTopUp": 1,
18  "cryptoAmountSpent": 0.87654321,
19  "cryptoCurrency": "BTC",
20  "type": "VIRTUAL_CARD",
21  "activateCode": "ACT123456",
22  "status": "ACTIVE",
23  "actionReason": "Customer request",
24  "rejectedCount": 2,
25  "cardProductId": "PROD-VISA-PREMIUM",
26  "cardProduct": {},
27  "userId": "usr_12345678",
28  "user": {},
29  "tagId": "123e4567-e89b-12d3-a456-426614174001",
30  "dailyVolume": 1500,
31  "monthlyVolume": 25000,
32  "monthlyTopup": 30000,
33  "securityMethod": "enroll",
34  "shipmentId": "SHIP-12345-6789",
35  "cardType": "Recurring",
36  "managementFeeCharged": true,
37  "isDelivery": true,
38  "physicalActivate": true,
39  "last4": "1234",
40  "accountBalance": 1000.5,
41  "amountTopUp": 5000,
42  "amountSpent": 4000.5,
43  "currency": "USD",
44  "balanceRatio": 0.8,
45  "accountingModeDisplay": "Fiat Currency",
46  "isCryptoMode": false,
47  "isFiatMode": true
48}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/card/bind" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "last4": "1234",
  "activateCode": "ABC123456"
}'