v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB

Account

List

Recovers all accounts collected for the item provided

get/accounts

Query parameters

itemIdstring uuid required

Item primary identifier

type'BANK' | 'CREDIT'

Parameter to filter between bank accounts and credit accounts

Response

Retrieve a list of all accounts

pagenumber double

totalnumber double

totalPagesnumber double

Example response

{
  "results": [
    {
      "id": "a658c848-e475-457b-8565-d1fffba127c4",
      "type": "BANK",
      "subtype": "SAVINGS_ACCOUNT",
      "number": "40114687/1234",
      "name": "Conta Corrente",
      "marketingName": "SIGNATURE CJA. AHORRO PESOS",
      "balance": 120950,
      "itemId": "a0922d6f-2007-4169-a181-b961500608db",
      "taxNumber": "416.799.495-00",
      "owner": "John Doe",
      "currencyCode": "BRL",
      "createdAt": "2024-01-15T13:21:08.456Z",
      "updatedAt": "2024-07-22T18:05:11.328Z"
    }
  ]
}