get
https://api.stage.cora.com.br/bank-statement/statement
Consulte informações de créditos e débitos de sua conta através dessa API
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 escopo | Descrição |
|---|---|
account | API de extrato |
Parâmetros da requisição
| Parâmetro | Tipo | Descrição |
|---|---|---|
| start opcional | String | Data início, no formato YYYY-MM-DD |
| end\ opcional | String | Data final, no formato YYYY-MM-DD |
| type\ opcional | String | Filtra os lançamentos por CREDIT (entradas) ou DEBIT (saídas). Se omitido, retorna créditos e débitos misturados. Não confundir com transaction_type.Os possíveis tipos do registro estão descritos no Enum de Tipos de Registro |
| transaction_type\ opcional | String | Tipo da transação. Os possíveis tipos do transação estão descritos no Enum de Tipos de Transação |
| page\ opcional | Int | Número da página |
| perPage\ opcional | Int | Número de itens por página. Padrão: 50. Máximo: 500. |
| aggr\ opcional | Boolean | Se não enviado, os totais Aggregations vêm por padrão na resposta. Envie aggr=false para omiti-los |
Parâmetros da resposta
| Parâmetro | Tipo | Descrição |
|---|---|---|
| start obrigatório | Start | Objeto Start |
| entries\ opcional | Entries | Lista de Objetos Entries |
| end\ obrigatório | End | Objeto End |
| aggregations\ opcional | Aggregations | Objeto Aggregations |
| header\ obrigatório | Header | Objeto Header |
Dicas de implementação
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 startProblemas 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 erro | Descriçã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:
- 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âmetro | Tipo | Descrição |
|---|---|---|
| date obrigatório | String | Data 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 | Int | Saldo em centavos da conta na data da primeira movimentação |
Objeto Entries
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id obrigatório | String | Nome do seu cliente (máximo 60 caracteres) |
| type\ obrigatório | String | Forma de transação no extrato. Os possíveis tipos do registro estão descritos no Enum de Tipos de Registros |
| amount\ obrigatório | Int | Valor total em centavos da transação |
| createdAt\ obrigatório | String | Data de criação da transação |
| transaction\ obrigatório | Transaction | Objeto Transaction |
Objeto End
| Parâmetro | Tipo | Descrição |
|---|---|---|
| date obrigatório | String | Data 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 | Int | Saldo em centavos da conta na data da última movimentação |
Objeto Aggregations
| Parâmetro | Tipo | Descrição |
|---|---|---|
| creditTotal obrigatório | Int | Soma de todos os créditos do período consultado (start–end), independente da paginação. Não corresponde à soma dos lançamentos retornados nesta página. |
| debitTotal\ obrigatório | Int | Soma de todos os débitos do período consultado (start–end), independente da paginação. Não corresponde à soma dos lançamentos retornados nesta página. |
Objeto Header
| Parâmetro | Tipo | Descrição |
|---|---|---|
| businessName obrigatório | String | Titular do extrato |
| businessDocument\ obrigatório | String | Documento de identificação do detentor do extrato, apenas em números |
Objeto Transaction
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id obrigatório | String | Identificador do pagamento ou transferência |
| type\ obrigatório | String | Forma de transação no extrato. Os possíveis tipos do registro estão descritos no Enum de Tipos de Registros |
| description\ obrigatório | String | Descrição da transação |
| counterParty\ obrigatório | CounterParty | Objeto CounterParty |
Objeto CounterParty
| Parâmetro | Tipo | Descrição |
|---|---|---|
| name obrigatório | String | Nome da contraparte na transação |
| identity\ obrigatório | String | Documento de identificação da contraparte na transação, apenas com números |
Tipos de Enumeradores
Enum de Tipos de registro
| Parâmetro | Descrição |
|---|---|
| CREDIT | Tipo crédito em saldo disponível, quando o valor é adicionado a conta, ou seja, quando há entrada do dinheiro. |
| DEBIT | Tipo débito em saldo disponível, quando o valor é subtraído da conta, ou seja, quando há saída de dinheiro. |
| UNBLOCK | Tipo crédito em saldo disponível, quando o valor é creditado ao saldo disponível |
| BLOCK | Tipo débito em saldo disponível, quando o valor é debitado do saldo disponível |
Enum de Tipos de transação
Enumeração aberta — novos valores podem ser adicionados sem aviso prévio de versão. Integrações não devem falhar nem descartar a entrada ao encontrar um valor fora desta lista; trate como categoria genérica.
| Parâmetro | Descrição |
|---|---|
| TRANSFER | Tipo transferência, quando o valor é movimentado de uma conta para outra. |
| PAYMENT | Tipo pagamento, usado para indicar pagamento de um valor em troca de bem ou serviço, como o pagamento de um boleto. |
| PIX | Tipo Pix, utilizado para identificar as transferências instantâneas (Pix). |
| FEE | Tipo taxa, usado para indicar taxas Cora. |
| JUD_BLOCKER | Tipo transação judicial, quando o valor é movimentado por uma ordem judicial |
| BANK_DOMICILE | Tipo transação de recebimento de transações de cartão via domiciliação de recebíveis, como recebíveis de link de pagamento |
| CARD | Tipo operação de cartão, quando o valor é movimentado usando um cartão de débito |
| LIMIT_RESERVATION | Tipo operação interna, movimentação de saldo para reserva de limite de cartão de crédito |
Agora é hora do Café!
Sim, aprendemos a consultar extratos