Extrato

GET/api/v2/contas/extrato

Consulta lançamentos da conta autenticada. Scope: contas.extrato.read. Query: data_inicio, data_fim, offset, limit (obrigatórios); tipo opcional (saida|entrada). Offset base 0.

Parâmetros

AcceptObrigatório

header

Tipo:string

data_inicioObrigatório

query

Tipo:string

data_fimObrigatório

query

Tipo:string

tipoOpcional

query

Tipo:string

offsetObrigatório

query

Tipo:integer

limitObrigatório

query

Tipo:integer

Autenticação e scopes

Requer Bearer token. Scope: contas.extrato.read.

Headers

Header	Obrigatório	Descrição
`Authorization`	Sim	`Bearer {{access_token}}`
`Accept`	Sim	`application/json`

Query

Param	Obrigatório	Descrição
`data_inicio`	Sim	Início (`YYYY-MM-DD` ou ISO 8601); ≤ `data_fim`
`data_fim`	Sim	Fim do período
`tipo`	Não	`saida` ou `entrada`
`offset`	Sim	Offset base 0
`limit`	Sim	Máximo de registros

Retorno 200

Lançamentos no nível raiz (chaves "0", "1", …) + correlationId. Cada item inclui type (credit/debit), description, campos movement_type_*, transaction, payer, receiver.

Response 422

Parâmetros ausentes/inválidos — envelope com violacoes.

Notas

Técnica: Consultar extrato.

curl --location 'https://api-h.nuvende.com.br/api/v2/contas/extrato?data_inicio=2024-01-01&data_fim=2024-01-30&tipo=saida&offset=0&limit=10' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{ access_token }}'

{
  "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,
      "endToEndId": "E38297374202401151234ABCDEF12345",
      "value": 150.0,
      "processDate": "2024-01-15T14:30:00.000000Z",
      "key": "[email protected]",
      "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"
}