summary

GET

/api/user/transfers/summary

Este endpoint permite consultar um resumo geral das transferências realizadas por um recebedor autenticado.
O resumo pode incluir totais por status (ex: pagas, pendentes, processando), valores acumulados, entre outros indicadores úteis.

✅ Requisitos da Requisição

Método HTTP: GET

Endpoint: /api/user/transfers/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/transfers/summary' \
--header 'x-api-key: {Token}' \
--header 'User-Agent: AtivoB2B/1.0'

Response Example

200 - Success

{
  "status": 200,
  "message": "Resumo das transferências encontrado com sucesso",
  "data": {
    "transferPercentege": 0,
    "transferReceived": 0,
    "amountAvailable": 10000,
    "fee": 0,
    "remainingAmount": 10000,
    "pixKey": "00000000000000",
    "payee": {
      "id": "XXXXX",
      "gatewayId": "XXXXX",
      "sellerId": "XXXXX",
      "bankName": "Cooperativa Central de Credito Noroeste Brasileiro",
      "bankCode": "097",
      "agency": "000",
      "account": "00000",
      "digit": "00",
      "status": "ACTIVE",
      "type": "CHECKING",
      "createdAt": "2025-04-16T18:13:41.883Z",
      "updatedAt": "2025-04-16T18:13:41.883Z"
    },
    "userName": "XXXXX"
  },
  "error": null
}

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

Find by ID

Create

summary

✅ Requisitos da Requisição#

🧠 Header da requisição#

Request

Responses

✅ Requisitos da Requisição

🧠 Header da requisição