Skip to main content

Statements

The following endpoints are responsible for statement management in the CNAB 240 standard


The Current Account Statement for Bank Conciliation allows customers to carry out bank reconciliation of their accounts in an automated and secure way, through electronic sending of the statement by the bank. For more details, download the PDF available below.



Get generated files​

This endpoint is used to retrieve the CNAB files generated and associated with a specific account.

GET /v1/extrato-cnab/arquivos
Requires authorization for the scope: gn.cnab-statement.statement.read


Request

The request sent to this endpoint doesn't need a body, just the OAuth authorization headers and the account certificate, just like the previous endpoints.

Responses

The responses below represent Success(200) and consumption failures/errors.

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

Request statement download​

This endpoint is used for Endpoint to request statement download.

GET /v1/extrato-cnab/agendamentos/:nome_arquivo
Requires authorization for the scope: gn.cnab-statement.statement.read


Request

The request sent to this endpoint doesn't need a body, just the authorization headers, OAuth, parameter and the account certificate.

Responses

The responses below represent Success(200) and consumption failures/errors.

{
  string
}

Get registered recurrences​

This endpoint is used to retrieve the recurrence schedules registered in a specific account.

GET /v1/extrato-cnab/agendamentos
Requires authorization for the scope: gn.cnab-statement.statement.read


Request

The request sent to this endpoint doesn't need a body, just the authorization headers, OAuth, parameter and the account certificate.

Responses

The responses below represent Success(200) and consumption failures/errors.

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

Create recurrence​

This endpoint is used to create a new recurrence.

POST /v1/extrato-cnab/agendar
Requires authorization for the scope: gn.cnab-statement.statement.write


Request

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

Responses

The responses below represent Success(201) and consumption failures/errors.

Recurrence successfully created

Review recurrence​

This endpoint is used to update or modify an existing recurrence from the identificador.

PATCH /v1/extrato-cnab/agendar/:identificador
Requires authorization for the scope: gn.cnab-statement.statement.write


Request

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

Responses

The responses below represent Success(201) and consumption failures/errors.

Recurrence successfully updated

Generate key​

This endpoint is used to generate a key associated with a specific account.

POST /v1/extrato-cnab/gerar-chaves
Requires authorization for the scope: gn.cnab-statement.keys.write


Request

The request sent to this endpoint doesn't need a body, just the OAuth authorization headers and the account certificate, just like the previous endpoints.

Responses

The responses below represent Success(200) and consumption failures/errors.

{
  "privateKey": "string"
}
Last updated on