Definir nominal de fallback

PATCH

/api/nominais/fallback

Autenticação

Sessão do painel OU Authorization: Bearer {{api_key}}.

Definir nominal de fallback

Define a nominal de fallback técnico: se a nominal ativa estiver temporariamente indisponível no momento de emitir uma cobrança, o sistema usa a de fallback para não derrubar a operação.

Body

Campo	Tipo	Descrição
`slug`	string	`slug` da nominal a usar como fallback.
`slug`	`null`	Envie `{ "slug": null }` para limpar o fallback.

Resposta

200 OK. Ao definir: { ok: true, fallback: { slug, displayName } }. Ao limpar: { ok: true, fallback: null }.

Erros

HTTP	`code`	Quando
400	—	`slug` ausente (e diferente de `null`).
404	—	Nominal não encontrada para o `slug`.
422	`NOMINAL_NOT_USABLE`	A nominal informada não está disponível para a sua conta.

Exemplos cURL

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200

application/json

Bodyapplication/json

🟠404

🟠422

🟠400

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/nominais/fallback' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
  "slug": "padrao"
}'

Response Example

200 - Definido (200)

{
  "ok": true,
  "fallback": {
    "slug": "padrao",
    "displayName": "Padrão"
  }
}

Modificado em 2026-07-14 04:02:21

Página anterior

Trocar de nominal

Próxima página

Estado da troca em andamento

Definir nominal de fallback

Autenticação#

Definir nominal de fallback#

Body#

Resposta#

Erros#

Exemplos cURL#

Requisição

Respostas

Autenticação

Definir nominal de fallback

Body

Resposta

Erros

Exemplos cURL