Atlas API

Integre pagamentos PIX na sua aplicacao em minutos.

Base URLhttps://api.atlasdao.info/api/v1

Introducao

A Atlas API permite que voce integre pagamentos PIX diretamente na sua aplicacao. Crie transacoes, links de pagamento, receba webhooks e consulte estatisticas.

Base URL

Todas as requisicoes devem ser feitas para:

https://api.atlasdao.info/api/v1

Versionamento

A API e versionada via URL (/api/v1). Mudancas que quebram compatibilidade resultarao em uma nova versao.

Documentacao para LLMs

Esta documentacao tambem esta disponivel em formato plain-text otimizado para LLMs e agentes de IA em /devs/llms.md.

Autenticacao

Todas as requisicoes (exceto health check) precisam de autenticacao via API Key.

Inclua sua API Key no header X-API-Key de cada requisicao:

cURL
curl https://api.atlasdao.info/api/v1/external/profile \
  -H "X-API-Key: atlas_sua_chave_aqui"

Como obter sua API Key:

  1. Crie uma conta no painel Atlas
  2. Ative o Modo Comercio em Configuracoes
  3. Acesse Configuracoes > API e gere sua chave

Seguranca

Nunca exponha sua API Key em codigo frontend ou repositorios publicos. Use variaveis de ambiente no servidor.

Inicio Rapido

Crie seu primeiro pagamento PIX em 3 passos.

1. Obtenha sua API Key

Crie uma conta, ative o modo comercio e gere uma API Key em Configuracoes > API.

2. Crie uma transacao PIX

cURL
curl -X POST https://api.atlasdao.info/api/v1/external/pix/create \
  -H "X-API-Key: SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 99.90,
    "description": "Pagamento pedido #123",
    "depixAddress": "lq1qq...",
    "merchantOrderId": "ORD-2025-12345",
    "webhook": {
      "url": "https://meusite.com/webhook",
      "events": ["transaction.paid", "transaction.failed"],
      "secret": "minha-chave-secreta-min-16-chars"
    }
  }'

3. Exiba o QR Code ao cliente

A resposta inclui qrCode (copia-e-cola) e qrCodeImage (base64 PNG). Mostre ao cliente para pagamento.

Webhook opcional

Configure um webhook no campo webhook para receber notificacao automatica quando o pagamento for confirmado.

Limites e Taxas

Rate limits e taxas da API Atlas.

Rate Limits

  • Por minuto100 requisicoes
  • Por dia10.000 requisicoes

Exceder o limite retorna status 429.

Taxas

  • Taxa por PIX recebidoR$ 0,99
  • Links de pagamentoGratis
  • API KeyGratis

Settlement

Pagamentos sao liquidados em D+0 (instantaneo) ou D+1, dependendo do plano. O campo settlement no webhook indica o tipo.

GEThttps://api.atlasdao.info/api/v1/external/healthPublico

Verifica se a API esta online e funcionando. Este endpoint e publico e nao requer autenticacao.

Exemplo

cURL
curl https://api.atlasdao.info/api/v1/external/health

Resposta

JSON
{
  "status": "ok",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "version": "1.0.0",
  "service": "Atlas External API"
}

Codigos de status

200API esta online e funcionando
GEThttps://api.atlasdao.info/api/v1/external/profile

Retorna as informacoes do usuario autenticado pela API Key.

Exemplo

cURL
curl https://api.atlasdao.info/api/v1/external/profile \
  -H "X-API-Key: SUA_API_KEY"

Resposta

JSON
{
  "id": "usr_abc123",
  "username": "minha_loja",
  "email": "contato@minhaloja.com",
  "commerceMode": true,
  "paymentLinksEnabled": true,
  "isAccountValidated": true,
  "createdAt": "2025-01-01T00:00:00.000Z"
}

Codigos de status

200Perfil retornado com sucesso
401API Key invalida ou ausente

PIX

Endpoints para criar, consultar e gerenciar transacoes PIX.

POSThttps://api.atlasdao.info/api/v1/external/pix/create

Cria uma nova transacao PIX com QR Code para pagamento. Opcionalmente, configure um webhook para receber notificacoes sobre o status da transacao.

Body (JSON)

ParametroTipoDescricao
amountnumberValor da transacao em BRL (minimo: 0.01)
depixAddressstringEndereco da wallet DEPIX para receber os fundos
descriptionstringDescricao da transacao (max 200 caracteres)
taxNumberstringCPF/CNPJ do pagador. Obrigatorio para valores >= R$ 3.000
merchantOrderIdstringID do pedido no seu sistema (max 100 caracteres)
metadataobjectMetadados adicionais para armazenar com a transacao
webhookWebhookConfigConfiguracao do webhook (ver secao Webhooks)

Exemplo

cURL
curl -X POST https://api.atlasdao.info/api/v1/external/pix/create \
  -H "X-API-Key: SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 99.90,
    "description": "Pagamento pedido #123",
    "depixAddress": "lq1qq...",
    "merchantOrderId": "ORD-2025-12345",
    "webhook": {
      "url": "https://meusite.com/webhook",
      "events": ["transaction.paid", "transaction.failed"],
      "secret": "minha-chave-secreta-min-16-chars"
    }
  }'

