Documentação da API de Integração - Direto

Prod. URL: https://api-cliente.paguedireto.com.br

Tst. URL: https://tst-api-cliente.paguedireto.com.br

Início

Bem-vindo(a) à Documentação da API de Integração da Direto.

Na API de Integração você pode registrar e listar as pendências de pagamento de seus clientes.
Clientes com inadimplencias ativas poderão ser comunicados automaticamente sobre os debitos em divida.

Após pagamento, você pode utilizar a API para registrar o pagamento.
Inadimplências totalmente pagas não entrarão na esteira de comunicação

Para poder utilizar os serviços é necessario se cadastrar em nossa plataforma.
Acesse: https://app.paguedireto.com.br/

Autenticação

POST /login

Utilize a rota de Login para obter o TOKEN de acesso. É preciso utilizar o TOKEN no cabeçalho(header) de suas requisições HTTP para se autenticar.

"authorization" : "Bearer <Token>"

Schema:

email : String
password : String

token : String

Exemplos

Requisição

{
    "email": "[email protected]",
    "password": "AaZz@!09"
}

Resposta

{
    "token": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}

Listar Inadimplente

POST /inadimplencias/listar

Esta rota é utilizada para consultar as informações das inadimplencias, utilizando o BODY da Requisição POST você pode filtrar a pesquisa.

Nenhum parametro BODY é obrigatório para pesquisa. No entanto, irá buscar todos os registros se não tiver nenhum valor alocado.

Schema:

devedor_documento : String
devedor_nome : String
codigo_cliente : String
debito_status : String
limit : Number
page : Number

cobranca_valor : Number
juros : Number
multa : Number
valor_corrigido : Number
valor_pagamento : Number
total_boletos : Number
boletos_pagos : Number
protesto_status : String/null
debito_status : String
cobranca_fee : String
devedor_nome : String
devedor_documento : String
codigo_cliente : String
codigo_debito : String
cobranca_descricao : String
cobranca_create : String
vencimento_cobranca : String
cobranca_id : v4_UUID

O elemento de filtro debito_status tem válido os valores a seguir:

"aberto" = "Em aberto"
"enviado = "Enviado a Protesto"
"pago" = "Pago"
"pago_cliente" = "Pago (Cliente)"
"processamento" = "Em processamento"
"pago_cartorio" = "Pago no Cartorio"
"negociacao_quebrada" = "Acordo Não Pago"

Caso seja enviado "aberto" no debito_status na requisição POST, a resposta será apenas as cobranças que estejam com o debito_status "Em aberto"

Exemplos

Requisição

{
        // opcionais
    "devedor_documento": "xx.xxx.xxx/xxxx-xx",
    "devedor_nome": "Francisco Buarque de Hollanda",
    "codigo_cliente": "Contrato 1",
    "debito_status": "aberto",
    "limit": 10,
    "page": 0
}

Resposta

[
    {
        "cobranca_valor": 100,
        "juros": 1,
        "multa": 2,
        "valor_corrigido": 114.20,
        "valor_pagamento": 114.20,
        "total_boletos": 0,
        "boletos_pagos": 0,
        "protesto_status": null,
        "debito_status": "Em Aberto",
        "cobranca_fee": "nenhum",
        "devedor_nome": "Francisco Buarque de Hollanda",
        "devedor_documento": "xxxxxxxxxxxxxx",
        "codigo_cliente": "Contrato 1",
        "codigo_debito": "parcela 3",
        "cobranca_descricao": "lorem ipsum",
        "cobranca_create": "2024-01-04T12:40:33.702Z",
        "vencimento_cobranca": "2023-10-04",
        "cobranca_id": "63f7d142-668f-4c05-8154-1335d7e3f64f"
    }
]

Registrar Inadimplente

POST /inadimplencias/adicionar

Ao utilizar essa rota, você estará registrando a pendência de pagamento de um cliente ou mais.
Os itens no elemento COBRANCAS serão registrados e higienizados, o que significa que ocorrerá uma busca pelos dados do inadimplente.

O EMAIL enviado será notificado ao final dos processo de verificação dos elementos nos items, higienização de dados dos clientes e registro das pendências em nosso banco de dados.

Para que futuras requisições na rota Consultar Repasses ocorram sem problemas, o item codigo_debito é obrigatório para saber a equivalencia da parcela de negociação para as parcelas das cobranças. Para que não ocorra problemas de consulta, não repetir o mesmo codigo_debito para um devedor.

Schema:

email : String
cobrancas : Array

devedor_nome : String
devedor_documento : String
cobranca_descricao : String
cobranca_valor : Number
vencimento_cobranca : String
endereco_cep : String

codigo_debito : String
data_nascimento : String
email_devedor : String
telefone_devedor : String
maximo_parcelas : Number
codigo_cliente : String
juros : Number
multa : Number
endereco_rua : String
endereco_numero : String
endereco_complemento : String
endereco_bairro : String
endereco_cidade : String
endereco_estado : String

message : String

Exemplos

Requisição

