v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBRealiza a consulta da lista de DDA.
Pagamento - Lista DDA<br/>Retorna uma lista de pagamentos DDA (Débito Direto Autorizado) para usuários autorizados, permitindo o acompanhamento e a gestão de cobranças eletrônicas recebidas. Esta API facilita a consulta de débitos pendentes, proporcionando maior controle financeiro, transparência e eficiência no processamento de pagamentos.<br/><br/>Requisição<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>cnpj</td><td>Texto</td><td>CNPJ da conta destino.</td><td>Sim</td></tr><tr><td>page</td><td>Inteiro</td><td>Número da página consultada.</td><td>Sim</td></tr><tr><td>per_page</td><td>Inteiro</td><td>Número de itens por página.</td><td>Sim</td></tr><tr><td>status</td><td>Texto</td><td>Status dos DDAs consultados.</td><td>Sim</td></tr><tr><td>vencStart</td><td>Texto</td><td>Data inicio do vencimento.</td><td>Não</td></tr><tr><td>vencEnd</td><td>Texto</td><td>Data final do vencimento.</td><td>Não</td></tr></tbody></table><br/><br/>Resposta<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>message</td><td>Texto</td><td>Mensagem de retorno.</td></tr><tr><td>pay_to</td><td>Texto</td><td>Nome ou identificador do beneficiário do pagamento.</td></tr><tr><td>amount</td><td>Texto</td><td>Valor do pagamento.</td></tr><tr><td>status</td><td>Texto</td><td>Status atual do pagamento.</td></tr><tr><td>status_2</td><td>Texto</td><td>Status adicional ou complementar do pagamento.</td></tr><tr><td>sittit</td><td>Texto</td><td>Código da situação do título/cobrança (Consultar Tabela 1 – Situação do Título).</td></tr><tr><td>sittitpgto</td><td>Texto</td><td>Código da situação do pagamento do título (Consultar Tabela 2 – Situação do Pagamento).</td></tr><tr><td>due_date</td><td>Texto</td><td>Data de vencimento do pagamento.</td></tr><tr><td>limite_pgto_date</td><td>Texto</td><td>Data limite para pagamento sem incidência de encargos.</td></tr><tr><td>linecode</td><td>Texto</td><td>Linha digitável do boleto ou DDA, utilizada para pagamento.</td></tr><tr><td>barcode</td><td>Texto</td><td>Código de barras do boleto ou DDA, utilizado para pagamento.</td></tr><tr><td>numidentcdda</td><td>Texto</td><td>Número de identificação do DDA, fornecido pela instituição financeira.</td></tr><tr><td>oculto</td><td>Boleano</td><td>Indicador se o pagamento está oculto na listagem.</td></tr><tr><td>cnpjcpfcedente</td><td>Texto</td><td>CNPJ do cedente.</td></tr><tr><td>cnpjcpfsacador</td><td>Texto</td><td>CNPJ do sacador.</td></tr><tr><td>transaction_uuid</td><td>Texto</td><td>Identificador único da transação para rastreamento e controle.</td></tr></tbody></table><table><thead><tr><p><b>Tabela 1 - Descrição dos retornos do campo: Sittit</b></p></tr><tr><th>Retorno</th><th>Descrição</th><th></th><th></th><th></th></tr></thead><tbody><tr><td>1</td><td>Aberto.</td></tr><tr><td>2</td><td>Baixa efetiva por solicitação do Beneficiário.</td></tr><tr><td>3</td><td>Baixa efetiva por Liquidação Intra-bancária.</td></tr><tr><td>4</td><td>Baixa efetiva por Liquidação Interbancária.</td></tr><tr><td>5</td><td>Baixa efetiva por decurso de prazo.</td></tr><tr><td>6</td><td>Baixa efetiva por envio de protesto.</td></tr><tr><td>7</td><td>Baixa efetiva por solicitação da instituição destinatária.</td></tr></tbody></table><table><thead><tr><p><b>Tabela 2 - Descrição dos retornos do campo: SitTitPgto</b></p></tr><tr><th>Retorno</th><th>Descrição</th><th></th><th></th><th></th></tr></thead><tbody><tr><td>1</td><td>Boleto já baixado.</td></tr><tr><td>2</td><td>Boleto bloqueado para pagamento.</td></tr><tr><td>3</td><td>Boleto encontrado na base centralizada e Cliente Beneficiário inapto na Instituição emissora do título.</td></tr><tr><td>4</td><td>Boleto encontrado na base e cliente Beneficiário sem cadastro.</td></tr><tr><td>5</td><td>Boleto encontrado na base centralizada e Cliente Beneficiário em análise na instituição emissora do título.</td></tr><tr><td>6</td><td>Boleto excedeu o limite de pagamentos parciais.</td></tr><tr><td>7</td><td>Baixa operacional integral já registrada.</td></tr><tr><td>9</td><td>Boleto excedeu o valor de saldo para pagamento parcial para o tipo de modelo de cálculo 04.</td></tr><tr><td>10</td><td>Boleto encontrado na base centralizadora e Cliente Beneficiário inapto em Instituição diferente da emissora.</td></tr><tr><td>11</td><td>Boleto encontrado na base centralizadora e Cliente Beneficiário em análise em instituição diferente da emissora.</td></tr><tr><td>12</td><td>Boleto encontrado na base centralizada e Cliente Beneficiário apto.</td></tr></tbody></table>
Query parameters
CNPJ da conta.
Status do DDA.
Número da página.
Número de itens por página.
Data inicial de vencimento do periodo.
Data final de vencimento do periodo.
Headers
Client ID enviado no Header
Response
Lista de DDA consultada com sucesso.
Example response
{
"message": "Lista de DDA consultada com sucesso.",
"data": [
{
"list": [
{
"pay_to": "Fulano de Tal",
"amount": "R$ 00,00",
"status": "Em aberto",
"status_2": "Em aberto",
"sittit": "1",
"sittitpgto": "12",
"due_date": "11/02/2030",
"limite_pgto_date": "11/02/2030",
"linecode": "00000000000000000000000000000000000000000000001",
"barcode": "00000000000000000000000000000000000000000000001",
"numidentcdda": "000000000000000000",
"cnpjcpfcedente": "00000000000100",
"cnpjcpfsacador": "00000000000100"
}
]
}
]
}