Resposta

JSON
{
  "id": "txn_abc123def456",
  "status": "PENDING",
  "amount": 99.9,
  "description": "Pagamento pedido #123",
  "merchantOrderId": "ORD-2025-12345",
  "qrCode": "00020126580014br.gov.bcb.pix0136...",
  "qrCodeImage": "data:image/png;base64,...",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "expiresAt": "2025-01-15T11:00:00.000Z",
  "webhook": {
    "id": "wh_xyz789",
    "url": "https://meusite.com/webhook",
    "events": [
      "transaction.paid"
    ],
    "secretHint": "minh"
  }
}

Codigos de status

201Transacao criada com sucesso
400Dados invalidos (amount <= 0, taxNumber ausente para >= R$3000)
401API Key invalida ou ausente
403Permissao negada - verifique as permissoes da API Key
GEThttps://api.atlasdao.info/api/v1/external/pix/status/:id

Consulta o status atual de uma transacao PIX pelo seu ID.

Parametros de path

ParametroTipoDescricao
idstringID da transacao

Exemplo

cURL
curl https://api.atlasdao.info/api/v1/external/pix/status/txn_abc123def456 \
  -H "X-API-Key: SUA_API_KEY"

Resposta

JSON
{
  "id": "txn_abc123def456",
  "status": "COMPLETED",
  "type": "DEPOSIT",
  "amount": 99.9,
  "description": "Pagamento pedido #123",
  "processedAt": "2025-01-15T10:35:00.000Z",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:35:00.000Z",
  "merchantOrderId": "ORD-2025-12345",
  "expiresAt": "2025-01-15T11:00:00.000Z",
  "metadata": {
    "source": "EXTERNAL_API",
    "merchantOrderId": "ORD-2025-12345"
  }
}

Codigos de status

200Detalhes da transacao retornados
401API Key invalida ou ausente
404Transacao nao encontrada
GEThttps://api.atlasdao.info/api/v1/external/pix/transactions

Lista todas as transacoes PIX do usuario com filtros e paginacao.

Parametros de query

ParametroTipoDescricao
statusstringFiltrar por status (PENDING, COMPLETED, FAILED, EXPIRED, CANCELLED)
typestringFiltrar por tipo de transacao
startDatestringData inicial (ISO 8601)
endDatestringData final (ISO 8601)
merchantOrderIdstringFiltrar por ID do pedido
pagenumberNumero da pagina (padrao: 1)
limitnumberItens por pagina (padrao: 20, max: 100)

Exemplo

cURL
curl "https://api.atlasdao.info/api/v1/external/pix/transactions?status=COMPLETED&page=1&limit=20" \
  -H "X-API-Key: SUA_API_KEY"

Resposta

