• Primeiros Passos
    • Autenticação
    • Ambientes
    • Cartões de Teste
    • Pagamento de Fatura Checkout
    • Pagamento de Faturas de uma Venda
    • Webhooks
    • Captação de Leads e Venda por LP Externa
    • Erros
    • Limites de Requisição
    • Autenticação
      • Troca clientId/clientSecret por um token de acesso
        POST
    • Leads
      • Cria um lead
        POST
      • Atualiza um lead
        PATCH
    • Contatos
      • Consulta um contato por e-mail
        GET
      • Consulta um contato por id
        GET
      • Atualiza um contato
        PATCH
    • Links de Pagamento Personalizados
      • Lista links de pagamento
        GET
      • Cria um link de pagamento personalizado
        POST
      • Simula o cronograma de cobrança de um link de pagamento
        POST
      • Consulta um link de pagamento
        GET
      • Cancela um link de pagamento
        POST
      • Atualiza a expiração de um link de pagamento
        PATCH

    Erros

    Toda resposta de erro da API segue o mesmo formato:
    {
      "statusCode": 401,
      "message": "Unauthorized",
      "error": "Unauthorized"
    }
    statusCode: código HTTP do erro (repete o status da resposta).
    message: descrição do erro. Pode ser uma string única ou uma lista de strings (comum em erros de validação, um item por campo inválido).
    error: nome curto do erro.

    Status codes possíveis#

    StatusSignificadoQuando ocorre
    400Bad RequestValidação do payload falhou (algumas operações usam 422 para o mesmo caso — confira a referência do endpoint)
    401UnauthorizedToken ausente, inválido ou expirado
    403ForbiddenToken válido, mas sem a permissão exigida pela operação
    404Not FoundRecurso não encontrado (ex.: id inexistente)
    409ConflictEstado atual do recurso não permite a operação (ex.: cancelar um link já pago)
    422Unprocessable EntityValidação do payload falhou (ver nota acima sobre 400)
    429Too Many RequestsLimite de requisições excedido — veja Limites de Requisição
    Cada endpoint na referência documenta quais desses status ele pode retornar e, quando aplicável, uma descrição mais específica do cenário de erro.

    Próximos passos#

    Limites de Requisição — limites de requisições por segundo.
    Previous
    Captação de Leads e Venda por LP Externa
    Next
    Limites de Requisição
    Built with