Índice

  1. Objetivo
  2. Histórico de versão
  3. Endpoint da api
  4. Estrutura principal do JSON do arquivo de retorno (download via urlAssinada)
  5. Exemplo do JSON de retorno (download via urlAssinada)

Consultar recolhimentos de CBS como adquirente

1. Objetivo

Consultar recolhimentos de CBS na condição de adquirente, compreendendo: o recolhimento pelo adquirente (RAD) e o split payment.

Esta API funciona em modo assíncrono. Para orientações de uso, consulte as Regras Comuns às APIs Assíncronas da Apuração de CBS: regras de APIs assíncronas

2. Histórico de versão

Data Versão Descrição
03/09/2026 1.0 Versão inicial

3. Endpoint da api

3.1 Campos de Entrada

Campo Formato Descrição
cnpj String (8) CNPJ base informado no path.

3.2 Header

Campo Formato Descrição
Content-TypeStringapplication/json

3.3 Request Body

Campo Formato Descrição
URL Retorno String URL do webhook informada na solicitação para retorno da requisição.

3.4 Acionar o endpoint

  1. Substitua $TOKEN pelo valor de access_token.
  2. Substitua {cnpj} pelo CNPJ base com 8 dígitos.
  3. Informe no corpo uma urlRetorno(URL do webhook) - url https válida para receber o payload com o link do arquivo de retorno.

Exemplo de chamada (com variável TOKEN)

curl --location 'https://api.receitafederal.gov.br/apuracao-cbs-prr/v2/recolhimentos/{cnpj}' \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{ "urlRetorno": "https://cliente.exemplo.com/webhooks/apuracao-cbs" }'

Exemplo com dados fictícios

curl --location 'https://api.receitafederal.gov.br/apuracao-cbs-prr/v2/recolhimentos/12345678' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.dadoFicticio.assinaturaFicticia' \
  --data '{ "urlRetorno": "https://cliente.exemplo.com/webhooks/apuracao-cbs" }'

3.5 Campos Retornados

Campo Formato Descrição
tiqueteSolicitacao String Em caso de sucesso, tíquete gerado na requisição.
tEASegundos String Em caso de sucesso - Tempo estimado para atendimento da solicitação.
codigoErro String Em caso de erro - Identifica o erro ocorrido durante a requisição. Retornado apenas em caso de erro.
mensagemErro String Em caso de erro - Mensagem descritiva do erro ocorrido durante a requisição. Retornado apenas em caso de erro.

Exemplo de retorno em caso de sucesso (HTTP 201)

{
  "tiqueteSolicitacao": "692b7b25-44cb-4415-8625-2b9522dd7933.B5E08D55",
  "tEASegundos": "120"
}

Exemplo de retorno em caso de erro (HTTP 400/401/404/500)

{
  "codigoErro": "APURACAO-001",
  "mensagemErro": "Parâmetros inválidos para processamento da solicitação."
}

Exemplo de objeto enviado para urlRetorno(webhook) em caso de sucesso (HTTP 200)

{
  "tiqueteSolicitacao":"48d88a3c-eff9-4489-8e3a-cde8d878d3f7.1E0CE7A4",
  "urlAssinadaExpiraEm": "2026-08-26T14:30:00Z",
  "urlAssinada":"https://storagegw.estaleiro.serpro.gov.br/apuracao-assistida-des/arquivos/apuracao-cbs/87654321000198/48d88a3c-eff9-4489-8e3a-cde8d878d3f7.1E0CE7A4_1788876458089.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=N5B4BZIDF0S5FGG4AOUT%2F20260908%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260908T140738Z&X-Amz-Expires=172800&X-Amz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=7a02254ac3514124ebe8c3ea0a15facfd82ec0e4a572843716d75217d2c4214f%22,%22urlAssinadaExpiraEm%22:%222026-09-10T11:07:38.377213789-03:00%22%7D"  
 } 

4. Estrutura principal do JSON do arquivo de retorno (download via urlAssinada)

Campo Formato Descrição
tiqueteSolicitacaoStringTíquete da solicitação.
niString (8)NI do contribuinte.
niConsumidorStringNI do consumidor.
geradoEmString (date-time)Data/hora de geração do arquivo.
apuracao[]ArrayLista de apurações.
apuracao[].dataArrecadacaoString (date-time)Data/hora da arrecadação.
apuracao[].pagamentos[]ArrayLista de pagamentos.
apuracao[].pagamentos[].numeroDARFStringNúmero do DARF.
apuracao[].pagamentos[].tipoIntegerTipo do pagamento.
apuracao[].pagamentos[].composicao[]ArrayItens de composição do pagamento.
apuracao[].pagamentos[].composicao[].sequencialIntegerSequencial do item de composição.
apuracao[].pagamentos[].composicao[].paString (MM/AAAA)Período de apuração.
apuracao[].pagamentos[].composicao[].vencimentoString (date-time)Data/hora de vencimento.
apuracao[].pagamentos[].composicao[].niFornecedorStringNI do fornecedor.
apuracao[].pagamentos[].composicao[].chaveDFEStringChave do DFE.
apuracao[].pagamentos[].composicao[].principalNumberValor principal.
apuracao[].pagamentos[].composicao[].multaNumberValor de multa.
apuracao[].pagamentos[].composicao[].jurosNumberValor de juros.
apuracao[].pagamentos[].composicao[].totalNumberValor total.

5. Exemplo do JSON de retorno (download via urlAssinada)

{
  "tiqueteSolicitacao": "<tiqueteSolicitacao>",
  "ni": "12345678",
  "niConsumidor": "12345678",
  "geradoEm": "2026-08-27T19:03:44Z",
  "apuracao": [
    {
      "dataArrecadacao": "2026-08-27T19:03:44.525Z",
      "pagamentos": [
        {
          "numeroDARF": "",
          "tipo": 0,
          "composicao": [
            {
              "sequencial": 0,
              "pa": "08/2026",
              "vencimento": "2026-08-27T19:03:44.525Z",
              "niFornecedor": "",
              "chaveDFE": "",
              "principal": 0,
              "multa": 0,
              "juros": 0,
              "total": 0
            }
          ]
        }
      ]
    }
  ]
}