DDA

Esta é uma funcionalidade complementar do Multipag, com jornada e endpoint próprios, mas compartilhando toda a base técnica (mTLS, OAuth2, mesmas URLs). Funciona como um Quick Start próprio dentro do Multipag.

Enquanto o restante da Multipag serve para pagar, o DDA serve para descobrir o que há a pagar: permite varrer e gerenciar os boletos de cobrança emitidos contra o CPF/CNPJ do associado e de seus agregados, sejam do Sicredi ou de qualquer outro banco, sem digitar ou capturar código de barras. O fluxo natural é: o DDA lista os boletos → o pagamento de boletos da Multipag os liquida.

Conceitos essenciais: Pagador e Agregado Eletrônico

Antes de qualquer código, entenda os dois conceitos:

  • Pagador Eletrônico: a conta cadastrada no DDA que poderá consultar seus próprios boletos. O cadastro é feito pelo associado:
    • Internet Banking: DDA > Cadastrar Pagador Eletrônico
    • Aplicativo Sicredi: Menu > Pagamentos > DDA/Agenda de boletos
  • Agregado Eletrônico: um terceiro (ex.: uma filial) que autoriza o Pagador Eletrônico (ex.: a matriz) a visualizar todos os boletos registrados contra o CPF/CNPJ do agregado.
⚠️

A inclusão do Agregado Eletrônico só é permitida pela agência.

O associado precisa contatar o gerente, não é feita pelos canais digitais nem pela API.


Adesão

Além da adesão à API Multipag (ver Como obter acesso), é necessário aderir à conta como Pagador Eletrônico pelos canais acima. A adesão à API em si segue a mesma jornada (cooperativa, termo, certificado).

Autenticação

Idêntica à Multipag (OAuth2 Client Credentials sobre mTLS), com o escopo multipag.dda.consultar:

curl --location 'https://mtls-api-parceiro.sicredi.com.br/sb/thirdparty/auth/token' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'grant_type=client_credentials' \
  --data-urlencode 'client_id=SEU_CLIENT_ID' \
  --data-urlencode 'client_secret=SEU_CLIENT_SECRET' \
  --data-urlencode 'scope=multipag.dda.consultar'
🔅

Já integra a Multipag Pagamentos?

Basta incluir o escopo multipag.dda.consultar junto aos outros na requisição de token. Se já importou o certificado, não precisa importar de novo, é o mesmo.

Consultar boletos por Pagador Eletrônico

GET /v1/dda/boletos, escopo multipag.dda.consultar. Consulta boletos em aberto de um Pagador Eletrônico, boletos de seus Agregados e títulos repassados por terceiros a esse Pagador.

Parâmetros:

ParâmetroLocalObrigatórioObservações
x-cooperativaheaderSimCooperativa do associado cadastrado
x-contaheaderSimConta do associado cadastrado
x-documentoheaderSimDocumento do associado cadastrado
AuthorizationheaderSimBearer token
cnpjCpfPagadorquerySimCPF (11) ou CNPJ (14 dígitos numéricos) do pagador
dataInicioquerySimyyyy-MM-dd, data de vencimento inicial. No Sandbox, informar a data do dia.
dataFimquerySimyyyy-MM-dd, data de vencimento final
cnpjCpfAgregadoqueryNãoCPF/CNPJ do agregado do pagador
itemInicialqueryNãoPaginação — item inicial
itemFinalqueryNãoPaginação, item final

Exemplo de request:

curl -X GET \
  'https://mtls-api-parceiro.sicredi.com.br/sb/multipag-sandbox/v1/dda/boletos?itemInicial=1&itemFinal=100&dataInicio=2026-08-14&dataFim=2026-08-15&cnpjCpfPagador=11111111000111' \
  -H 'Authorization: Bearer SEU_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'x-cooperativa: 0100' \
  -H 'x-conta: 000001' \
  -H 'x-documento: 11111111000111'

Exemplo de response:

{

  "idLista": "241112000000003",
  "boletos": [
    {
      "cpfCnpjPagador": "11111111000111",
      "nomeBeneficiario": "EMPRESA BENEFICIARIA LTDA",
      "cpfCnpjBeneficiario": "35849668000192",
      "dataVencimento": "2026-08-15",
      "valorTitulo": 100.00,
      "codigoBarras": "74893984400000100001160000158204342602012103",
      "linhaDigitavel": "74893.98440 00001.600001 60000.158204 3 34260201210300",
      "valorPercentualDesconto": 0
    }

  ]

}

Próximo passo natural

De posse do codigoBarras retornado, você pode criar o pagamento com o endpoint de pagamento de boletos, fechando o ciclo "descobrir → pagar" dentro da mesma Multipag.



Did this page help you?