{
        // obrigatórios
    "email": "[email protected]",
    "cobrancas": [
        {            
                // obrigatórios
        "devedor_nome": "Francisco Buarque de Hollanda",
        "devedor_documento": "xxx.xxx.xxxx.xxxx",
        "cobranca_descricao": "lorem ipsum",
        "cobranca_valor": "100",
        "vencimento_cobranca": "01/01/2024",
        "endereco_cep": "00.000-001", 
        "codigo_debito": "parcela 3",
        
                // opcionais
        "data_nascimento": "10/01/2000",
        "email_devedor": "[email protected]",
        "telefone_devedor": "(98) 98765-4321",
        "maximo_parcelas": 24,
        "codigo_cliente": "Contrato 1",
        "juros": 1,
        "multa": 2,
        "endereco_rua": "",
        "endereco_numero": "",
        "endereco_complemento": "",
        "endereco_bairro": "",
        "endereco_cidade": "",
        "endereco_estado": ""
        },
        {}
    ]
}

Resposta

{
    message: "Sua requisição está sendo processada. Ao finalizar o processamento, será enviado um e-mail com o resultado."
}

Atualizar Pagamento

PUT /inadimplencias/atualizar_pagamento

Esta requisição deve ser utilizada quando a inadimplencia for paga após registro e comunicação ao cliente inadimplentes.

A categoria do pagamento pode ser Baixa Parcial, o que significa que o inadimplente pagou uma parte da dívida, ou Baixa Total, o que significa que não há mais pendência de pagamento daquela dívida especifica.

Atualizar o pagamento de uma dívida altera o calculo de valor_pagamento na listagem de inadimplentes

Se o valor de uma Baixa Parcial for maior que o valor_pagamento, então será considerada como uma Baixa Total e dívida será registrada como paga.

Schema:

cobranca_id : v4_UUID
valor : Number
categoria : String
descricao : String

message : String

Exemplos

Requisição

{
    "cobranca_id": "63f7d142-668f-4c05-8154-1335d7e3f64f",
    "valor": 25,
    "categoria": "Baixa Parcial",
    "descricao": "Pagamento 1/4",
}

Resposta

{
    "message":  "Pagamento adicionado com sucesso."
}

Consultar Pagamento

GET /inadimplencias/consultar_pagamento/{cobranca_id}

Esta rota retorna todos os pagamentos registrados da dívida ao utilizar a rota de Atualizar Pagamento.

Schema:

baixa_id : v4_UUID
baixa_descricao : String
valor_total : Number
valor_direto : Number
cobranca_id : v4_UUID
data_pagamento : String
baixa_status : Boolean
created_at : String
valor_custas : Number
valor_fee : Number
baixa_categoria : String
valor_para_pagamento : Number
baixa_descricao_cobranca : String

Exemplos

Resposta

[
    {
        "baixa_id":  "2b648709-3468-4523-869e-d8edac1ba0c8"
        "baixa_descricao":  "Pagamento 1/4"
        "valor_total":  25
        "valor_direto":  4.1
        "cobranca_id":  "63f7d142-668f-4c05-8154-1335d7e3f64f"
        "data_pagamento":  "2024-10-10"
        "baixa_status":  true
        "created_at":  "2024-10-10T12:00:48.194Z"
        "valor_custas":  0
        "valor_fee":  20
        "baixa_categoria":  "Baixa Parcial"
        "valor_para_pagamento":  114.20
        "baixa_descricao_cobranca":  "Baixa Parcial - lorem ipsum"
    }
]

Consultar Repasse

GET /inadimplencias/consultar_repasses/{tipo}

Esta rota retorna todos os repasses de pagamentos feitos através da plataforma. O Paramêtro Tipo só tem dois valores, total ou detalhado.

Esta rota recebe filtros por Query String, para o Tipo total são válidos os filtros por período e paginação.
Caso não tenha Query String e esteja utilizando o Tipo total, retornará todos os registros.

Para o Tipo detalhado, é obrigatório enviar Query String na requisição.

Para que a requisição no Tipo detalhado funcione corretamente, é obrigatório o envio do codigo_debito ao adicionar cobranças e que não haja o mesmo codigo_debito por devedor.
(Um devedor não deve ter duas cobranças com seus codigo_debitos como 'Parcela 1')

Schema:

count : Number
rows : Array
hdn_id : v4_UUID
valor : String
data_dt : String
data : String
plataforma_pagamento_id : v4_UUID

Query String do Tipo total:

dataInicial : yyyy-MM-dd
dataFinal : yyyy-MM-dd
limit : Integer
page : Integer

Query String do Tipo detalhado:

plataforma_pagamento_id : v4_UUID
hdn_id : v4_UUID

Exemplos

Query String

?dataInicial=yyyy-MM-dd&dataFinal=yyyy-MM-dd&limit=10&page=0

Resposta

{
    "count" : 1,
    "rows": [
        {
            "hdn_id": "63f7d142-668f-4c05-8154-1335d7e3f64f",
            "valor": "2389.68",
            "data_dt": "2025-06-18",
            "data": "18/06/2024",
            "plataforma_pagamento_id": "77d81da7-2f47-4757-8feb-419ecb35e2bf"
        }
    ]
}

Índice

Inadimplência

Documentação da API de Integração - Direto

Início

Autenticação

Exemplos

Listar Inadimplente

Exemplos

Registrar Inadimplente

Exemplos

Atualizar Pagamento

Exemplos

Consultar Pagamento

Exemplos

Consultar Repasse

Exemplos