Consultar moedas

Lista as moedas da loja, o catálogo de moedas da plataforma e consulta uma moeda pelo código.

A lista da loja traz as moedas já cadastradas (habilitadas ou não). O catálogo traz todas as moedas que a plataforma conhece e que você pode habilitar.

Listar as moedas da loja

Ordenadas por position e depois por code. Sem paginação.

GET/api/v1/admin/currenciesAdmin

Lista as moedas da loja

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/currencies" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Moedas

json

{
  "items": [
    {
      "code": "BRL",
      "symbol": "R$",
      "decimals": 2,
      "decimalSep": ",",
      "thousandsSep": ".",
      "symbolAfter": false,
      "symbolSpace": true,
      "enabled": true,
      "isPrimary": true,
      "exchangeRate": 1,
      "position": 0,
      "autoUpdate": false,
      "autoSource": "ptax",
      "marginPct": 0,
      "roundingRule": "none"
    },
    {
      "code": "EUR",
      "symbol": "€",
      "decimals": 2,
      "decimalSep": ",",
      "thousandsSep": ".",
      "symbolAfter": true,
      "symbolSpace": true,
      "enabled": true,
      "isPrimary": false,
      "exchangeRate": 0.1708,
      "position": 2,
      "autoUpdate": false,
      "autoSource": "ptax",
      "marginPct": 0,
      "roundingRule": "none"
    }
  ]
}

Campos da resposta

itemsarray

Moedas cadastradas, com os campos abaixo.

codestring

Código ISO 4217.

symbolstring

Símbolo.

decimalsinteger

Casas decimais.

decimalSepstring

Separador decimal.

thousandsSepstring

Separador de milhar.

symbolAfterboolean

true escreve o símbolo depois do valor.

symbolSpaceboolean

Espaço entre símbolo e valor.

enabledboolean

Habilitada para o cliente.

isPrimaryboolean

É a moeda principal.

exchangeRatenumber

Unidades desta moeda por 1 da principal.

positioninteger

Ordem de exibição.

autoUpdateboolean

Atualização automática ligada.

autoSourcestring

ptaxawesomeapi

ptax ou awesomeapi.

marginPctnumber

Margem de proteção em %, aplicada sobre a cotação.

roundingRulestring

noneend_90integer

none, end_90 ou integer.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não tem o privilégio `manage_settings` (administrador raiz e administrador total passam).	`{"error":"insufficient privileges","required":"manage_settings"}`

Listar o catálogo

GET/api/v1/admin/currencies/catalogAdmin

Lista o catálogo de moedas

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/currencies/catalog" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Catálogo

json

{
  "items": [
    {
      "code": "GBP",
      "symbol": "£",
      "nameEn": "British Pound",
      "namePt": "Libra Esterlina",
      "decimals": 2,
      "decimalSep": ".",
      "thousandsSep": ",",
      "symbolAfter": false,
      "symbolSpace": false,
      "status": "A",
      "createdAt": "2026-05-15T11:19:39Z",
      "updatedAt": "2026-05-15T11:19:39Z"
    }
  ]
}

Campos da resposta

itemsarray

Moedas do catálogo.

items[].codestring

Código para usar em POST /currencies.

items[].nameEnstring

Nome em inglês.

items[].namePtstring

Nome em português.

items[].statusstring

A = disponível.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não tem o privilégio `manage_settings` (administrador raiz e administrador total passam).	`{"error":"insufficient privileges","required":"manage_settings"}`

Consultar uma moeda

GET/api/v1/admin/currencies/{code}Admin

Consulta uma moeda

Parâmetros de caminho

codestringobrigatório

Código da moeda, por exemplo EUR. Maiúsculas ou minúsculas.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/currencies/EUR" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Moeda

json

{
  "code": "EUR",
  "symbol": "€",
  "decimals": 2,
  "decimalSep": ",",
  "thousandsSep": ".",
  "symbolAfter": true,
  "symbolSpace": true,
  "enabled": true,
  "isPrimary": false,
  "exchangeRate": 0.1708,
  "position": 2,
  "autoUpdate": false,
  "autoSource": "ptax",
  "marginPct": 0,
  "roundingRule": "none"
}

Campos da resposta

codestring

Código ISO 4217.

symbolstring

Símbolo.

decimalsinteger

Casas decimais.

decimalSepstring

Separador decimal.

thousandsSepstring

Separador de milhar.

symbolAfterboolean

true escreve o símbolo depois do valor.

symbolSpaceboolean

Espaço entre símbolo e valor.

enabledboolean

Habilitada para o cliente.

isPrimaryboolean

É a moeda principal.

exchangeRatenumber

Unidades desta moeda por 1 da principal.

positioninteger

Ordem de exibição.

autoUpdateboolean

Atualização automática ligada.

autoSourcestring

ptaxawesomeapi

ptax ou awesomeapi.

marginPctnumber

Margem de proteção em %, aplicada sobre a cotação.

roundingRulestring

noneend_90integer

none, end_90 ou integer.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não tem o privilégio `manage_settings` (administrador raiz e administrador total passam).	`{"error":"insufficient privileges","required":"manage_settings"}`
404	A moeda não está cadastrada na loja.	`{"error":"currency not enabled on this tenant"}`

Veja também

Moedas

