Consulte informações de créditos e débitos de sua conta através dessa API

154
Importante para Integração Direta Para você conseguir efetuar essa integração é obrigatória a leitura sobre "Utilização das APIs" e recomendada a leitura sobre "Instruções Iniciais" e "Client Credentials e Client ID"

Quais são os requisitos para a utilização desta API?

  • Token: possuir um token de acesso válido é essencial. Caso ainda não tenha gerado um, temos um guia detalhado disponível no tópico Fluxos de Autorização e Autenticação.
  • Transação: para que a resposta da API seja preenchida com maiores informações, é recomendável que haja alguma transferência ou pagamento de boleto no período de tempo definido.
  • Escopo: para a modalidade Parceria Cora, é necessário ter ativado o escopo correto ao solicitar autorização e gerar token de acesso para que sua aplicação possa acessar e interagir com as informações da conta de forma segura e autorizada. É possível consultar mais detalhes sobre o escopo e autorização no tópico Redirecionamento.
Nome do escopoDescrição
accountAPI de extrato

Bora pro código?

383

Parâmetros da requisição

ParâmetroTipoDescrição
start
opcional
StringData início, no formato YYYY-MM-DD
end
opcional
StringData final, no formato YYYY-MM-DD
type
opcional
StringForma de transação no extrato. Os possíveis tipos do registro estão descritos no Enum de Tipos de Registro
transaction_type
opcional
StringTipo da transação. Os possíveis tipos do transação estão descritos no Enum de Tipos de Transação
page
opcional
IntNúmero da página
perPage
opcional
IntNúmero de itens por página
aggr
opcional
BooleanPermite incluir ou omitir o objeto Aggregations na resposta.

Parâmetros da resposta

ParâmetroTipoDescrição
start
obrigatório
StartObjeto Start
entries
opcional
EntriesLista de Objetos Entries
end
obrigatório
EndObjeto End
aggregations
opcional
AggregationsObjeto Aggregations
header
obrigatório
HeaderObjeto Header

Dicas de implementação

188

Premissas

O parâmetro start e o parâmetro end são usados para especificar o intervalo de tempo desejado na consulta. É importante notar que as datas inseridas no parâmetro end devem ser maiores que as datas informadas no parâmetro start

Problemas conhecidos

  • Solicitações que exigem um grande número de itens em uma única página, especialmente acima de 500, podem sobrecarregar o servidor, levando a um erro 504 (Time Out) ou 503 (Service Unavailable).

Erros Comuns

Código de erroDescrição
401 (Unauthorized)O token de acesso está inválido ou expirado. Erro comum no momento de trocas de ambientes (Stage/Production)
400 (Bad Request)Requisição mal formatada. Alguns exemplos comuns:

- Type que não está entre os tipos descritos em tipos de registros

- Transaction_type que não está entre os tipos descritos em tipos de transação
500 (Internal Server Error)Falha interna no servidor ao tentar atender requisição. Exemplo:

- O Start e/ou End está com o formato errado. Para garantir que as informações sejam interpretadas e processadas corretamente pelo sistema, é essencial inseri-las no formato YYYY-MM-DD. Um exemplo prático pode ajudar a entender melhor: suponha que você deseja consultar os boletos a partir do dia 15 de janeiro de 2023. Neste caso, a data deve ser informada como 2023-01-15
503 (Service Unavailable)Indica que o servidor não está disponível no momento para lidar com a requisição devido a uma sobrecarga temporária ou manutenção em andamento
504 (Time Out)Significa que o servidor aguardou uma resposta de outro servidor por muito tempo e acabou expirando o tempo limite de espera. Isso pode ser causado por um problema de conectividade ou sobrecarga no servidor de origem

Tipos de Objetos

Objeto Start

ParâmetroTipoDescrição
date
obrigatório
StringData em que ocorreu a primeira movimentação após a data especificada no parâmetro start. Estará vazio caso não haja movimentação no período definido na consulta
balance
obrigatório
IntSaldo em centavos da conta na data da primeira movimentação

Objeto Entries

ParâmetroTipoDescrição
id
obrigatório
StringNome do seu cliente (máximo 60 caracteres)
type
obrigatório
StringForma de transação no extrato. Os possíveis tipos do registro estão descritos no Enum de Tipos de Registros
amount
obrigatório
IntValor total em centavos da transação
createdAt
obrigatório
StringData de criação da transação
transaction
obrigatório
TransactionObjeto Transaction

Objeto End

ParâmetroTipoDescrição
date
obrigatório
StringData em que ocorreu a última movimentação antes da data especificada no parâmetro end. Estará vazio caso não haja movimentação no período definido na consulta
balance
obrigatório
IntSaldo em centavos da conta na data da última movimentação

Objeto Aggregations

ParâmetroTipoDescrição
creditTotal
obrigatório
IntSoma dos valores listados que entraram na conta, como operação de crédito
debitTotal
obrigatório
IntSoma dos valores listados que saíram na conta, como operação de débito

Objeto Header

ParâmetroTipoDescrição
businessName
obrigatório
StringTitular do extrato
businessDocument
obrigatório
StringDocumento de identificação do detentor do extrato, apenas em números

Objeto Transaction

ParâmetroTipoDescrição
id
obrigatório
StringIdentificador do pagamento ou transferência
type
obrigatório
StringForma de transação no extrato. Os possíveis tipos do registro estão descritos no Enum de Tipos de Registros
description
obrigatório
StringDescrição da transação
counterParty
obrigatório
CounterPartyObjeto CounterParty

Objeto CounterParty

ParâmetroTipoDescrição
name
obrigatório
StringNome da contraparte na transação
identity
obrigatório
StringDocumento de identificação da contraparte na transação, apenas com números

Tipos de Enumeradores

Enum de Tipos de registro

ParâmetroDescrição
CREDITTipo crédito, quando o valor é adicionado a conta, ou seja, quando há entrada do dinheiro.
DEBITTipo débito, quando o valor é subtraído da conta, ou seja, quando há saída de dinheiro.

Enum de Tipos de transação

ParâmetroDescrição
TRANSFERTipo transferência, quando o valor é movimentado de uma conta para outra.
PAYMENTTipo pagamento, usado para indicar pagamento de um valor em troca de bem ou serviço, como o pagamento de um boleto.
PIXTipo Pix, utilizado para identificar as transferências instantâneas (Pix).
FEETipo taxa, usado para indicar taxas Cora.

Integração Direta e Testes

Esta plataforma de documentação, atualmente, não permite o upload de informações importantes como certificados e private keys. Por isso, não recomendamos o uso dela para testes da modalidade de Integração Direta.

Para fazer os testes que incluam essas informações sensíveis pedimos que use um sistema de sua escolha.
Caneca na cor rosa com a logo da Cora e com forma geométrica
Agora é hora do Café! Sim, aprendemos a consultar extratos
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!