EnterPay API Docs V1
    EnterPay API Docs V1
    • Referência de API
    • Autenticação
    • Erros
    • Clientes
      • Buscar um cliente
        GET
      • Listar meus clientes
        GET
      • Cadastrar novo cliente
        POST
      • Atualizar dados do cliente
        PUT
      • Remover cliente
        DELETE
    • Cobrança
      • Listar minhas cobranças
        GET
      • Criar uma nova cobrança
        POST
    • Configurações da conta
      • Empresa
        • Atualizar dados da empresa
        • Obter informações da empresa
      • Customização
        • Atualizar dados de customização
        • Obter dados de customização
    • Webhook
      • UpdateStatus
        POST

    Erros

    Tratamento de Erros#

    A EnterPay API utiliza códigos de resposta HTTP convencionais para comunicar o sucesso ou falha de uma solicitação de API.

    Códigos de Resposta HTTP#

    Os códigos no intervalo 2xx indicam que a solicitação foi bem-sucedida.
    Os códigos no intervalo 4xx indicam que ocorreu um erro devido a informações fornecidas pelo cliente (por exemplo, um parâmetro obrigatório ausente).
    Os códigos no intervalo 5xx indicam um erro nos servidores da EnterPay, sendo raros.

    Tratamento de Erros Programáticos#

    Alguns erros 4xx podem ser tratados programaticamente e incluem um código de erro para explicar brevemente o problema encontrado. Por exemplo, um erro pode ser gerado quando um cartão de crédito é recusado durante uma transação.

    Exemplo de Resposta de Erro#

    {
      "error": {
        "code": "invalid_request_error",
        "message": "Parâmetro 'amount' obrigatório não fornecido."
      }
    }
    Modificado em 2024-05-07 05:28:29
    Página anterior
    Autenticação
    Próxima página
    Buscar um cliente
    Built with