Listar nominais disponíveis
GET
/api/nominais
Autenticação
Authorization: Bearer {{api_key}}.Listar nominais disponíveis
Resposta — data: NominalItem[]
| Campo | Tipo | Descrição |
|---|---|---|
slug | string | Identificador estável da nominal (ex.: hub, padrao). Use no POST /select. |
displayName | string | Nome amigável para exibição (ex.: "Hub", "Padrão"). |
isPremium | boolean | Nominal premium (pode exigir liberação). |
usable | boolean | true se você pode selecioná-la agora. Se false, ela aparece mas está bloqueada para a sua conta. |
feePixIn | number | Taxa efetiva de entrada (PIX recebido) aplicada à sua conta nesta nominal. |
feeWithdrawal | number | Taxa efetiva de saque nesta nominal. |
isCurrent | boolean | true na nominal atualmente ativa da sua conta. |
isFallback | boolean | true na nominal definida como fallback (veja PATCH /fallback). |
Erros
| HTTP | Quando |
|---|---|
| 401 | Sessão/API key ausente ou inválida. |
Exemplo cURL
Requisição
Parâmetros Header
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/nominais' \
--header 'Authorization: Bearer <token>'Response Response Example
200 - Sucesso (200)
{
"data": [
{
"slug": "padrao",
"displayName": "Padrão",
"isPremium": false,
"usable": true,
"feePixIn": 2.99,
"feeWithdrawal": 1.99,
"isCurrent": true,
"isFallback": false
},
{
"slug": "hub",
"displayName": "Hub",
"isPremium": true,
"usable": true,
"feePixIn": 2.49,
"feeWithdrawal": 1.49,
"isCurrent": false,
"isFallback": true
}
]
}Modificado em 2026-07-14 04:02:21