[Admin] Criar nominal
POST
/api/admin/nominais
Autenticação
Authorization: Bearer {{admin_api_key}}.[Admin] Criar nominal
Body
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
slug | string | sim | 2–40 chars, kebab-case ([a-z0-9-]). Único. |
displayName | string | sim | 1–60 chars, nome de exibição. |
backingAcquirer | string | sim | Campo interno — identifica o trilho de lastro. Não exibir a clientes finais. |
feePixIn, feePixInType, feePixInFixed | number/enum | não | Taxa-base de entrada. type: PERCENT | FIXED | PERCENT_PLUS_FIXED. |
feeWithdrawal, feeWithdrawalType, feeWithdrawalFixed | number/enum | não | Taxa-base de saque. |
isPremium | boolean | não | Marca como premium. |
isActive | boolean | não | Ativa/inativa no catálogo. |
isDefault | boolean | não | Define como nominal padrão (desmarca as demais atomicamente). |
sortOrder | number | não | Ordem de exibição. |
Resposta
201 Created com { nominal: { ... } }.Erros
| HTTP | code | Quando |
|---|---|---|
| 400 | — | Body inválido (Zod). |
| 401 / 403 | — | Sem credencial ADMIN. |
| 409 | SLUG_TAKEN | Já existe nominal com o slug informado. |
Exemplo cURL
Requisição
Parâmetros Header
Parâmetros Bodyapplication/json
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/admin/nominais' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"slug": "hub",
"displayName": "Hub",
"backingAcquirer": "INTERNAL_RAIL_A",
"feePixIn": 2.49,
"feePixInType": "PERCENT",
"feeWithdrawal": 1.49,
"feeWithdrawalType": "PERCENT",
"isPremium": true,
"isActive": true,
"isDefault": false,
"sortOrder": 1
}'Response Response Example
201 - Criada (201)
{
"nominal": {
"id": "{{nominal_id}}",
"slug": "hub",
"displayName": "Hub",
"feePixIn": 2.49,
"feeWithdrawal": 1.49,
"isPremium": true,
"isActive": true,
"isDefault": false,
"sortOrder": 1
}
}Modificado em 2026-07-14 04:02:21