JSON
{
  "data": [
    {
      "id": "txn_abc123",
      "status": "COMPLETED",
      "type": "DEPOSIT",
      "amount": 99.9,
      "description": "Pagamento pedido #123",
      "pixKey": "lq1qq...",
      "processedAt": "2025-01-15T10:35:00.000Z",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-15T10:35:00.000Z",
      "merchantOrderId": "ORD-2025-12345",
      "expiresAt": "2025-01-15T11:00:00.000Z",
      "metadata": {
        "source": "EXTERNAL_API",
        "merchantOrderId": "ORD-2025-12345"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45,
    "totalPages": 3
  }
}

Codigos de status

200Lista de transacoes retornada
401API Key invalida ou ausente
DELETEhttps://api.atlasdao.info/api/v1/external/pix/cancel/:id

Cancela uma transacao PIX pendente. Somente transacoes com status PENDING podem ser canceladas.

Parametros de path

ParametroTipoDescricao
idstringID da transacao a cancelar

Exemplo

cURL
curl -X DELETE https://api.atlasdao.info/api/v1/external/pix/cancel/txn_abc123def456 \
  -H "X-API-Key: SUA_API_KEY"

Resposta

JSON
{
  "id": "txn_abc123def456",
  "status": "CANCELLED",
  "message": "Transaction cancelled successfully"
}

Codigos de status

200Transacao cancelada com sucesso
401API Key invalida ou ausente
404Transacao nao encontrada ou ja processada
GEThttps://api.atlasdao.info/api/v1/external/stats/usage

Retorna estatisticas de uso da API do usuario para um periodo especificado.

Parametros de query

ParametroTipoDescricao
daysnumberNumero de dias para incluir (padrao: 30, max: 90)

Exemplo

cURL
curl "https://api.atlasdao.info/api/v1/external/stats/usage?days=30" \
  -H "X-API-Key: SUA_API_KEY"

Resposta

JSON
{
  "period": {
    "start": "2025-01-01T00:00:00.000Z",
    "end": "2025-01-31T23:59:59.000Z",
    "days": 30
  },
  "summary": {
    "totalRequests": 1240,
    "successfulRequests": 1235,
    "errorRate": "0.40%",
    "transactionsCreated": 156,
    "paymentLinksCreated": 12
  },
  "dailyUsage": {
    "2025-01-29": 45,
    "2025-01-30": 52,
    "2025-01-31": 38
  },
  "limits": {
    "requestsPerMinute": 100,
    "requestsPerDay": 10000,
    "usageType": "MULTIPLE_CPF"
  }
}

Codigos de status

200Estatisticas retornadas com sucesso
401API Key invalida ou ausente

Webhooks

Receba notificacoes em tempo real sobre eventos de suas transacoes.

Configuracao

Webhooks sao configurados inline ao criar uma transacao PIX, no campo webhook do POST /external/pix/create.

Campos do webhook

urlObrigatorioURL que recebera as notificacoes (HTTPS em producao)
eventsObrigatorioArray de eventos para assinar
secretOpcionalSecret para assinatura HMAC (min 16 chars). Se omitido, um e gerado automaticamente
headersOpcionalHeaders customizados para enviar junto com o webhook

Eventos Disponiveis

Cada evento dispara um POST para a URL configurada com o payload correspondente.

transaction.created

Disparado quando uma transacao PIX e criada e o QR Code esta disponivel para pagamento.

JSON
{
  "event": "transaction.created",
  "data": {
    "transactionId": "txn_abc123def456",
    "status": "PENDING",
    "amount": 99.9,
    "merchantOrderId": "ORD-2025-12345",
    "qrCode": "00020126580014br.gov.bcb.pix0136...",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "expiresAt": "2025-01-15T11:00:00.000Z"
  },
  "timestamp": "2025-01-15T10:30:01.000Z",
  "webhookId": "wh_xyz789"
}
transaction.paid

Disparado quando o pagamento PIX e confirmado. Inclui informacoes de settlement (D+0 ou D+1).

JSON
{
  "event": "transaction.paid",
  "data": {
    "transactionId": "txn_abc123def456",
    "status": "COMPLETED",
    "amount": 99.9,
    "merchantOrderId": "ORD-2025-12345",
    "paidAt": "2025-01-15T10:35:00.000Z",
    "payerInfo": {
      "name": "Joao Silva",
      "taxNumber": "***456789**"
    },
    "settlement": {
      "type": "instant",
      "scheduledAt": null
    },
    "metadata": null
  },
  "timestamp": "2025-01-15T10:35:01.000Z",
  "webhookId": "wh_xyz789"
}
transaction.failed

Disparado quando o processamento de uma transacao falha.

JSON
{
  "event": "transaction.failed",
  "data": {
    "transactionId": "txn_abc123def456",
    "status": "FAILED",
    "failedAt": "2025-01-15T10:40:00.000Z",
    "reason": "Transaction processing failed",
    "metadata": null
  },
  "timestamp": "2025-01-15T10:40:01.000Z",
  "webhookId": "wh_xyz789"
}
transaction.expired

Disparado quando o QR Code PIX expira sem ser pago (geralmente 30 minutos).

JSON
{
  "event": "transaction.expired",
  "data": {
    "transactionId": "txn_abc123def456",
    "status": "EXPIRED",
    "expiredAt": "2025-01-15T11:00:00.000Z",
    "amount": 99.9,
    "merchantOrderId": "ORD-2025-12345"
  },
  "timestamp": "2025-01-15T11:00:01.000Z",
  "webhookId": "wh_xyz789"
}
transaction.refunded

Disparado quando uma transacao e reembolsada ao pagador.

JSON
{
  "event": "transaction.refunded",
  "data": {
    "transactionId": "txn_abc123def456",
    "status": "REFUNDED",
    "refundedAt": "2025-01-16T14:00:00.000Z",
    "amount": 99.9,
    "merchantOrderId": "ORD-2025-12345"
  },
  "timestamp": "2025-01-16T14:00:01.000Z",
  "webhookId": "wh_xyz789"
}

Payload

Todos os webhooks seguem a mesma estrutura de payload.

Estrutura geral do payload:

JSON
{
  "event": "transaction.paid",
  "data": {
    "...": "dados especificos do evento"
  },
  "timestamp": "2025-01-15T10:35:01.000Z",
  "webhookId": "wh_xyz789"
}

Headers enviados

Content-TypeTipo de conteudo do payload
X-Atlas-EventNome do evento disparado
X-Atlas-Webhook-IdID do webhook configurado
X-Atlas-SignatureAssinatura HMAC-SHA256 para verificacao

Seguranca (HMAC)

Verifique a assinatura de cada webhook para garantir que veio da Atlas.

Sempre verifique a assinatura

O header X-Atlas-Signature contem sha256=<hmac_hex>. Calcule o HMAC-SHA256 do body com seu secret e compare.

cURL
# Verificacao de assinatura no seu servidor
# O header X-Atlas-Signature contem: sha256=<hmac_hex>
# Calcule o HMAC-SHA256 do body com seu secret e compare

Codigos de Status

Codigos HTTP retornados pela API.

CodigoDescricao
200Requisicao bem sucedida
201Recurso criado com sucesso
400Dados da requisicao invalidos
401API Key invalida ou ausente
403Permissao negada para esta operacao
404Recurso nao encontrado
409Conflito (ex: transacao ja processada)
429Rate limit excedido - aguarde antes de tentar novamente
500Erro interno do servidor