{
  "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>"
    }
  ]
}
Por meio deste endpoint, o parceiro pode solicitar um extrato bancário da movimentação da conta, e assim visualizar o histórico das transações de débito e crédito que ocorreram no período solicitado.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

​
DiaInicial
integer

Data inicial do período de consulta.

​
DiaFinal
integer

Data final do período de consulta.

​
Mes
integer

Mês do período de consulta.

​
Ano
integer

Ano do período de consulta.

​
NumeroBanco
integer

Número do Banco.

​
Conta.Agencia
string

Número da Agência Bancária.

​
Conta.AgenciaDigito
string

Dígito verificador da Agência Bancária.

​
Conta.Conta
string

Número da Conta Bancária.

​
Conta.ContaDigito
string

Dígito verificador do número da Conta Bancária.

​
Conta.ContaPgto
string

Número da Conta Bancária seguido do dígito verificador.

​
Conta.TipoConta
enum<integer>

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>

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

Available options:
1,
2,
3

Response

200 - application/json

Success

​
sucesso
boolean

Indica se a operação foi realizada com sucesso.

​
mensagem
string | null

Descrição detalhada do resultado da operação, incluindo informações sobre erros ou mensagens complementares.

​
dtExtrato
string<date-time>
​
movimentos
object[] | null