Summary

GET

/api/user/balance-history/summary

Este endpoint permite consultar um resumo consolidado do saldo do usuário autenticado. Ele retorna informações agregadas, como o saldo atual, entradas e saídas totais.

✅ Requisitos da Requisição

Método HTTP: GET

Endpoint: /api/user/balance-history/summary

Content-Type: application/json

Autenticação: api_token

🧠 Header da requisição

Campo	Tipo	Obrigatório	Descrição
`x-api-key`	string	Sim	Token de autenticação API Key
`User-Agent`	AtivoB2B/1.0	Sim

Request

Header Params

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/user/balance-history/summary' \
--header 'x-api-key: {Token}' \
--header 'User-Agent: AtivoB2B/1.0'

Response Example

200 - Success

{
    "message": "Sumário de recebimentos encontrado com sucesso.",
    "data": {
        "balanceHistory": 10000,
        "withheldBalance": 10000,
        "financialReserve": 2600,
        "amountToReceive": 304959
    },
    "status": 200,
    "error": null
}

Modified at 2025-07-23 19:02:40

Find

Find finalcial reserve

Summary

✅ Requisitos da Requisição#

🧠 Header da requisição#

Request

Responses

✅ Requisitos da Requisição

🧠 Header da requisição