API Endpoints Reference

Complete reference of all VCCPool API endpoints, including Product, Wallet, Trade, Card, and Digital Wallet APIs. Each endpoint documentation includes request headers, parameters, and response formats with examples.

API Endpoints

Product

GET /product/list

Get products list.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Query Parameters

Parameter	Type	Required	Description
page	integer	No	Page number for pagination
limit	integer	No	Number of items per page

Response

{
    "code": 200,
    "msg": "success",
    "data": {
        "list": [
            {
                "id": 1,
                "bin": "text",
                "type": 1,
                "cuy": 840,
                "mode": 1,
                "area": "text",
                "sort": 0,
                "status": 1
            }
        ],
        "count": 1,
        "page": 1,
        "limit": 1,
        "pages": 1
    }
}

Wallet

GET /wallet/list

Get wallet list.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Query Parameters

Parameter	Type	Required	Description
page	integer	No	Page number for pagination
limit	integer	No	Number of items per page

Response

{
    "code": 200,
    "msg": "success",
    "data": {
        "list": [
            {
                "id": 1,
                "amt": 20.2,
                "cuy": 840
            }
        ],
        "count": 1,
        "page": 1,
        "limit": 1,
        "pages": 1
    }
}

GET /wallet/flow/list

Get wallet flow list.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Query Parameters

Parameter	Type	Required	Description
wid	integer	No	Wallet id
page	integer	No	Page number for pagination
limit	integer	No	Number of items per page

Response

{
    "code": 200,
    "msg": "success",
    "data": {
        "list": [
            {
                "uid": 4,
                "wid": 4,
                "osn": "feeffdc5f2ca763aa9d4055029219ec15fba5b2b423971d0cf77eb5f2374084f",
                "type": 1,
                "cuy": 840,
                "amt": "99.00",
                "balance": "99.00",
                "mark": "recharge fee:1",
                "created_at": "2024-07-12 09:02:00"
            }
        ],
        "count": 1,
        "page": 1,
        "limit": 1,
        "pages": 1
    }
}

Trade

GET /trade/list

Get trade list.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Query Parameters

Parameter	Type	Required	Description
osn	string	No	Trade osn
page	integer	No	Page number for pagination
limit	integer	No	Number of items per page

Response

{
    "code": 200,
    "msg": "success",
    "data": {
        "list": [
            {
                "id": 30,
                "osn": "t_6690f130ee044",
                "uid": 4,
                "wid": 4,
                "pid": 1,
                "cid": 8,
                "type": 2,
                "action": 2,
                "amt": "11.00",
                "fee": "0.33",
                "cuy": 840,
                "status": 1,
                "complete_at": "2024-07-12 09:02:42",
                "created_at": "2024-07-12 09:02:40"
            }
        ],
        "count": 1,
        "page": 1,
        "limit": 1,
        "pages": 1
    }
}

POST /trade/create

Creates a new card.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Request Body

{
    "pid": 1,
    "amt": 18.2,
    "wid": 1,
    "osn": "t_123456"
}

Response

{
    "code": 200,
    "msg": "success"
}

POST /trade/recharge

Recharge card.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Request Body

{
    "cid": 1,
    "amt": 18.2,
    "wid": 1,
    "osn": "t_123456"
}

Response

{
    "code": 200,
    "msg": "success"
}

Card

GET /card/list

Get card list.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Query Parameters

Parameter	Type	Required	Description
page	integer	No	Page number for pagination
limit	integer	No	Number of items per page

Response

{
    "code": 200,
    "msg": "success",
    "data": {
        "list": [
            {
                "id": 1000,
                "uid": 4,
                "pid": 2,
                "no": "428813******8317",
                "amt": "10.00",
                "limit": "10.00",
                "status": 2,
                "mark": null,
                "created_at": "2025-03-15 06:02:55"
            }
        ],
        "count": 1,
        "page": 1,
        "limit": 1,
        "pages": 1
    }
}

GET /card/info

Get card info.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Query Parameters

Parameter	Type	Required	Description
id	integer	Yes	Card id

Response

{
    "code": 200,
    "msg": "success",
    "data": {
        "id": 1,
        "pid": 1,
        "no": "42881******14723",
        "amt": 320.68,
        "limit": 6000,
        "status": 0
    }
}

GET /card/pin/resend

Resend card pin and info.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Query Parameters

Parameter	Type	Required	Description
id	integer	Yes	Card id

Response

{
    "code": 200,
    "msg": "success"
}

GET /card/balance

Get card balance.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Query Parameters

