Skip to main content
GET
/
api
/
partner
/
v1
/
fiat
cURL
curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v1/fiat
{
  "status": "ok",
  "data": [
    {
      "id": "12a121ad-cbea-4ec4-9e0a-5c861e528bba",
      "name": "mexican_peso",
      "symbol": "MXN",
      "country": "MX",
      "logoUrl": "https://s3.amazon/eth-logo.png",
      "isActive": true,
      "order": 1,
      "settings": {
        "id": "12a121ad-cbea-4ec4-9e0a-5c861e528bba",
        "minOrderAmount": 1,
        "maxOrderAmount": 1,
        "orderAmountSuggestions": 80000,
        "createdAt": "2024-05-07T19:35:48.537Z",
        "updatedAt": "2024-05-07T19:35:48.537Z"
      }
    }
  ]
}
Retrieves a comprehensive list of all fiat currencies configured in the system, regardless of their active status. This endpoint is publicly accessible and does not require authentication.

​
Response body

  • data (array) - The list of all fiat currencies.
    • id (string) - Fiat currency id, used to create an on/off ramp transaction.
    • name (string) - Name of the currency.
    • symbol (string) - Fiat currency symbol according to ISO.
    • country (string) - The symbol of the country for the fiat.
    • logoUrl (string) - Url where the fiat currency logo is stored.
    • isActive (boolean) - Indicates whether the currency is available for on/off ramp operations.
    • settings (object) - Extra information that of the current fiat.
      • id (string) - Fiat setting id.
      • minOrderAmount (number) - Min amount required to create an off/ramp order.
      • maxOrderAmount (number) - Max amount allowed to create an off/on ramp order.
      • orderAmountSuggestions (array, number) - Suggested quantities for the current fiat.
      • createdAt (string) - Date where this setting was created.
      • updatedAt (string) - Date where this setting was updated.

​
Example

JSON
{
  "data": [
    {
      "id": "dd4f872b-3221-4a20-8eff-80149278ec35",
      "name": "mexican_peso",
      "symbol": "MXN",
      "country": "MX",
      "logoUrl": "https://vectorflags.s3.amazonaws.com/flags/mx-circle-01.png",
      "isActive": true,
      "settings": {
        "id": "2fff0500-8bba-4634-92f2-d5c4682ce346",
        "minOrderAmount": 1,
        "maxOrderAmount": 250000,
        "orderAmountSuggestions": [
          500,
          1000,
          5000,
          10000
        ],
        "createdAt": "2024-06-03T16:08:44.637Z",
        "updatedAt": "2024-06-03T16:08:44.637Z"
      }
    }
  ]
}

​
Use Cases

  • On-Ramp Transactions: When users want to convert fiat to cryptocurrency, this module allows your application to display all available fiat options.
  • Off-Ramp Transactions: In cases where users are converting cryptocurrency back to fiat, this module ensures that all relevant fiat currencies are available for selection.
  • Currency Display: Use this endpoint to keep the fiat currency options up-to-date across different parts of your application, such as payment forms, transaction history, or user settings.

Response

200 - application/json

Retrieves all fiat currencies (either active or not) @warning This method is the same as the one in the original controller, but in this case, it is use for documentation purposes

​
status
string
Example:

"ok"

​
data
object[]