# API do Bifrost Crypto

> Versão em Markdown da documentação pública da API v1 da Bifrost Crypto, para agentes de IA e geradores de código. Mesmo conteúdo das páginas HTML, gerado da mesma fonte, sem navegação nem estilo.
>
> Versão HTML: https://bifrostcrypto.com/pt-BR/docs
> Arquivos relacionados: [ai.md](https://bifrostcrypto.com/ai/pt-BR.md) · [Postman](https://bifrostcrypto.com/postman-collection.json) · [OpenAPI](https://bifrostcrypto.com/openapi.json) · [llms.txt](https://bifrostcrypto.com/llms.txt)
> Outros idiomas: [English](https://bifrostcrypto.com/ai/en/introduction.md) · [Español](https://bifrostcrypto.com/ai/es/introduction.md) · [Français](https://bifrostcrypto.com/ai/fr/introduction.md)
> API v1 · contrato alterado pela última vez em 2026-10-10

Referência completa da API Bifrost Crypto V1. Integre pagamentos cripto multi-chain na sua plataforma em minutos.

## Autenticação

Todas as rotas requerem o header com sua chave API privada: `X-Bifrost-Invoke`

## URL Base

Todas as requisições são feitas para: `https://bridge.bifrostcrypto.com`

## Formato

Todos os corpos de requisição e resposta usam formato JSON: `Content-Type: application/json`

## Início Rápido

Cada requisição da API deve incluir sua chave privada no header:

```bash
curl -X GET "https://bridge.bifrostcrypto.com/v1/balances" \
  -H "X-Bifrost-Invoke: YOUR_API_KEY"
```

## Especificação OpenAPI

A referência completa num arquivo OpenAPI 3.1. Importe no Postman ou no Insomnia para testar os endpoints, ou gere um cliente na sua linguagem. Ela é gerada da mesma fonte desta documentação.

https://bifrostcrypto.com/openapi.json

## Datas e horários

Campos de data e hora (created_at, updated_at, expires_at e os demais) vêm como YYYY-MM-DD HH:MM:SS em UTC−03:00, sem o offset no valor. Os filtros de data (date_from, date_to) são lidos no mesmo offset. Duas exceções: o limite diário de payout de uma chave de API reinicia às 00:00 UTC, e os webhooks de endereço fixo enviam timestamp em ISO 8601 com o offset incluído.

## Redes Suportadas

Valores aceitos no campo network, sem diferenciar maiúsculas na criação. Na criação também são aceitos apelidos comuns (erc20, bsc, trc20, matic…), convertidos para estes nomes; veja Network aliases nos endpoints de criação. Respostas, webhooks e filtros de listagem usam sempre os nomes abaixo. Quais tokens estão disponíveis em cada rede é informado por GET /v1/summary/tokens.

`Bitcoin`, `Ethereum`, `BinanceSmartChain`, `Tron`, `Solana`, `Ripple`, `Cardano`, `Dogecoin`, `Polygon`, `Avalanche`, `ArbitrumOne`, `Celo`, `Optimism`, `Arbitrum`, `Cronos`, `Base`, `BitcoinCash`, `BitcoinSV`, `BitcoinGold`, `Monero`, `OpBnb`, `Xlayer`, `Litecoin`, `TON`

## Códigos de Status HTTP

| Código | Significado |
| --- | --- |
| `200` | Sucesso |
| `201` | Criado - endereço fixo atribuído |
| `207` | Multi-Status - lote de payout com itens recusados |
| `400` | Requisição Inválida - parâmetros inválidos |
| `401` | Não Autorizado - chave de API ou assinatura ausente ou inválida |
| `403` | Proibido - sem permissão para este recurso |
| `404` | Não Encontrado - recurso ou rota inexistente |
| `409` | Conflito - pedido ainda em andamento ou limite atingido |
| `422` | Não Processável - type não suportado |
| `429` | Muitas Requisições - cota ou limite de falhas de autenticação |
| `500` | Erro do Servidor |
| `502` | Bad Gateway - um serviço do qual dependemos falhou. Tente novamente mais tarde. |
| `503` | Serviço Indisponível - tente mais tarde |

## Categorias da API

- **Pagamentos (Payout)** (3 endpoints): Crie e gerencie saques cripto. Até 50 por lote.
- **Depósitos (Payin)** (3 endpoints): Gere carteiras de depósito e rastreie pagamentos recebidos.
- **Consultas** (6 endpoints): Verifique saldos, extratos, tokens e informações da conta.
- **Preços** (2 endpoints): Obtenha taxas de conversão em tempo real e moedas disponíveis.
- **Endereços Fixos** (5 endpoints): Atribua e gerencie endereços de depósito permanentes por cliente.