1. Consultar Transação
Lumo Payment's
  • 📕 Introdução
  • Gerar Deposito
    • Depósito
      POST
  • Solicitar Saque
    • Saque
      POST
    • Saque via USDT (BEP20)
      POST
  • 📓 Webhook
    • Exemplo de Respostas
  • 💰 Consultar SALDO
    • Integração para Consultar saldo
  • Consultar Transação
    • Consultar transação
  1. Consultar Transação

Consultar transação

# Base URL
https://api.lumopayment.com/api/
# Endpoint
GET /api/payments/transactions/:transactionId/status
# Headers obrigatórios
Content-Type: application/json
x-api-key: SUA_PUBLIC_KEY
# Query param obrigatório
type: pix_in | pix_out
# Descrição
Consulta o status de uma transação do próprio usuário autenticado via x-api-key. É obrigatório informar o tipo para diferenciar consulta de entrada (pix_in) e saída (pix_out).
# Regras
A transação precisa pertencer ao usuário dono da API key.
O tipo deve ser exatamente pix_in ou pix_out.
Se transactionId não existir para aquele usuário/tipo, retorna 404.
# Exemplo cURL (pix_in)
# Exemplo cURL (pix_out)
  --header "Content-Type: application/json" \
  --header "x-api-key: SUA_PUBLIC_KEY"
# Resposta de sucesso (200)
{
  "success": true,
  "data": {
    "transaction_id": "uuid-da-transacao",
    "external_id": "id-externo-adquirente",
    "type": "pix_in",
    "status": "paid",
    "amount": 150.5,
    "amount_fees": 2.35,
    "created_at": "2026-02-10T12:00:00.000Z",
    "paid_at": "2026-02-10T12:03:00.000Z"
  }
}
# Erro de validação de tipo (400)
{
  "success": false,
  "error": "Tipo inválido",
  "message": "Informe o parâmetro type com valor pix_in ou pix_out"
}
# Transação não encontrada (404)
{
  "success": false,
  "error": "Transação não encontrada",
  "message": "Transação não encontrada para o usuário informado"
}
# API key ausente (401)
{
  "success": false,
  "error": "API key não fornecida",
  "message": "É necessário fornecer uma API key válida no header x-api-key"
}
# API key inválida (401)
{
  "success": false,
  "error": "API key inválida",
  "message": "A API key fornecida não corresponde a nenhum usuário"
}
Modificado em 2026-03-20 04:03:36
Página anterior
Integração para Consultar saldo
Built with