Parameter	Type	Required	Description
id	integer	Yes	Card id

Response

{
    "code": 200,
    "msg": "success",
    "data": {
        "amt": 100,
        "limit": 100
    }
}

GET /card/cancel

Cancel card.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Query Parameters

Parameter	Type	Required	Description
id	integer	Yes	Card id

Response

{
    "code": 200,
    "msg": "success"
}

GET /card/cycle/list

Get card list.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Query Parameters

Parameter	Type	Required	Description
id	integer	Yes	Card id
page	integer	No	Page number for pagination
limit	integer	No	Number of items per page

Response

{
    "code": 200,
    "msg": "success",
    "data": {
        "list": [
            {
                "cid": 1,
                "type": 0,
                "rid": 1,
                "mark": "mark",
                "created_at": "2024-06-06 16:16:16"
            }
        ],
        "count": 1,
        "page": 1,
        "limit": 1,
        "pages": 1
    }
}

GET /card/trade/list

Get card trade list.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Query Parameters

Parameter	Type	Required	Description
cid	integer	Yes	Card id
page	integer	No	Page number for pagination
limit	integer	No	Number of items per page

Response

{
    "code": 200,
    "msg": "success",
    "data": {
        "list": [
            {
                "id": 8813,
                "sn": "ct_66f2481b93453",
                "uid": 4,
                "pid": 2,
                "cid": 1105,
                "osn": "4103834",
                "origin_sn": "",
                "merchant": "APPLE.COM/BILL",
                "type": 1,
                "no": "4288130025963034",
                "auth_amt": "1.00",
                "auth_cuy": 840,
                "auth_at": "2024-09-24 05:03:20",
                "trade_amt": "1.00",
                "trade_cuy": 840,
                "trade_at": "2024-09-24 05:03:20",
                "settle_amt": "1.00",
                "settle_fee": "0.00",
                "settle_cuy": 840,
                "settle_at": "2024-09-24 05:03:20",
                "result": 40,
                "mark": "This transaction was denied by the system. For more details: support@vccpool.com",
                "created_at": "2024-09-24 05:03:23",
                "updated_at": "2024-09-24 05:03:23"
            }
        ],
        "count": 1,
        "page": 1,
        "limit": 1,
        "pages": 1
    }
}

GET /card/trade/info

Get card trade info.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Query Parameters

Parameter	Type	Required	Description
id	integer	Yes	Card trade id

Response

{
    "code": 200,
    "msg": "success",
    "data": {
        "id": 8813,
        "sn": "ct_66f2481b93453",
        "uid": 4,
        "pid": 2,
        "cid": 1105,
        "osn": "4103834",
        "origin_sn": "",
        "merchant": "APPLE.COM/BILL",
        "type": 1,
        "no": "4288130025963034",
        "auth_amt": "1.00",
        "auth_cuy": 840,
        "auth_at": "2024-09-24 05:03:20",
        "trade_amt": "1.00",
        "trade_cuy": 840,
        "trade_at": "2024-09-24 05:03:20",
        "settle_amt": "1.00",
        "settle_fee": "0.00",
        "settle_cuy": 840,
        "settle_at": "2024-09-24 05:03:20",
        "result": 40,
        "mark": "This transaction was denied by the system. For more details: support@vccpool.com",
        "created_at": "2024-09-24 05:03:23",
        "updated_at": "2024-09-24 05:03:23"
    }
}

Digital Wallet

GET /tron/generate

Generate tron address.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Response

{
    "code": 200,
    "msg": "success",
    "data": {
        "id": 20,
        "address": "1234567890"
    }
}

GET /tron/balance

Get tron address balance.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Query Parameters

Parameter	Type	Required	Description
id	integer	Yes	Tron address id

Response

{
    "code": 200,
    "msg": "success",
    "data": {
        "amt": 200
    }
}

GET /tron/recharge

Transfer digital currency to the platform wallet. After initiation, please wait for the system to complete automatically, which typically takes about 2 minutes.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Query Parameters

Parameter	Type	Required	Description
id	integer	Yes	Tron address id
wid	integer	Yes	Wallet id

Response

{
    "code": 200,
    "msg": "success"
}

Entities

Comprehensive reference of all data entities and types used in the VCCPool API, including Currency codes, Product specifications, Card details, and Wallet information. Each entity includes detailed field descriptions, status codes, and type definitions.

Webhooks

Webhook allows you to receive real-time notifications about events in your account. You can subscribe to specific events and receive notifications at your configured endpoint.