v1

latestOpenAPI 3.1.02026-07-24280138.8 KB

Consulta de Extrato

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

get/statement

Query parameters

startstring date

endstring date

typestring

transaction_typestring

pageinteger

perPageinteger

aggrboolean

Response

200

Example response

{
  "start": {
    "date": "2023-04-06T00:00:00",
    "balance": 242297
  },
  "entries": [
    {
      "id": "ent_AilRQw91CRTqNucwvoeiMwg",
      "type": "DEBIT",
      "amount": 1500,
      "createdAt": "2023-04-06T09:00:00+00",
      "transaction": {
        "id": "trx_ucn77rFISfOlFcTy48GSFA",
        "type": "TRANSFER",
        "description": "Teste",
        "counterParty": {
          "name": "Test Account Company Name",
          "identity": "98537607000165"
        }
      }
    }
  ],
  "end": {
    "date": "2023-04-06T00:00:00",
    "balance": 240797
  },
  "aggregations": {
    "debitTotal": 1500
  },
  "header": {
    "businessName": "Test Account Company Name",
    "businessDocument": "54745456000889"
  }
}