Pular para o conteúdo principal

Extratos

Os endpoints a seguir são responsáveis pela gestão de extrato no padrão CNAB 240


O Extrato de Conta Corrente para Conciliação Bancária permite que os clientes realizem a conciliação bancária de suas contas de forma automatizada e segura, por meio do envio eletrônico do extrato pelo banco. Para mais detalhes, baixe o PDF disponível abaixo.



Consultar arquivos gerados

Este endpoint é utilizado para consultar os arquivos CNAB gerados e associados a uma conta específica.

GET /v1/extrato-cnab/arquivos
Requer autorização para o escopo: gn.cnab-statement.statement.read


Requisição

A requisição enviada para esse endpoint não precisa de um body, apenas os cabeçalhos de autorização OAuth e o certificado da conta.

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
[
{
"data_geracao": "string",
"nome": "string"
}
]
}

Solicitar Download do extrato

Este endpoint é utilizado para Endpoint para solicitar download do extrato.

GET /v1/extrato-cnab/download/:nome_arquivo
Requer autorização para o escopo: gn.cnab-statement.statement.read


Requisição

A requisição enviada para esse endpoint não precisa de um body, apenas os cabeçalhos de autorização OAuth e o certificado da conta, assim como os endpoints anteriores.

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
string
}

Consultar recorrências cadastradas

Este endpoint é utilizado para consultar os agendamentos de recorrências cadastradas em uma conta específica.

GET /v1/extrato-cnab/agendamentos
Requer autorização para o escopo: gn.cnab-statement.statement.read


Requisição

A requisição enviada para esse endpoint não precisa de um body, apenas os cabeçalhos de autorização OAuth e o certificado da conta, assim como os endpoints anteriores.

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
[
{
"status": "ativo",
"periodicidade": "diario",
"envia_email": true,
"comprimir_arquivos": true,
"data_criacao": "string"
}
]
}

Criar recorrência

Este endpoint é utilizado para criar uma nova recorrência.

POST /v1/extrato-cnab/agendar
Requer autorização para o escopo: gn.cnab-statement.statement.write


Requisição

{
"periodicidade": "diario",
"envia_email": true,
"comprimir_arquivos": true
}

Respostas

As respostas abaixo representam Sucesso(201) e Falhas/erros do consumo.

Recorrência criada com sucesso

Revisar recorrência

Este endpoint é utilizado para atualizar ou modificar uma recorrência existente a partir do identificador.

PATCH /v1/extrato-cnab/agendar/:identificador
Requer autorização para o escopo: gn.cnab-statement.statement.write


Requisição

{
"periodicidade": "diario",
"status": "ativo",
"envia_email": true,
"comprimir_arquivos": true
}

Respostas

As respostas abaixo representam Sucesso(201) e Falhas/erros do consumo.

Recorrência atualizada com sucesso

Gerar chave

Este endpoint é utilizado para gerar uma chave associada a uma conta específica.

POST /v1/extrato-cnab/gerar-chaves
Requer autorização para o escopo: gn.cnab-statement.keys.write


A requisição enviada para esse endpoint não precisa de um body, apenas os cabeçalhos de autorização OAuth e o certificado da conta.

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
"privateKey": "string"
}