Guides/GuiasReferência APICryptoBrokers

Listando todas as transações do usuário

Este endpoint permite listar todas as transações associadas ao usuário autenticado, incluindo informações detalhadas sobre cada operação (PIX, transferências, etc.) e suporte a paginção para facilitar a navegação em grandes conjuntos de dados.

Requisição 

curl https://api.etherglobalassets.com.br/transactions \
  --header 'Authorization: Bearer <token>'

Parâmetros Opcionais (Query Params):

  • page: Número da página (padrão: 1).

  • limit: Itens por página (padrão: 10).

  • type: Filtrar por tipo de transação (ex.: PIX_CASH_OUT).

  • status: Filtrar por status (ex.: COMPLETED).

Respostas Possíveis

✅ 200 - Sucesso
Retorna a lista de transações com metadados e paginação.

{
  "data": [
    {
      "id": "50546280-a3dd-4cdd-961d-000000000000",
      "type": "PIX_CASH_OUT",
      "provider": "DEFAULT_PROVIDER",
      "amount": -99,
      "netAmount": -100,
      "stablecoinAmount": null,
      "status": "COMPLETED",
      "metadata": {
        "pixId": "46522a65-dd1a-40cf-aaa2-000000000000",
        "pixKey": "09822333333",
        "entityId": "3b90ef44-36cb-41d8-a0e4-000000000000",
        "tenantId": "9a43ae9c-d7f2-43c6-a7d4-000000000000",
        "netAmount": -100,
        "entityType": "USER",
        "pixKeyType": "CPF",
        "grossAmount": 100,
        "originalAmount": 100,
        "originalPayerId": "3b90ef44-36cb-41d8-a0e4-000000000000",
        "transactionType": "PIX_CASH_OUT"
      },
      "balanceAfter": 81,
      "totalFeeAmount": 1,
      "balanceBefore": 182,
      "createdAt": "2025-04-03T01:35:27.977Z",
      "updatedAt": "2025-04-03T01:35:27.977Z",
      "originalPayerId": "3b90ef44-36cb-41d8-a0e4-000000000000",
      "currency": "BRL"
    }
  ],
  "pagination": {
    "itens": 1,
    "totalItens": 4,
    "totalPages": 4,
    "page": 1,
    "limit": 1
  },
  "filters": {}
}

❌ 400 - Validação Falhou
Erros nos parâmetros de consulta (ex.:

page

inválida).

{
  "success": false,
  "message": "Validation failed",
  "errors": [
    "Validation error 1",
    "Validation error 2"
  ]
}

🔒 401 - Acesso Não Autorizado
Token inválido ou expirado.

{
  "success": false,
  "message": "Unauthorized access"
}

⚠️ 500 - Erro Interno do Servidor
Falha inesperada durante a consulta.

{
  "success": false,
  "message": "Internal server error"
}

Campos Destacados na Resposta 200

  • Transações (data):

    • type: Tipo da transação (ex.: PIX_CASH_OUT).

    • status: Status atual (ex.: COMPLETED).

    • amount/netAmount: Valores líquidos e brutos.

    • metadata: Detalhes específicos (ex.: chave PIX, IDs relacionados).

    • balanceBefore/balanceAfter: Saldo antes e após a transação.

  • Paginação (pagination):

    • Controle de páginas (totalPages, page, limit).

Exemplo de Uso Prático

  1. Autentique-se para obter o Access Token.

  2. Envie a requisição (com ou sem filtros):

    curl 'https://api.etherglobalassets.com.br/transactions?page=2&limit=5&type=PIX_CASH_OUT' \
  --header 'Authorization: Bearer <token>'

  3. Trate a resposta:

    • Use pagination para implementar navegação no frontend.

    • Extraia metadata para detalhamento em interfaces.

Dicas:

  • Para otimizar performance, use limit em conjuntos grandes de dados.

  • Campos como amount podem ser formatados em BRL (ex.: R$ -100,00).

Exemplo em Python (opcional):

import requests

url = "https://api.etherglobalassets.com.br/transactions"
headers = {"Authorization": "Bearer <token>"}
params = {"page": 1, "limit": 10}

response = requests.get(url, headers=headers, params=params)
if response.status_code == 200:
    transactions = response.json()["data"]
    print("Transações:", transactions)
else:
    print("Erro:", response.json())

Observações:

  • Transações com amount negativo representam saídas (débitos).

  • O campo filters na resposta pode ser usado para reconstruir filtros ativos no frontend.

Mais informações sobre o endpoint:

Acesse aqui