Get product balance summary

GET 
/v1/operations/balances/product-summary

Tag: api-baas-get-operations-balances-product-summaryDescription: Sum of the balances of every account of the product, per currency, at the end of a day or at a specific moment.Accounts: every product account with at least one transaction up to the reference moment. An account that never had a transaction is not included; one with transactions and balance 0 is.History: available since the product was created.

Request

Query Parameters

type stringrequired

Possible values: [END_OF_DAY, POINT_IN_TIME]

Balance reference type. END_OF_DAY: balance at 23:59:59 (UTC-3) of reference_date. POINT_IN_TIME: balance at reference_at.

reference_date date

Reference date (YYYY-MM-DD). Required when type is END_OF_DAY. Available from 00:15 (UTC-3) of the next day.

reference_at string

Reference moment, ISO 8601 with time zone offset (encode "+" as "%2B" in the URL). Required when type is POINT_IN_TIME. Must be at least 5 minutes before the request.

currency_symbols string

Comma-separated currency symbols. Default: BRL.

Header Parameters

nonce stringrequired

The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

x-product-uuid stringrequired

UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

x-product-target-user-uuid string

UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

x-lang string

Possible values: [pt-BR, en-US]

Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

Responses

200

Product balance summary returned successfully.

application/json

Schema

Schema

type stringrequired

Possible values: [END_OF_DAY, POINT_IN_TIME]

Balance reference type.

reference_at stringrequired

Moment the balance refers to (UTC-3).

balances object[]required
Total balance per currency.
Array [
currency_symbol stringrequired
Currency symbol.
total_balance numberrequired
Sum of the balances of every product account in this currency, in cents (1000000 = R$ 10,000.00).
accounts_count numberrequired
Number of product accounts in this currency with at least one transaction up to the reference moment, with or without balance.
]

Example (from schema)

{
  "type": "END_OF_DAY",
  "reference_at": "2026-11-10T23:59:59-03:00",
  "balances": [
    {
      "currency_symbol": "BRL",
      "total_balance": 1000000,
      "accounts_count": 10
    }
  ]
}

400

If any required params are missing or has invalid format or type.

401

User authentication failed.

403

If the user does not have the api-baas-get-operations-balances-product-summary permission or the product does not have the api-baas-balance product permission.

422

If the reference is in the future, less than 5 minutes old, END_OF_DAY before 00:15 (UTC-3) of the next day, before the available history, a currency is not found, or no product account has a transaction up to the reference in the currencies asked (PRODUCT_BALANCE_TRANSACTION_NOT_FOUND).

Loading...