Guides/GuiasReferência APICryptoBrokers

Obtendo uma transação do usuário pelo id da transação

Este endpoint permite consultar os detalhes completos de uma transação específica do usuário autenticado, utilizando o ID da transação. Retorna informações financeiras, participantes (pagador/beneficiário) e metadados específicos (ex.: dados PIX).

Requisição 

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

Parâmetros:

  • Path Parameter

    • id (string): ID único da transação.

  • Header

    • Authorization: Token de acesso no formato Bearer <token>.

Respostas Possíveis

✅ 200 - Sucesso
Retorna os dados completos da transação, organizados em categorias:

{
  "transaction": {
    "id": "f03f3a4f-4412-4626-8f9a-000000000000",
    "type": "PIX_CASH_IN",
    "status": "COMPLETED",
    "currency": "BRL",
    "createdAt": "2025-04-03T01:20:10.761Z",
    "updatedAt": "2025-04-03T01:20:10.761Z"
  },
  "financial": {
    "amount": 184,
    "netAmount": 184,
    "balanceAfter": 184,
    "balanceBefore": 0,
    "totalFeeAmount": 1
  },
  "participants": {
    "originalPayer": {
      "id": null,
      "name": "Naudo Silva",
      "document": "09822333333",
      "bank": {
        "code": "023",
        "ispb": "60744444",
        "name": "Banco do Brasil"
      },
      "account": {
        "type": "CONTA_CORRENTE",
        "digit": "1",
        "agency": "0002",
        "number": "029983"
      }
    },
    "beneficiary": {
      "id": "3b90ef44-36cb-41d8-a0e4-000000000000",
      "name": "Naudo Silva",
      "email": "naudo.silva@email.com.br"
    }
  },
  "pix": {
    "id": "4b28af5f-d717-4ed7-8499-000000000000",
    "pixKey": "",
    "pixKeyType": "QRCODE",
    "type": "DEPOSIT",
    "amount": 185,
    "status": "CONFIRMED",
    "e2e": "E6070119020250400000000000000000",
    "executedAt": "2025-04-03T01:20:10.609Z",
    "createdAt": "2025-04-03T01:18:16.284Z",
    "senderInfo": {
      "bank": {
        "code": "021",
        "ispb": "0001190",
        "name": "Nubank"
      },
      "name": "Naudo Silva",
      "account": {
        "type": "CONTA_CORRENTE",
        "digit": "24",
        "agency": "321",
        "number": "234555"
      },
      "document": "09822333333"
    },
    "receiverInfo": {
      "name": "Naudo Silva",
      "userId": "3b90ef44-36cb-41d8-a0e4-000000000000",
      "document": "Não informado"
    }
  }
}

❌ 400 - Validação Falhou
ID da transação inválido ou malformado.

{
  "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"
}

Estrutura da Resposta 200

  • Transação (transaction):

    • Tipo (type), status (status), datas e moeda (currency).

  • Dados Financeiros (financial):

    • Valores brutos/líquidos (amount, netAmount), saldos antes/depois e taxas.

  • Participantes (participants):

    • Informações do pagador (originalPayer) e beneficiário (beneficiary), incluindo bancos e contas.

  • Metadados PIX (pix): (Se aplicável)

    • IDs, chave PIX, status, end-to-end ID (e2e) e dados do remetente/receptor.

Exemplo de Uso Prático

  1. Autentique-se para obter o Access Token.

  2. Substitua {id} pelo ID da transação desejada.

  3. Envie a requisição e trate a resposta:

    • Se 200, exiba os dados em detalhes (ex.: comprovante de transação).

    • Se 401, renove o token.

Dicas:

  • Use o campo e2e (PIX) para rastrear transações no sistema do BACEN.

  • Para transações de saída (PIX_CASH_OUT), o amount será negativo.

Exemplo em JavaScript (opcional):

fetch('https://api.etherglobalassets.com.br/transactions/f03f3a4f-4412-4626-8f9a-000000000000', {
  headers: {
    'Authorization': 'Bearer <token>'
  }
})
  .then(response => response.json())
  .then(data => console.log("Detalhes:", data))
  .catch(error => console.error("Erro:", error));

Observações:

  • Campos como document ou account.number podem ser mascarados no frontend para segurança.

  • Transações com status: "COMPLETED" são consideradas finalizadas.

Mais informações sobre o endpoint:

Acesse aqui