Referência da API

Toda operação da especificação oficial da API v3 do Asaas existe aqui, com autenticação, validação e o formato de erro do Asaas. Comportamento real quer dizer um motor de negócio com estado; as demais respondem 501 nomeando a operação, nunca dado falso.

Convenções

  • URL base: http://localhost:45445/v3.
  • Autenticação: o header access_token com a chave da conta, como no Asaas. Cada chave é uma conta, com walletId e saldo próprios.
  • Erros: HTTP 400 com {"errors":[{"code":"…","description":"…"}]}, os códigos e frases que o Asaas manda (um cartão recusado é invalid_action, não invalid_creditCard).
  • Listas: offset e limit, com totalCount e hasMore na resposta.
  • Dinheiro: guardado em centavos inteiros por dentro, respondido em reais como no Asaas.

As operações /v3

Abra uma operação para ver os parâmetros, os campos do corpo, um exemplo de requisição e cada resposta com o seu exemplo, erros incluídos, tirados da especificação oficial.

Rotas de administração e de teste

Não existem no Asaas. /_admin (o relógio, contas e chaves, webhooks, cartões, notificações ao pagador) e /_mock (uma chamada para levar uma cobrança a um estado) não pedem access_token e desligam com ADMIN_ENABLED=false; o painel é construído em cima delas. Abra uma rota para ver o que ela recebe e o que responde: toda resposta abaixo, erros incluídos, foi capturada de uma execução da imagem.

Quando o seu código também puder rodar contra o sandbox real, prefira POST /v3/sandbox/payment/{id}/confirm e …/overdue, do próprio sandbox, às rotas /_mock.