API atual/Referência completa/Moedas

Consultar moedas

Lista as moedas da loja, o catálogo de moedas da plataforma e consulta uma moeda pelo código.

A lista da loja traz as moedas já cadastradas (habilitadas ou não). O catálogo traz todas as moedas que a plataforma conhece e que você pode habilitar.

Listar as moedas da loja

Ordenadas por position e depois por code. Sem paginação.

GET/api/v1/admin/currenciesAdmin

Lista as moedas da loja

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/currencies" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Moedas

json

{
  "items": [
    {
      "code": "BRL",
      "symbol": "R$",
      "decimals": 2,
      "decimalSep": ",",
      "thousandsSep": ".",
      "symbolAfter": false,
      "symbolSpace": true,
      "enabled": true,
      "isPrimary": true,
      "exchangeRate": 1,
      "position": 0,
      "autoUpdate": false,
      "autoSource": "ptax",
      "marginPct": 0,
      "roundingRule": "none"
    },
    {
      "code": "EUR",
      "symbol": "€",
      "decimals": 2,
      "decimalSep": ",",
      "thousandsSep": ".",
      "symbolAfter": true,
      "symbolSpace": true,
      "enabled": true,
      "isPrimary": false,
      "exchangeRate": 0.1708,
      "position": 2,
      "autoUpdate": false,
      "autoSource": "ptax",
      "marginPct": 0,
      "roundingRule": "none"
    }
  ]
}

Campos da resposta

itemsarray

Moedas cadastradas, com os campos abaixo.

codestring

Código ISO 4217.

symbolstring

Símbolo.

decimalsinteger

Casas decimais.

decimalSepstring

Separador decimal.

thousandsSepstring

Separador de milhar.

symbolAfterboolean

true escreve o símbolo depois do valor.

symbolSpaceboolean

Espaço entre símbolo e valor.

enabledboolean

Habilitada para o cliente.

isPrimaryboolean

É a moeda principal.

exchangeRatenumber

Unidades desta moeda por 1 da principal.

positioninteger

Ordem de exibição.

autoUpdateboolean

Atualização automática ligada.

autoSourcestring

ptaxawesomeapi

ptax ou awesomeapi.

marginPctnumber

Margem de proteção em %, aplicada sobre a cotação.

roundingRulestring

noneend_90integer

none, end_90 ou integer.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não tem o privilégio `manage_settings` (administrador raiz e administrador total passam).	`{"error":"insufficient privileges","required":"manage_settings"}`

Listar o catálogo

GET/api/v1/admin/currencies/catalogAdmin

Lista o catálogo de moedas

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/currencies/catalog" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Catálogo

json

{
  "items": [
    {
      "code": "GBP",
      "symbol": "£",
      "nameEn": "British Pound",
      "namePt": "Libra Esterlina",
      "decimals": 2,
      "decimalSep": ".",
      "thousandsSep": ",",
      "symbolAfter": false,
      "symbolSpace": false,
      "status": "A",
      "createdAt": "2026-05-15T11:19:39Z",
      "updatedAt": "2026-05-15T11:19:39Z"
    }
  ]
}

Campos da resposta

itemsarray

Moedas do catálogo.

items[].codestring

Código para usar em POST /currencies.

items[].nameEnstring

Nome em inglês.

items[].namePtstring

Nome em português.

items[].statusstring

A = disponível.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não tem o privilégio `manage_settings` (administrador raiz e administrador total passam).	`{"error":"insufficient privileges","required":"manage_settings"}`

Consultar uma moeda

GET/api/v1/admin/currencies/{code}Admin

Consulta uma moeda

Parâmetros de caminho

codestringobrigatório

Código da moeda, por exemplo EUR. Maiúsculas ou minúsculas.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/currencies/EUR" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Moeda

json

{
  "code": "EUR",
  "symbol": "€",
  "decimals": 2,
  "decimalSep": ",",
  "thousandsSep": ".",
  "symbolAfter": true,
  "symbolSpace": true,
  "enabled": true,
  "isPrimary": false,
  "exchangeRate": 0.1708,
  "position": 2,
  "autoUpdate": false,
  "autoSource": "ptax",
  "marginPct": 0,
  "roundingRule": "none"
}

Campos da resposta

codestring

Código ISO 4217.

symbolstring

Símbolo.

decimalsinteger

Casas decimais.

decimalSepstring

Separador decimal.

thousandsSepstring

Separador de milhar.

symbolAfterboolean

true escreve o símbolo depois do valor.

symbolSpaceboolean

Espaço entre símbolo e valor.

enabledboolean

Habilitada para o cliente.

isPrimaryboolean

É a moeda principal.

exchangeRatenumber

Unidades desta moeda por 1 da principal.

positioninteger

Ordem de exibição.

autoUpdateboolean

Atualização automática ligada.

autoSourcestring

ptaxawesomeapi

ptax ou awesomeapi.

marginPctnumber

Margem de proteção em %, aplicada sobre a cotação.

roundingRulestring

noneend_90integer

none, end_90 ou integer.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não tem o privilégio `manage_settings` (administrador raiz e administrador total passam).	`{"error":"insufficient privileges","required":"manage_settings"}`
404	A moeda não está cadastrada na loja.	`{"error":"currency not enabled on this tenant"}`

Veja também

Moedas