Documentação de APIs - AugePag

Explore nossos serviços e aprenda como integrá-los.

Emitir Cobrança

Use este endpoint para criar cobranças e gerar boletos automaticamente.

POST https://sistema.augepag.com/api/bb/novo-cliente-boleto
Authorization: Bearer SUA_CHAVE
Content-Type: application/json
{
    "nome": "Nome",
    "endereco": "Rua X, Numero",
    "bairro": "Bairro",
    "documento": "000.000.000-01",
    "cep": "0000-000",
    "cidade": "Feira de Santana",
    "email": "email@email.com",
    "pessoa": 1,
    "valor": 10.00,
    "vencimento": "YYYY-MM-DD",
    "nossoNumeroCliente": 12345678
    "percentual_juros": 1.00
    "percentual_multa": 2.00
}

Resposta

{
    "status": 1,
    "message": "Novo boleto adicionado com sucesso!",
    "linkBoleto": "LINK PARA O PDF DO BOLETO",
    "linhaDigitavel": "12345.67890 12345.678901 23456.789012 3 45678901234567",
    "codigoDeBarras": "12345678901234567890123456789012345678901234",
    "nossoNumero": "123123"
}

Coleção de Boletos

Use este endpoint para buscar informações de boletos emitidos.

POST https://sistema.augepag.com/api/bb/cobrancas
Authorization: Bearer SUA_CHAVE
Content-Type: application/json
{
    "dataInicial": "YYYY-MM-DD",
    "dataFinal": "YYYY-MM-DD",
    "filtrarDataPor": "VENCIMENTO | EMISSAO | PAGAMENTO",
    "situacao": "PAGO | ABERTO | CANCELADO | IRREGULAR",
    "pessoaPagadora": "Nome",
    "cpfCnpjPessoaPagadora": "000.000.000-01",
    "seuNumero": "12345678",
    "paginacao.itensPorPagina": 100,
    "paginacao.paginaAtual": 0,
    "ordenarPor": "DATA_VENCIMENTO | DATA_EMISSAO | DATA_PAGAMENTO | VALOR | STATUS",
    "tipoOrdenacao": "ASC | DESC"
}

Resposta

{
    "status": 200,
    "message": "Cobranças recuperadas com sucesso.",
    "totalPaginas": 5,
    "totalElementos": 500,
    "tamanhoPagina": 100,
    "primeiraPagina": true,
    "ultimaPagina": false,
    "numeroDeElementos": 100,
    "cobrancas": [
        {
            "codigoSolicitacao": 1,
            "seuNumero": "12345678",
            "situacao": "PAGO",
            "dataEmissao": "2024-12-16",
            "dataVencimento": "2024-12-31",
            "dataPagamento": "2024-12-20",
            "valor": 150.50,
            "pessoaPagadora": "Cliente X",
            "cpfCnpjPagadora": "123.456.789-00",
            "nossoNumero": "87654321",
            "codigoBarras": "12345678901234567890123456789012345678901234",
            "linhaDigitavel": "12345.67890 12345.678901 23456.789012 3 45678901234567",
            "txId": "abc123xyz",
            "pixCopiaeCola": "123456789qwertyuiopasdfghjkl"
        }
    ]
}