Conta
Consultar extrato
Consulta lançamentos da conta em um período
Consulta lançamentos da conta associada ao token em um período, com paginação por offset.
Referência API: GET /api/v2/contas/extrato.
Request
GET /api/v2/contas/extrato?data_inicio=2024-01-01&data_fim=2024-01-30&tipo=saida&offset=0&limit=10
Authorization: Bearer {access_token}
Accept: application/json
| Header | Obrigatório | Descrição |
|---|---|---|
Authorization | Sim | Bearer {{access_token}} |
Accept | Sim | application/json |
Scope: contas.extrato.read.
Query
| Param | Obrigatório | Descrição |
|---|---|---|
data_inicio | Sim | Início do período (YYYY-MM-DD ou ISO 8601). Deve ser ≤ data_fim |
data_fim | Sim | Fim do período |
tipo | Não | saida (débitos) ou entrada (créditos) |
offset | Sim | Deslocamento da paginação, base 0 (não é número de página) |
limit | Sim | Quantidade máxima de registros |
Prefira datas no formato YYYY-MM-DD.
curl --location 'https://api-h.nuvende.com.br/api/v2/contas/extrato?data_inicio=2024-01-01&data_fim=2024-01-30&offset=0&limit=10' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{access_token}}'
Response 200
A resposta traz os lançamentos no nível raiz (chaves "0", "1", …) e correlationId:
{
"0": {
"unique_request_identifier": 271274,
"type": "debit",
"description": "Pix enviado",
"movement_type_id": 23,
"movement_type_description": "Envio de valor por meio do sistema Pix.",
"movement_type_category": "cash_out",
"movement_type_name": "Pix enviado",
"transaction": {
"id": 12345,
"idReq": "uuid-da-requisicao",
"endToEndId": "E38297374202401151234ABCDEF12345",
"value": 150.0,
"processDate": "2024-01-15T14:30:00.000000Z",
"key": "[email protected]",
"description": "Pagamento",
"type": "DICT",
"status": "CONCLUIDO"
},
"payer": {
"name": "Pagador Exemplo",
"document": "12345678901",
"account_number": "12345",
"agency_number": "0001"
},
"receiver": {
"name": "Recebedor Exemplo",
"document": "98765432100",
"account_number": "54321",
"agency_number": "0001"
}
},
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
| Campo | Descrição |
|---|---|
type | credit (entrada) ou debit (saída) |
description | Descrição do lançamento |
movement_type_id | ID do tipo de movimento |
movement_type_name | Nome do tipo |
movement_type_category | Ex.: cash_in, cash_out, revenue |
movement_type_description | Texto descritivo do tipo |
transaction | Detalhes da transação Pix quando aplicável; pode ser null |
payer / receiver | Contrapartes |
correlationId | ID de correlação |
Só entram lançamentos processados e habilitados para extrato.
Response 422
{
"type": "https://pix.bcb.gov.br/api/v2/error/OperacaoInvalida",
"title": "Operação inválida.",
"status": 422,
"detail": "Requisição no formato inválido, ou realizando alguma operação não permitida",
"violacoes": {
"data_inicio": ["The data inicio field is required."],
"offset": ["The offset field is required."],
"limit": ["The limit field is required."]
}
}
Boas práticas
- Intervalos limitados; pagine com
offset/limit. data_inicio≤data_fim.- Em 401, renove o token; em 403, confira o scope no login.