curl https://api.zbdpay.com/api/v1/currencies \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"message": "Currencies retrieved.",
"data": {
"currencies": [
{
"currency": "USD",
"type": "fiat",
"name": "US Dollar",
"precision": 2,
"convertible": true
},
{
"currency": "GEMS",
"type": "virtual",
"name": "Gems",
"precision": 2,
"convertible": true,
"icon_url": "https://cdn.zbdpay.com/virtual-currencies/gems.png",
"project_ids": ["prj_1", "prj_2"]
}
]
},
"error": null
}
Currencies
List Currencies
List the currencies your program uses, fiat and your own.
GET
/
api
/
v1
/
currencies
curl https://api.zbdpay.com/api/v1/currencies \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"message": "Currencies retrieved.",
"data": {
"currencies": [
{
"currency": "USD",
"type": "fiat",
"name": "US Dollar",
"precision": 2,
"convertible": true
},
{
"currency": "GEMS",
"type": "virtual",
"name": "Gems",
"precision": 2,
"convertible": true,
"icon_url": "https://cdn.zbdpay.com/virtual-currencies/gems.png",
"project_ids": ["prj_1", "prj_2"]
}
]
},
"error": null
}
Returns every currency your program can use: fiat currencies like
Each currency has the same fields as Get a Currency.
USD, and virtual currencies you’ve defined with ZBD.
Configuration
Header Parameters
string
required
Your ZBD API key.
Query Parameters
string
Only
fiat or only virtual currencies.string
Only currencies linked to this project.
curl https://api.zbdpay.com/api/v1/currencies \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"message": "Currencies retrieved.",
"data": {
"currencies": [
{
"currency": "USD",
"type": "fiat",
"name": "US Dollar",
"precision": 2,
"convertible": true
},
{
"currency": "GEMS",
"type": "virtual",
"name": "Gems",
"precision": 2,
"convertible": true,
"icon_url": "https://cdn.zbdpay.com/virtual-currencies/gems.png",
"project_ids": ["prj_1", "prj_2"]
}
]
},
"error": null
}
Errors
| HTTP | code | When |
|---|---|---|
401 | unauthorized | The API key is missing or invalid |
Was this page helpful?