📘 Documentacao da API

Integre com a API de forma simples. Veja exemplos de requisicao, respostas e estrutura de webhooks.

Versao atual: v1

Ambiente: Producao
v1 Depreciada v2 Default

🏁 Introducao

Bem-vindo a documentacao da API da Notreve Pagamentos. Este guia traz a base para integracao, autenticacao, consultas e notificacoes via webhooks.

Base URL
https://api.notrevepay.com.br/v1
Formato

Todas as respostas sao em JSON, com campos success, message e data.

⚠️

Header obrigatorio: User-Agent

Todas as requisicoes devem conter o header User-Agent com: nome completo / razao social + email cadastrado, separados por |.

Exemplo PF
Joao Silva | joao@example.com
Exemplo PJ
MINHA EMPRESA LTDA | atendimento@minhaempresa.com

Requisicoes sem esse header serao automaticamente bloqueadas.

🔑 Autenticacao

A autenticacao utiliza Bearer Token em todas as requisicoes protegidas. Envie o token no header Authorization.

Exemplo de headers basicos:


POST /v1/pix/cashin HTTP/1.1
Host: api.notrevepay.com.br

User-Agent: MINHA EMPRESA LTDA | contato@minhaempresa.com
Authorization: Bearer SEU_TOKEN_AQUI
Content-Type: application/json

💰 Consulta de saldo

Endpoint

GET /v1/account/balance

Nao ha parametros no corpo. A conta e identificada pelo token.

Resposta de sucesso:


{
  "success": true,
  "message": "Saldo da conta recuperado com sucesso.",
  "data": {
    "total_balance": 13.5,
    "available_balance": 13.5,
    "blocked_balance": 0,
    "reserved_balance": 0,
    "investment_balance": 0
  }
}

📄 Consulta de extrato

Endpoint

GET /v1/account/statement

Utilize filtros por periodo e paginacao.

  • start_date (ex: 2025-01-01 00:00:00)
  • end_date (ex: 2025-03-25 23:59:59)
  • page (pagina atual, ex: 1)

Exemplo de requisicao:


GET /v1/account/statement?start_date=2025-01-01&end_date=2025-01-22&page=1

Resposta:


{
  "success": true,
  "message": "Extrato recuperado com sucesso.",
  "data": {
    "page": 1,
    "limit": 100,
    "total_records": 4,
    "total_pages": 1,
    "statement": [
      {
        "transaction_id": "606cf7da635e96e40ca5a3361ffc6d4e2c6dc9035891210273dfbaed7ce707de",
        "transaction_type": "debito",
        "operation_type": "tarifa",
        "value": 0.3,
        "previous_balance": 10.39,
        "current_balance": 10.09,
        "description": "Taxa de processamento",
        "status": "concluido",
        "created_at": "2025-06-29 04:27:17"
      },
      {
        "transaction_id": "606cf7da635e96e40ca5a3361ffc6d4e2c6dc9035891210273dfbaed7ce707de",
        "transaction_type": "credito",
        "operation_type": "pix",
        "value": 2,
        "previous_balance": 8.39,
        "current_balance": 10.39,
        "description": "Recebimento PIX",
        "status": "concluido",
        "created_at": "2025-06-29 04:27:17"
      }
    ]
  }
}

📥 Recebimento PIX (Cash-in)

Endpoint

POST /v1/pix/cashin

Gera um QR Code PIX para receber pagamentos.

Body (JSON) de exemplo:


{
  "value": 2.01,
  "description": "Descricao do pagamento",
  "webhook_url": "https://webhook.site/51abf982-1d72-4ade-9e84-8802ac950092"
}

Resposta:


{
  "success": true,
  "message": "QrCode PIX gerado com sucesso",
  "data": {
    "transaction_id": "5590ee9b5f09bda30e94634aa05ddfeb01a2fd4f92740f83f623d5a94d1f5ec3",
    "status": "pending",
    "created_at": "2025-06-29 00:11:59",
    "qrcode": "00020126840014br.gov.bcb.ES62070503***6304C9EC",
    "qrcode_base64": "iVBORw0KGgoAAAANSUX74ZSpvVPwllTcqTlT+SxUnKm9UvK..."
  }
}

📤 Transferencia PIX (Cash-out)

Endpoint

POST /v1/pix/cashout

Realiza uma transferencia PIX para uma chave de destino.

pix_key_type: CPF, CNPJ, TELEFONE, EMAIL, CHAVE_ALEATORIA.

Body (JSON) de exemplo:


{
  "value": 1.30,
  "description": "Descricao da transferencia",
  "pix_key_type": "CHAVE_ALEATORIA",
  "pix_key": "01bf7d28-be99-4651-8af5-bdb4b5399e52",
  "webhook_url": "https://webhook.site/26b8af59-7040-41f0-9fb9-28ddbd0d3867",
  "idempotency_key": "abc123456789xyz"
}

Resposta:


{
  "success": true,
  "message": "Solicitacao de transferencia realizada com sucesso.",
  "data": {
    "transaction_id": "F19250B4-9FBD2970-DB7CD3F4-E4A36C40-517CA407",
    "status": "pending"
  }
}

🧾 Consultar transacoes PIX

Endpoint

GET /v1/pix/transactions

Permite listar transacoes de cash-in e cash-out com filtros.

  • start_date
  • end_date
  • page
  • transaction_id (opcional)
  • end2end_id (opcional)

