{
  "sucesso": true,
  "mensagem": "<string>",
  "dtExtrato": "2023-11-07T05:31:56Z",
  "movimentos": [
    {
      "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "codigoTransacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dtMovimento": "2023-11-07T05:31:56Z",
      "dtMovimentoUtc": "2023-11-07T05:31:56Z",
      "descricaoOperacao": "<string>",
      "tipoLancamento": "<string>",
      "vlrMovimento": 123,
      "nsu": 123,
      "codOperacaoCli": "<string>",
      "descCliente": "<string>",
      "documentoFederal": "<string>",
      "nome": "<string>",
      "operador": "<string>",
      "origemTransacao": 0,
      "bancoOrigem": "<string>",
      "agenciaOrigem": "<string>",
      "contaOrigem": "<string>",
      "identificadorOperacao": "<string>",
      "saldoFinalDia": 123,
      "origemMovimento": "<string>",
      "complemento": "<string>",
      "pixQrCode": true,
      "nomeDestinatario": "<string>",
      "documentoDestinatario": "<string>",
      "dadosBancarioDestinatario": "<string>",
      "numeroControle": "<string>",
      "descricao": "<string>"
    }
  ]
}
Through this endpoint, partners can request a bank statement of the account’s activity, allowing them to view the history of debit and credit transactions that occurred during the specified period.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

​
DiaInicial
integer

Dia inicial do período de consulta.

Observações:

  • O 'dia inicial do período de consulta' (diaInicial) deve estar entre o 1º e o último dia do 'mês' (mes) informado.
  • O 'dia inicial do período de consulta' (diaInicial) deve ser anterior ao 'dia final do período de consulta' (diaFinal) informado.
  • Quando for informado o 'dia inicial do período de consulta' (diaInicial) também deverá ser informado o 'dia final do período de consulta' (diaFinal).
​
DiaFinal
integer

Dia final do período de consulta.

Observações:

  • O 'dia final do período de consulta' (diaFinal) deve estar entre 1º e o último dia do 'mês' (mes) informado.
  • O 'dia final do período de consulta' (diaFinal) deve ser posterior ao 'dia inicial do período de consulta' (diaInicial) informado.
  • Quando for informado o 'dia final do período de consulta' (diaFinal) também deverá ser informado o 'dia inicial do período de consulta' (diaInicial).
​
Mes
integer
required

Mês do período de consulta.

Observação:

  • O 'mês do período de consulta' (mes) deve estar entre 1 e 12.
Required range: 1 <= x <= 12
​
Ano
integer
required

Ano do período de consulta.

Observação:

  • O 'ano do período de consulta' (ano) deve estar entre 2019 e o ano atual.
​
NumeroBanco
integer
required

Número do banco.

Observação:

  • O 'número do banco' (numeroBanco) pode ter no máximo 3 caracteres.
​
Conta.Agencia
string
required

Número da agência bancária.

Maximum length: 4
​
Conta.AgenciaDigito
string

Dígito verificador da agência bancária.

Maximum length: 1
​
Conta.Conta
string

Número da conta bancária.

Observações:

  • Para que seja possível localizar a conta, é necessário informar o 'número da conta com dígito' (contaPgto) ou o 'número da conta' (conta) e o 'dígito verificador' (contaDigito).
  • Caso o 'número da conta com dígito' (contaPgto) seja informado, não é necessário preencher os campos 'número da conta' (conta) e 'dígito verificador' (contaDigito).
  • Caso nenhum dos campos referentes ao número da conta seja informado, ocorrerá erro na requisição devido à falta de informação vital.
Maximum length: 12
​
Conta.ContaDigito
string

Dígito verificador do número da conta bancária.

Maximum length: 1
​
Conta.ContaPgto
string

Número da conta bancária seguido do dígito verificador.

Maximum length: 20
​
Conta.TipoConta
enum<integer>
required

1 = CACC<br>2 = SVGS<br>3 = TRAN<br>4 = SLRY 1 = CACC; 2 = SVGS; 3 = TRAN; 4 = SLRY

Available options:
1,
2,
3,
4
​
Conta.ModeloConta
enum<integer>
required

1 = Movimento<br>2 = Escrow<br>3 = Vinculada 1 = Movimento; 2 = Escrow; 3 = Vinculada

Available options:
1,
2,
3

Response

200 - application/json

Success

The response is of type object.