37 - Check Statement
Scopes:
api.ext api.conta.extratoThrough 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
Copie 'Bearer ' + token
Query Parameters
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
).
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
).
Mês do período de consulta.
Observação:
- O 'mês do período de consulta' (
mes
) deve estar entre 1 e 12.
1 <= x <= 12
Ano do período de consulta.
Observação:
- O 'ano do período de consulta' (
ano
) deve estar entre 2019 e o ano atual.
Número do banco.
Observação:
- O 'número do banco' (
numeroBanco
) pode ter no máximo 3 caracteres.
Número da agência bancária.
4
Dígito verificador da agência bancária.
1
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.
12
Dígito verificador do número da conta bancária.
1
Número da conta bancária seguido do dígito verificador.
20
1 = Corrente<br>2 = Poupanca<br>3 = Pagamento<br>4 = Salario 1 = Corrente; 2 = Poupanca; 3 = Pagamento; 4 = Salario
1
, 2
, 3
, 4
1 = Movimento<br>2 = Escrow<br>3 = Vinculada 1 = Movimento; 2 = Escrow; 3 = Vinculada
1
, 2
, 3
Response
Success
The response is of type object
.