v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Conta PJ

Consultar extrato por accountId

get/{companyId}/banking/accounts/{accountId}/statements

Path parameters

companyIdstring required
Example:29964797000111

CNPJ da empresa

accountIdstring required
Example:29964797000111-555-1-777776752

id da conta

Query parameters

startDatestring required
Example:2099-12-15

Data para inicio da Listagem

endDatestring required
Example:2099-12-19

Data para fim da Listagem

type'simple' | 'withdraw-applications' | 'yields' required

Tipo de listagem. simple = Sem rendimentos. withdraw-applications = Com rendimentos, aplicações e resgates. yields = Com rendimentos

pageSizestring
Example:1000

Quantidade de registros por página

Response

Successful response

Example response

{
  "_links": {
    "rel": "self",
    "href": "/direct-debits/d2627834-dd84-4094-9dcf-ca784460b352",
    "method": "DELETE",
    "type": "application/json"
  },
  "data": {
    "balance": {
      "initial": 30.03,
      "current": 15.53,
      "final": 15.53
    },
    "dailyMovements": [
      {
        "date": "2024-03-07T00:00:00.000Z",
        "balance": 3,
        "movements": [
          {
            "id": 1234,
            "type": "debit",
            "category": {
              "name": "PIX",
              "description": "PIX"
            },
            "description": "Pix realizado",
            "dateHour": "2024-05-08T10:49:15.000Z",
            "amount": 0.25,
            "descriptionDetails": "Banco 201 | CPF ***.926.338-**",
            "txId": "fd64be97df4546a7ab2ab1",
            "endToEndId": "E2302385204412985",
            "details": {
              "originId": "46a20277-0709-4167-a10a-eb39e468c35a",
              "barcode": "00020101021226860010000000000000000000",
              "ourNumber": "12345678901234567890"
            }
          }
        ]
      }
    ]
  }
}