Estado da troca em andamento

GET

/api/nominais/switch

Autenticação

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

Estado da troca em andamento

Retorna o estado da troca de nominal mais recente. Use para acompanhar um PENDING_DRAIN até concluir (a consulta também reconcilia o estado caso o saque de dreno já tenha liquidado).

Resposta — `switch`

Se não houver troca registrada: { switch: null }. Caso contrário:

Campo	Tipo	Descrição
`id`	string	Id da troca.
`status`	string	`PENDING_DRAIN` (drenando) \| `COMPLETED` (concluída) \| `FAILED` (falhou).
`toSlug`	string \| null	`slug` da nominal de destino.
`toDisplayName`	string \| null	Nome de exibição da nominal de destino.
`reason`	string \| null	Motivo, quando `FAILED`.

Erros

HTTP	Quando
401	Sessão/API key ausente ou inválida.

Exemplo 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

Respostas

🟢200

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/nominais/switch' \
--header 'Authorization: Bearer <token>'

Response Example

{
  "switch": {
    "id": "{{switch_id}}",
    "status": "PENDING_DRAIN",
    "toSlug": "hub",
    "toDisplayName": "Hub",
    "reason": null
  }
}

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

Página anterior

Definir nominal de fallback

Próxima página

[Admin] Catálogo completo de nominais

Estado da troca em andamento

Autenticação#

Estado da troca em andamento#

Resposta — switch#

Erros#

Exemplo cURL#

Requisição

Respostas

Autenticação

Estado da troca em andamento

Resposta — `switch`

Erros

Exemplo cURL