---
title: "Consultar o extrato da conta"
method: GET
path: "/escrow/api/v1/accounts/{account_id}/statement"
tags: ["Contas"]
---

# Consultar o extrato da conta

`GET /escrow/api/v1/accounts/{account_id}/statement`

## Request

- Base URL: `https://sandbox.platform.credit.celcoin.com.br`
- URL: `https://sandbox.platform.credit.celcoin.com.br/escrow/api/v1/accounts/{account_id}/statement`
- Auth: none declared

Esse endpoint é responsável por retornar o extrato da conta escrow, uma lista paginada de transações e solicitações realizadas. É possível realizar uma série de filtros, ordenações e navegar entre as páginas de resultados.

#### Parâmetros da URL

- `account_id` (string): ID de cadastro para identificação da conta a ser consultada.
    

#### Parâmetros da Requisição

- `dateFrom` (datetime, obrigatório): Data de ínicio para filtro.
    
- `dateTo` (datetime, obrigatório): Data de fim para filtro.
    
- `balanceType` (string): Tipo da transação.
    
- `sort` (string): Campo para ordenação dos resultados. Possíveis valores: id, createDate, clientCode.
    

#### Resposta

Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato:

- `content`(object list): Objeto contendo a lista com o resultado do filtro realizado.
    
- hasNext (boolean): Campo para indicar se tem uma próxima página.
    
- totalElements (int): Quantidade total de registros retornados para a busca realizada.
    
- totalPages (int): Quantidade total de páginas retornadas para a busca realizada.
    

##### Objeto 'content'

- `id` (string): ID para identificação da transação.
    
- `clientCode` (string): Identificador único gerado pelo cliente.
    
- `description` (string): Descrição do comprovante da transação.
    
- `createDate` (datetime): Data de registro da transação.
    
- `lastUpdateDate` (datetime): Data da última atualização efetuada.
    
- `amount` (float): Valor da transação.
    
- `status` (string): Status do processamento.
    
- `balanceType` (string): Tipo .
    
- `moventType` (string): Tipo da movimentação.
    
- `balance` (float): Saldo final.
    
- `additionalInformation -> nameCredit` (string): .
    
- `additionalInformation -> nameDebit` (string): .
    

##### Exemplo de JSON:

``` json
{
    "content": [
        {
        "id": "<string>",
        "clientCode": "<string>",
        "description": "<string>",
        "createDate": "<string>",
        "lastUpdateDate": "<string>",
        "amount": "<number>",
        "status": "<string>",
        "balanceType": "<string>",
        "movementType": "<string>",
        "balance": "<number>",
        "additionalInformation": {
            "nameCredit": "<string>",
            "nameDebit": "<string>"
        }
        },
        {
        "id": "<string>",
        "clientCode": "<string>",
        "description": "<string>",
        "createDate": "<string>",
        "lastUpdateDate": "<string>",
        "amount": "<number>",
        "status": "<string>",
        "balanceType": "<string>",
        "movementType": "<string>",
        "balance": "<number>",
        "additionalInformation": {
            "nameCredit": "<string>",
            "nameDebit": "<string>"
        }
        }
    ],
    "hasNext": "<boolean>",
    "totalElements": "<number>",
    "totalPages": "<number>"
}

 ```

## Path parameters

- `account_id` string, required

## Query parameters

- `dateFrom` string
- `dateTo` string

## Headers

- `Accept` string

## Response `200`

OK

- object

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/celcoin/apis/celcoin-escrow.md) - [All operations](https://skmtc.dev/celcoin/apis/celcoin-escrow/llms.txt) - [OpenAPI document](https://skmtc.dev/celcoin/apis/celcoin-escrow/revisions/5d55a35a6d51?raw)