API Entities & Data Types
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.
Currency
CurrencyCode
| Code | Symbol | Description |
|---|---|---|
| 000 | Unknown | |
| 784 | د.إ | UAE Dirham |
| 971 | ؋ | Afghan Afghani |
| 051 | ֏ | Armenian Dram |
| 532 | ƒ | Netherlands Antillean Guilder |
| 973 | Kz | Angolan Kwanza |
| 032 | $ | Argentine Peso |
| 036 | A$ | Australian Dollar |
| 533 | ƒ | Aruban Florin |
| 944 | ₼ | Azerbaijani Manat |
| 977 | KM | Bosnia-Herzegovina Convertible Mark |
| 052 | $ | Barbadian Dollar |
| 050 | ৳ | Bangladeshi Taka |
| 975 | лв | Bulgarian Lev |
| 108 | FBu | Burundian Franc |
| 060 | $ | Bermudian Dollar |
| 096 | $ | Brunei Dollar |
| 068 | Bs. | Bolivian Boliviano |
| 986 | R$ | Brazilian Real |
| 044 | $ | Bahamian Dollar |
| 064 | Nu. | Bhutanese Ngultrum |
| 072 | P | Botswanan Pula |
| 933 | Br | Belarusian Ruble |
| 084 | $ | Belize Dollar |
| 124 | C$ | Canadian Dollar |
| 976 | FC | Congolese Franc |
| 756 | CHF | Swiss Franc |
| 152 | $ | Chilean Peso |
| 156 | ¥ | Chinese Yuan |
| 170 | $ | Colombian Peso |
| 188 | ₡ | Costa Rican Colón |
| 192 | $MN | Cuban Peso |
| 132 | Esc | Cape Verdean Escudo |
| 203 | Kč | Czech Koruna |
| 262 | Fdj | Djiboutian Franc |
| 208 | kr | Danish Krone |
| 214 | RD$ | Dominican Peso |
| 012 | د.ج | Algerian Dinar |
| 818 | £ | Egyptian Pound |
| 232 | Nfk | Eritrean Nakfa |
| 230 | Br | Ethiopian Birr |
| 978 | € | Euro |
| 242 | $ | Fijian Dollar |
| 238 | £ | Falkland Islands Pound |
| 234 | kr | Faroese Króna |
| 826 | £ | British Pound |
| 981 | ₾ | Georgian Lari |
| 831 | £ | Guernsey Pound |
| 936 | ₵ | Ghanaian Cedi |
| 292 | £ | Gibraltar Pound |
| 270 | D | Gambian Dalasi |
| 324 | FG | Guinean Franc |
| 320 | Q | Guatemalan Quetzal |
| 328 | $ | Guyanese Dollar |
| 344 | HK$ | Hong Kong Dollar |
| 340 | L | Honduran Lempira |
| 191 | kn | Croatian Kuna |
| 332 | G | Haitian Gourde |
| 348 | Ft | Hungarian Forint |
| 360 | Rp | Indonesian Rupiah |
| 376 | ₪ | Israeli New Shekel |
| 833 | £ | Manx Pound |
| 356 | ₹ | Indian Rupee |
| 368 | ع.د | Iraqi Dinar |
| 364 | ﷼ | Iranian Rial |
| 352 | kr | Icelandic Króna |
| 388 | $ | Jamaican Dollar |
| 400 | د.ا | Jordanian Dinar |
| 392 | ¥ | Japanese Yen |
| 404 | KSh | Kenyan Shilling |
| 417 | сом | Kyrgystani Som |
| 116 | ៛ | Cambodian Riel |
| 174 | CF | Comorian Franc |
| 410 | ₩ | South Korean Won |
| 414 | د.ك | Kuwaiti Dinar |
| 136 | $ | Cayman Islands Dollar |
| 398 | ₸ | Kazakhstani Tenge |
| 418 | ₭ | Laotian Kip |
| 422 | ل.ل | Lebanese Pound |
| 144 | Rs | Sri Lankan Rupee |
| 430 | $ | Liberian Dollar |
| 426 | L | Lesotho Loti |
| 434 | ل.د | Libyan Dinar |
| 504 | د.م. | Moroccan Dirham |
| 498 | L | Moldovan Leu |
| 969 | Ar | Malagasy Ariary |
| 807 | ден | Macedonian Denar |
| 104 | K | Myanmar Kyat |
| 496 | ₮ | Mongolian Tugrik |
| 446 | MOP$ | Macanese Pataca |
| 929 | UM | Mauritanian Ouguiya |
| 480 | ₨ | Mauritian Rupee |
| 462 | ރ. | Maldivian Rufiyaa |
| 454 | MK | Malawian Kwacha |
| 484 | $ | Mexican Peso |
| 458 | RM | Malaysian Ringgit |
| 943 | MT | Mozambican Metical |
| 516 | $ | Namibian Dollar |
| 566 | ₦ | Nigerian Naira |
| 558 | C$ | Nicaraguan Córdoba |
| 578 | kr | Norwegian Krone |
| 524 | ₨ | Nepalese Rupee |
| 554 | $ | New Zealand Dollar |
| 512 | ر.ع. | Omani Rial |
| 590 | B/. | Panamanian Balboa |
| 604 | S/ | Peruvian Sol |
| 598 | K | Papua New Guinean Kina |
| 608 | ₱ | Philippine Peso |
| 586 | ₨ | Pakistani Rupee |
| 985 | zł | Polish Złoty |
| 600 | ₲ | Paraguayan Guarani |
| 634 | ر.ق | Qatari Rial |
| 946 | lei | Romanian Leu |
| 941 | дин | Serbian Dinar |
| 643 | ₽ | Russian Ruble |
| 646 | FRw | Rwandan Franc |
| 682 | ر.س | Saudi Riyal |
| 090 | $ | Solomon Islands Dollar |
| 690 | ₨ | Seychellois Rupee |
| 938 | £ | Sudanese Pound |
| 752 | kr | Swedish Krona |
| 702 | $ | Singapore Dollar |
| 654 | £ | St. Helena Pound |
| 694 | Le | Sierra Leonean Leone |
| 706 | Sh | Somali Shilling |
| 968 | $ | Surinamese Dollar |
| 728 | £ | South Sudanese Pound |
| 930 | Db | São Tomé & Príncipe Dobra |
| 760 | £ | Syrian Pound |
| 748 | L | Swazi Lilangeni |
| 764 | ฿ | Thai Baht |
| 972 | SM | Tajikistani Somoni |
| 934 | T | Turkmenistani Manat |
| 788 | د.ت | Tunisian Dinar |
| 776 | T$ | Tongan Paʻanga |
| 949 | ₺ | Turkish Lira |
| 780 | $ | Trinidad & Tobago Dollar |
| 901 | NT$ | New Taiwan Dollar |
| 834 | TSh | Tanzanian Shilling |
| 980 | ₴ | Ukrainian Hryvnia |
| 800 | USh | Ugandan Shilling |
| 840 | $ | US Dollar |
| 858 | $U | Uruguayan Peso |
| 860 | soʻm | Uzbekistani Som |
| 928 | Bs.S | Venezuelan Bolívar |
| 704 | ₫ | Vietnamese Dong |
| 548 | VT | Vanuatu Vatu |
| 882 | WS$ | Samoan Tala |
| 950 | FCFA | Central African CFA Franc |
| 951 | $ | East Caribbean Dollar |
| 952 | CFA | West African CFA Franc |
| 953 | ₣ | CFP Franc |
| 886 | ﷼ | Yemeni Rial |
| 710 | R | South African Rand |
| 967 | ZK | Zambian Kwacha |
| 932 | $ | Zimbabwean Dollar |
Product
ProductStatus
| Value | Description |
|---|---|
| 1 | Active |
| 2 | Maintenance Plan |
| 3 | Maintenance in Progress |
| 4 | Forbidden |
| 5 | Active Ready |
ProductMode
| Value | Description |
|---|---|
| 1 | Visa Credit Card |
| 2 | Mastercard Credit Card |
| 10 | Visa Prepaid Card |
| 11 | Mastercard Prepaid Card |
ProductType
| Value | Description |
|---|---|
| 1 | Physical |
| 2 | Virtual |
| 3 | Fixed |
Product Entity
| Field | Type | Description |
|---|---|---|
| id | number | Product ID |
| bin | string | BIN number |
| osn | string | Order serial number |
| type | ProductType | Product type |
| cuy | number | Currency code |
| mode | ProductMode | Product mode |
| area | string | Area code |
| sort | number | Sort order |
| inventory | number | Inventory quantity |
| status | ProductStatus | Product status |
Card
CardStatus
| Value | Description |
|---|---|
| 1 | Unactivated |
| 2 | Active |
| 4 | Closing |
| 5 | Closed |
| 6 | Freeze |
CardTradeType
| Value | Description |
|---|---|
| 1 | Authorize |
| 2 | Refund |
| 3 | Fee |
| 5 | One Time Password |
| 6 | AVS Check |
| 10 | Automated Teller Machine |
| 20 | Service |
CardTradeResult
| Value | Description |
|---|---|
| 0 | Pending |
| 1 | Success |
| 2 | Reversal |
| 5 | Settled |
| 40 | Fail |
Card Entity
| Field | Type | Description |
|---|---|---|
| id | number | Card ID |
| uid | number | User ID |
| pid | number | Product ID |
| no | string | Card number |
| amt | string | Amount |
| limit | string | Limit amount |
| osn | string | Order serial number |
| status | CardStatus | Card status |
| mark | string | null | Remark |
| created_at | string | Created time |
| expiry | string | Expiry date |
| cvv | string | CVV code |
CardTrade Entity
| Field | Type | Description |
|---|---|---|
| id | number | Trade ID |
| sn | string | Serial number |
| uid | number | User ID |
| pid | number | Product ID |
| cid | number | Card ID |
| osn | string | Order serial number |
| origin_sn | string | Original serial number |
| merchant | string | Merchant name |
| type | CardTradeType | Trade type |
| no | string | Card number |
| auth_amt | string | Authorization amount |
| auth_cuy | string | Authorization currency |
| auth_at | string | Authorization time |
| trade_amt | string | Trade amount |
| trade_cuy | string | Trade currency |
| trade_at | string | Trade time |
| settle_amt | string | Settlement amount |
| settle_fee | string | Settlement fee |
| settle_cuy | string | Settlement currency |
| settle_at | string | Settlement time |
| result | CardTradeResult | Trade result |
| mark | string | Remark |
| created_at | string | Created time |
| updated_at | string | Updated time |
Wallet
WalletFlowType
| Value | Description |
|---|---|
| 1 | User Recharge |
| 2 | Finance Recharge |
| 10 | Finance Reversal |
| 11 | Lock |
| 12 | Unlock |
| 20 | Trade Pay |
| 21 | Trade Refund |
| 30 | Product |
| 40 | Risk Punish |
| 41 | Risk Punish Reversal |
| 50 | Service |
Wallet Entity
| Field | Type | Description |
|---|---|---|
| id | number | Wallet ID |
| uid | number | User ID |
| cuy | string | Currency code |
| amt | string | Amount |
WalletFlow Entity
| Field | Type | Description |
|---|---|---|
| uid | number | User ID |
| wid | number | Wallet ID |
| osn | string | Order serial number |
| type | WalletFlowType | Flow type |
| cuy | string | Currency code |
| amt | string | Amount |
| balance | string | Balance |
| mark | string | Remark |
| created_at | string | Created time |
Error Handling
Reference guide for VCCPool API error responses and handling. Includes HTTP status codes, error messages, and response formats for common error scenarios such as authentication failures, invalid parameters, and server errors.
Endpoints
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.