Currencies

Retrieve the list of currencies supported by the Stream API.

Endpoint

GET /currencies

Description

Fetch all available currencies that can be used for pricing and value declarations throughout the API. Each currency has a unique ID that should be used when specifying monetary values.

Request Example

curl -X GET \
  https://orders-api-production.vatit-stream.com/client_api/v2/currencies \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -H "Content-Type: application/json"

Success Response (200 OK)

[
  {
    "id": "USD",
    "name": "US Dollar"
  },
  {
    "id": "EUR",
    "name": "Euro"
  },
  {
    "id": "GBP",
    "name": "British Pound"
  },
  {
    "id": "ZAR",
    "name": "South African Rand"
  },
  {
    "id": "CAD",
    "name": "Canadian Dollar"
  },
  {
    "id": "AUD",
    "name": "Australian Dollar"
  },
  {
    "id": "JPY",
    "name": "Japanese Yen"
  }
]

Response Fields

Field	Type	Description
id	string	Three-letter currency code (ISO 4217 standard)
name	string	Full name of the currency

Usage in Other Endpoints

The currency id returned from this endpoint should be used in the following places:

Quote Requests

When specifying the value of goods in quote requests:

{
  "value_of_goods": "600.00",
  "value_of_goods_currency_id": "ZAR",
  "purpose_of_shipment_id": 8
}

Line Items

When pricing information is returned in estimates and invoices:

{
  "line_items": [
    {
      "description": "Fuel Surcharge",
      "cost": 469.95,
      "currency_id": "USD"
    }
  ]
}

HS Codes

When specifying the cost of goods for customs declaration:

{
  "hs_codes": [
    {
      "code": "100322",
      "cost": "100.00",
      "description": "networking equipment",
      "quantity": 5,
      "weight": 1.1,
      "currency_id": "USD",
      "country_id": 5
    }
  ]
}

Common Currency Codes

Currency	Code	Usage
US Dollar	USD	International shipping, default pricing
Euro	EUR	European Union transactions
British Pound	GBP	United Kingdom transactions
South African Rand	ZAR	South African transactions
Canadian Dollar	CAD	Canadian transactions
Australian Dollar	AUD	Australian transactions
Japanese Yen	JPY	Japanese transactions

Important Notes

• Currency Codes: Always use the three-letter currency id (string) in API requests
• ISO 4217 Standard: All currency codes follow the international ISO 4217 standard
• Decimal Places: Different currencies have different decimal place conventions (e.g., JPY typically has no decimal places, while most others use 2)
• Exchange Rates: Stream handles currency conversion internally based on current exchange rates
• Pricing Currency: Final shipping costs may be quoted in the currency of the shipping provider
• Value Declarations: Customs value declarations should use the currency of the invoice

Monetary Value Format

When specifying monetary values in API requests:

• Use string format for precise decimal representation
• Include appropriate decimal places for the currency
• Do not include currency symbols or thousands separators

Examples

{
  "value_of_goods": "1250.00",
  "value_of_goods_currency_id": "USD"
}

{
  "cost": "150000",
  "currency_id": "JPY"
}

Error Responses

401 Unauthorized

Access token is missing or invalid.

Caching Recommendations

Currency data is relatively stable and can be cached in your application to reduce API calls. Consider refreshing your currency cache daily or weekly to ensure you have the most up-to-date information.

Compliance Notes

• Customs Declarations: Ensure you use the appropriate currency for customs value declarations based on the origin or destination country requirements
• Invoice Currency: When providing commercial invoices, the currency should match the currency used in your invoice documentation
• Regulatory Requirements: Some countries have specific requirements for currency declarations in shipping documentation