Exemplo de requisicao:


GET /v1/pix/transactions?start_date=2025-01-01&end_date=2025-01-22&page=1

Resposta:


{
  "success": true,
  "message": "Transacoes PIX recuperadas com sucesso.",
  "data": {
    "page": 1,
    "limit": 100,
    "total_records": 3,
    "total_pages": 1,
    "transactions": [
      {
        "transaction_id": "702fd8d626a1f28be403e598a0ae4f8dc851b226b3bc33f9daf50cad5e4a7779",
        "end2end_id": "E18236120202506301935s142dc55027",
        "type": "cashin",
        "description": "Descricao do pagamento",
        "value": 2.01,
        "fee": 0.3,
        "status": "completed",
        "created_at": "2025-06-30 16:34:09",
        "completed_at": "2025-06-30 16:35:41"
      },
      {
        "transaction_id": "886c71a7c95d05a15e8c7043f3e75964a8352a32401b427a1d78a9c17d6523e6",
        "end2end_id": null,
        "type": "cashout",
        "description": "Descricao da transferencia",
        "value": 0.1,
        "fee": 0.3,
        "status": "pending",
        "created_at": "2025-06-29 03:56:25",
        "completed_at": null
      }
    ]
  }
}

📡 Webhooks

Configure sua URL para receber notificacoes em tempo real. O endpoint deve responder com HTTP 200 para confirmar recebimento.

🔔 Webhook de deposito (cash-in) - pago


{
  "event_type": "pix_cashin",
  "transaction_id": "231e39514656f57eea2eeecad8aa9c1e8583cda82060fe025d59f9d66c96a",
  "end2end_id": "E60746942507071154A296581n2WE",
  "value": 35,
  "fee": 0.6,
  "net_amount": 34.4,
  "status": "paid",
  "description": "Recebimento PIX",
  "created_at": "2025-07-07 08:53:06",
  "paid_at": "2025-07-07 08:55:07",
  "payer": {
    "name": "JOAO DA SILVA",
    "document": "12345678900",
    "bank": null,
    "agency": null,
    "account": null,
    "ispb": null
  },
  "receipt_base64": null
}

🔔 Webhook de deposito estornado (cash-in)


{
  "event_type": "pix_cashin",
  "transaction_id": "231e39514656f57eea2eeecad8aa9c1e8583cda82060fe025d59f9d66c96a",
  "end2end_id": "E60746942507071154A296581n2WE",
  "value": 35,
  "fee": 0.6,
  "net_amount": 34.4,
  "status": "refunded",
  "description": "Recebimento PIX",
  "created_at": "2025-07-07 08:53:06",
  "paid_at": "2025-07-07 08:55:07",
  "payer": {
    "name": "JOAO DA SILVA",
    "document": "12345678900",
    "bank": null,
    "agency": null,
    "account": null,
    "ispb": null
  },
  "receipt_base64": null
}

🔔 Webhook de deposito expirado/cancelado (cash-in)


{
  "event_type": "pix_cashin",
  "transaction_id": "231e39514656f57eea2eeecad8aa9c1e8583cda82060fe025d59f9d66c96a",
  "end2end_id": "E60746942507071154A296581n2WE",
  "value": 35,
  "fee": 0.6,
  "net_amount": 34.4,
  "status": "expired",
  "description": "Recebimento PIX",
  "created_at": "2025-07-07 08:53:06",
  "paid_at": "2025-07-07 08:55:07",
  "payer": {
    "name": "JOAO DA SILVA",
    "document": "12345678900",
    "bank": null,
    "agency": null,
    "account": null,
    "ispb": null
  },
  "receipt_base64": null
}

🔔 Webhook de saque (cash-out)


{
  "event_type": "pix_cashout",
  "transaction_id": "06e2633ceb4918c3cd6723de18ca7106a34df962a7bc6fc5a24e7ff3a6398",
  "end2end_id": null,
  "value": 1940,
  "fee": 0.3,
  "total_value": 1940.3,
  "status": "completed",
  "description": "Transferencia via sistema",
  "created_at": "2025-07-07 07:24:07",
  "completed_at": "2025-07-07 07:32:35",
  "destination_bank_account": {
    "name": "JOAO DA SILVA",
    "document": "123.456.789-00",
    "pix_key": "joao.silva@example.com",
    "pix_key_type": "EMAIL",
    "bank": "Banco Ficticio S.A.",
    "ispb": "00000000"
  },
  "receipt_base64": null
}

🚨 Webhook de infracao iniciada (MED)


{
  "event_type": "med_iniciada",
  "transaction_id": "ee3132d5e16d1c2aa7d622bb6fbce0179421704301c50b79b86695fa4d7c88",
  "value": 1.01,
  "status": "aberto",
  "descricao": "Encaminhamos notificacao de infracao por motivo de fraude da transacao contestada pelo cliente.",
  "created_at": "2025-07-11 14:59:25"
}

✅ Webhook de infracao finalizada (MED)


{
  "event_type": "med_finalizada",
  "transaction_id": "ee3132d5e16d1c2aa7d622bb6fbce0179421704301c50b79b86695fa4d7c88",
  "value": 1.01,
  "status": "negado", // valores possiveis: negado ou aprovado
  "descricao": "Encaminhamos notificacao de infracao por motivo de fraude da transacao contestada pelo cliente.",
  "created_at": "2025-07-11 14:59:25"
}