Bem-Vindo à Plataforma para Desenvolvedores

Esta documentação foi desenhada para desenvolvedores. Através da nossa API baseada em arquitetura REST, você consegue acesso a implementações de nossos serviços. Nossa API possibilita acesso a fluxos de toda a jornada transacional:

1. Gestão de Pedidos: Crie carrinhos de venda, registre metadados e associe orçamentos usando POST /sellers/orders/.
2. Controle de Saldos em Tempo Real: Recupere de forma determinística seus saldos operacionais, transitórios e de liquidação.
3. Webhooks Assíncronos: Configure URLs responsivas e nós te notificamos a cada faturamento compensado usando HMAC SHA-256 para o mais robusto controle de intrusão e replay-attacks.

---

Por onde devo começar?

Recomendamos que você inicie sua jornada na seção de Primeiros Passos, onde você aprenderá a gerar e utilizar a sua API Key para acessar nossas rotas através do header Authorization.

Arquitetura de Comunicação

Trabalhamos padronizadamente via HTTP REST sob os comandos de GET, POST, PATCH e DELETE. Toda sua comunicação de entrada e saída (Requests e Responses), exceto casos explícitos de downloads estáticos, serão trafegados em JSON (application/json).

Formato da Resposta

Todas as respostas da API — tanto de sucesso quanto de erro — seguem o mesmo envelope:

{
  "message": "Texto descritivo do resultado.",
  "data": { }
}

• message (string, sempre presente): mensagem descritiva do resultado da operação.
• data (objeto ou array, opcional): payload da resposta.
  • Em sucesso (2xx), contém o recurso ou lista de recursos.
  • Em erro de validação (400), contém o detalhe por campo (ex.: { "email": ["Endereço inválido."] }).
  • Em erros simples (401, 404, 500), pode ser omitido — só message é garantido.

Listagens

Em endpoints paginados (como GET /sellers/orders/), a resposta inclui também o objeto metadata no nível raiz, com informações de paginação (count, next, previous, page, total_pages, total_results).

Exemplo de resposta de sucesso:

{
  "message": "Pedido criado com sucesso!",
  "data": {
    "uuid": "f9e8d7c6-b5a4-4321-9876-123456789abc",
    "status": "PENDING",
    "gross_amount": 15000
  }
}

Exemplo de erro de validação (400):

{
  "message": "Erro de validação",
  "data": {
    "customer.email": ["Insira um endereço de email válido."],
    "items": ["Este campo é obrigatório."]
  }
}

Exemplo de erro simples (404):

{
  "message": "Pedido não encontrado."
}