Skip to main content

Get product account balances

GET 
/v1/operations/balances/product-accounts
Tag: api-baas-get-operations-balances-product-accountsDescription: Balance of each account of the product, at the end of a day or at a specific moment, page by page.Accounts: only accounts with at least one transaction up to the reference moment. An account that never had a transaction is not returned; one with transactions and balance 0 is.Pagination: call again with the returned page_state, keeping the same type, reference and currencies, until has_next_page is false. Pages refer to the same moment even if requested hours apart, and their balances add up to total_balance of the product summary.

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.

    size number

    Possible values: >= 1 and <= 5000

    Accounts per page. Default 1000, maximum 5000.

    page_state string

    Page state returned by the previous page. Omit it to get the first page. It only works with the same type and reference of the request that returned it.

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​

Product account balances returned successfully.

Schema
    type stringrequired

    Possible values: [END_OF_DAY, POINT_IN_TIME]

    Balance reference type.

    reference_at stringrequired

    Moment the balances refer to (UTC-3).

    data object[]required

    Account balances of the page.

  • Array [
    • user_uuid stringrequired

    Account (user) identifier.

    user_document string

    CPF/CNPJ of the account owner, unmasked.

    wallet_uuid stringrequired

    Wallet identifier.

    wallet_account_uuid stringrequired

    Wallet account identifier, the wallet balance in one currency.

    currency_symbol stringrequired

    Currency symbol.

    balance numberrequired

    Balance in cents (135025 = R$ 1,350.25).

    last_transaction_at stringnullablerequired

    Last transaction up to the reference moment (UTC-3).

  • ]
    • has_next_page booleanrequired

    True while there are more accounts.

    page_state string

    Send it as page_state to get the next page.

Loading...