API reference

List currencies

GET/currencies

Lists the currencies the API accepts and the number of decimal places of each currency's minor unit.

Required scope: none
Idempotency-Key: Not used
Environments: Sandbox and Live

Example request

curl "https://api.gloresend.com/sandbox/v1/currencies" \
  -H "Authorization: Bearer $GLORESEND_TEST_KEY"

Response · 200

200 · application/json

{
  "object": "list",
  "data": [
    {
      "code": "USD",
      "name": "US Dollar",
      "exponent": 2
    },
    {
      "code": "XOF",
      "name": "West African CFA franc",
      "exponent": 0
    }
  ]
}

Response fields

objectenumrequired
"list"
dataarray of objectrequired
data[].codeenumrequired
ISO 4217 currency code.
"USD", "EUR", "GBP", "XOF", "XAF", "NGN", "GHS", "KES"
data[].namestringrequired
data[].exponentintegerrequired

Errors

401authentication_requiredNo credentials were supplied. Send Authorization: Bearer <api key>.
401invalid_api_keyThe API key is unknown, revoked or expired.
401environment_mismatchThe API key belongs to a different environment than the base URL you called. Sandbox keys (gs_test_) only work against the Sandbox base URL, Live keys (gs_live_) only against the Live base URL.
429rate_limitedToo many requests. Wait for the number of seconds in the Retry-After header.