Reference data
External read API for the countries and currencies accepted on billing catalog writes.
Reference data
Prefix: /api/v1/external
See Overview for authentication, pagination, and errors.
Billing catalog writes take names, not UUIDs, for currency and country. Use these two read endpoints to discover the values your tenant accepts before sending an account address or a rate card.
Unlike the billing lists, these default to a page size of 100.
Endpoint summary
| Method | Path |
|---|---|
| GET | /countries |
| GET | /currencies |
List countries
GET /api/v1/external/countries?page=0&size=100&q=united
Authorization: Bearer YOUR_API_TOKEN| Query | Description |
|---|---|
page | 0-based page index (default 0) |
size | Page size (default 100) |
q | Optional search on country name and ISO codes |
Any of name, alpha2Code, or alpha3Code is accepted as the country value on an account address.
Response 200 — ApiResponse + Spring Page. See Overview.
{
"requestId": "req-1",
"success": true,
"status": 200,
"errors": [],
"data": {
"content": [
{
"__type__": "Country",
"Id": "aaaaaaa1-0000-4000-8000-000000000001",
"Name": "United States",
"Code": "840",
"Alpha2Code": "US",
"Alpha3Code": "USA"
}
],
"totalElements": 2,
"size": 100,
"number": 0
}
}List currencies
GET /api/v1/external/currencies?page=0&size=100&q=usd
Authorization: Bearer YOUR_API_TOKEN| Query | Description |
|---|---|
page | 0-based page index (default 0) |
size | Page size (default 100) |
q | Optional search on currency code and name |
Either code or name is accepted wherever a currency value is expected — service and contract headers, rate-card bodies, the {currency} path segment on rate-card routes, payments, and wallets.
curl -sS "https://YOUR_TENANT_HOST/api/v1/external/currencies?q=usd" \
-H "Authorization: Bearer YOUR_API_TOKEN"Response 200
{
"content": [
{
"id": "bbbbbbb1-0000-4000-8000-000000000001",
"code": "USD",
"name": "US Dollar",
"symbol": "$"
}
],
"page": 0,
"size": 100,
"totalElements": 1,
"totalPages": 1
}