https://api.notrevepay.com.br/payfac
🔑 Bearer Token

Notreve Pay

v1.0 REST Pix

API REST da Notreve Pay. Integre contas, emita cobranças Pix, gerencie chaves Pix, realize transferências, consulte saldo/extrato e responda infrações do MED. Todos os endpoints retornam {success, message, data}.

Autenticacao
  • Header obrigatorio em todos os endpoints:
    Authorization: Bearer {SEU_TOKEN}
  • Seu token de cliente esta disponivel no painel.
Conta Principal vs Subconta
  • O token autentica a conta principal da sua empresa
  • Subcontas sao identificadas por subaccount_id nas rotas que aceitam escopo
  • Omitir subaccount_id opera na conta principal
  • MED: use sempre a conta principal; o retorno inclui principal e subcontas com seus IDs
Formato
  • JSON em todas requisicoes e respostas
  • Datas de período: YYYY-MM-DD
  • Valores monetarios em reais
  • Infracoes MED: amount em centavos + amount_brl em reais
Boas Praticas
  • Use integration_id / idempotency_key para evitar duplicatas
  • Consulte o saldo antes de transferir
  • Armazene os IDs retornados para consultas futuras
Contexto:
Conta Mãe opera na sua conta principal
Subconta exige subaccount_id
Ambas subaccount_id opcional
💰

Como funcionam as taxas

Entenda quanto e como sua conta e suas subcontas pagam para usar a plataforma.

As taxas sao configuradas por empresa no painel de administracao. No fluxo atual, a taxa configurada de recebimentos (cash-in) pode ser aplicada automaticamente quando houver configuracao valida; a taxa de plataforma de saques/transferencias (cash-out) permanece desativada.

Campo mediator_fee (opcional): é a taxa sua (do seu negócio) cobrada do seu vendedor/subconta — ela é por cima da taxa da plataforma. Não inclua a taxa da plataforma no mediator_fee, senão o valor é cobrado em dobro.
ConceitoComo funciona
Taxa da plataformaDefinida por empresa no painel. Pode ser aplicada no cash-in; o cash-out permanece desativado no fluxo atual.
mediator_feeTaxa adicional sua, cobrada do vendedor/subconta. Opcional. Por cima da taxa da plataforma.
Split de recebimentoNo cash-in, o valor é dividido entre você, o vendedor e a plataforma automaticamente.
Exemplo pratico: no cash-in, se houver taxa da plataforma configurada, ela e aplicada conforme a configuracao da empresa. O mediator_fee representa somente a taxa adicional do seu negocio, quando aplicavel; nao some a taxa da plataforma novamente. Para cash-out, nao considere debito de taxa de plataforma enquanto a flag permanecer desativada.
🔔

Webhooks (notificações em tempo real)

Eventos que sua integração pode receber quando algo acontece nas suas contas.

Quando ocorre um evento (pagamento recebido, transferência, infração, mudança de conta etc.), a plataforma envia uma notificação HTTP POST para uma URL configurada. A entrega é automática e pode ser reenviada em caso de falha.

Tipos de eventos
EventoQuando é enviado
CashInUm Pix foi recebido (pagamento de cobrança ou recebimento em chave).
TransferUma transferência/saque foi processada (inclui pernas de split e taxas).
InfractionUma infração MED foi registrada e aguarda análise.
AccountUma conta (subconta/multiconta) mudou de status.
Estrutura do payload
{
  "id": "uuid-unico",
  "object": "CashIn",
  "date": "2026-08-27T15:30:00.000Z",
  "account_id": "id-da-conta",
  "data": { ...detalhes do evento... }
}
Autenticidade: cada evento é assinado. Verifique sempre a assinatura no cabeçalho antes de processar, usando o segredo recebido na configuração do webhook.
Retentativas: se a sua URL não responder com sucesso (2xx), a plataforma reenvia. Garanta que sua integração trate o evento de forma idempotente pelo id, para não processar o mesmo evento duas vezes.
🏢

Subcontas

Crie e gerencie as contas (subcontas) vinculadas à sua empresa autenticada. Cada conta tem saldo, chaves Pix e histórico independentes.

🏦 Opera na conta principal autenticada.
POST
/v1/accounts/new
Criar Conta
Conta Mãe ▼

Abre uma nova conta sob o customer_id da sua empresa. Aceita os campos via JSON no body.

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Request body application/json
{
    "tax_id": "12345678000199",
    "external_id": "cliente_001",
    "name": "João da Silva"
}
CampoTipoObrigatorioDescricao
tax_idreq string Sim CPF (11 dígitos) ou CNPJ (14 dígitos). Também aceita o alias cpf_cnpj.
external_idreq string Sim Identificador externo para conciliação. Também aceita o alias hash_conta.
nameopt string Nao Nome do titular/beneficiário. Opcional (retrocompatível). Usado no comprovante; se ausente, é buscado no DICT pelo tax_id.
Responses
200 Conta criada/processada ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "id": "65c4f6d4-d832-4e21-bf3a-6eb18a880001",
        "status": "active"
    }
}
400 Campos obrigatórios ausentes ▼ 
{
    "success": false,
    "message": "Missing required fields: tax_id, external_id",
    "data": null
}
500 Credenciais Transfeera não configuradas ▼ 
{
    "success": false,
    "message": "Client Transfeera credentials not configured",
    "data": null
}
cURL
curl -X POST "https://api.notrevepay.com.br/payfac/v1/accounts/new" \
  -H "Authorization: Bearer {SEU_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "tax_id": "12345678000199",
    "external_id": "cliente_001",
    "name": "João da Silva"
}'
GET
/v1/accounts/list
Listar Contas
Conta Mãe ▼

Lista as contas da sua empresa, com filtros e paginação por cursor.

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Parametros
NomeInTipoObrigatorioDescricao
statusopt query string Nao Filtra por status (active, pending, blocked, closed etc.).
page_cursoropt query string Nao Cursor retornado na resposta anterior para paginar.
page_sizeopt query integer Nao Registros por página. Máx: 200.
Responses
200 Lista retornada ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "items": [
            {
                "id": "65c4f6d4-...",
                "status": "active"
            }
        ]
    }
}
cURL
curl -X GET "https://api.notrevepay.com.br/payfac/v1/accounts/list" \
  -H "Authorization: Bearer {SEU_TOKEN}"
GET
/v1/accounts/get
Consultar Conta
Conta Mãe ▼

Retorna os dados de uma conta pelo seu ID.

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Parametros
NomeInTipoObrigatorioDescricao
idreq query string Sim ID da conta (ou account_id).
Responses
200 Conta encontrada ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "id": "65c4f6d4-...",
        "status": "active"
    }
}
400 Parâmetro id ausente ▼ 
{
    "success": false,
    "message": "Missing required parameter: id",
    "data": null
}
cURL
curl -X GET "https://api.notrevepay.com.br/payfac/v1/accounts/get" \
  -H "Authorization: Bearer {SEU_TOKEN}"
GET
/v1/accounts/close
Encerrar Conta
Conta Mãe ▼

Solicita o encerramento de uma conta (POST /accounts/{id}/close na Transfeera) passando o id na query.

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Parametros
NomeInTipoObrigatorioDescricao
idreq query string Sim ID da conta a encerrar (ou account_id).
Responses
200 Solicitação registrada ▼ 
{
    "success": true,
    "message": "OK",
    "data": null
}
400 Parâmetro id ausente ▼ 
{
    "success": false,
    "message": "Missing required parameter: id",
    "data": null
}
cURL
curl -X GET "https://api.notrevepay.com.br/payfac/v1/accounts/close" \
  -H "Authorization: Bearer {SEU_TOKEN}"
🔑

Chaves Pix

Gerencie as chaves Pix da conta. Envie subaccount_id na query para operar em uma subconta; omita para usar a conta principal.

🔀 Envie subaccount_id para a subconta; omita para a conta principal.
POST
/v1/pixkey/new
Criar Chave Pix
Ambas ▼

Cria uma nova chave Pix. Se o campo key for omitido, a Transfeera gera uma chave aleatória (EVP).

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Request body application/json
{
    "key": "cliente@empresa.com.br"
}
CampoTipoObrigatorioDescricao
keyopt string Nao Valor da chave. Opcional: se omitido, gera chave aleatória.
Responses
200 Solicitação processada ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "id": "9fa12c44-...",
        "key_type": "EVP",
        "key": "a1b2c3d4-...",
        "status": "active"
    }
}
401 Token inválido ▼ 
{
    "success": false,
    "message": "Invalid client token",
    "data": null
}
cURL
curl -X POST "https://api.notrevepay.com.br/payfac/v1/pixkey/new" \
  -H "Authorization: Bearer {SEU_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "cliente@empresa.com.br"
}'
GET
/v1/pixkey/list
Listar Chaves Pix
Ambas ▼

Lista as chaves Pix da conta (principal ou subconta via scope).

🔑 Requer Authorization: Bearer {SEU_TOKEN}

Nenhum parametro necessario.

Responses
200 Lista retornada ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "items": [
            {
                "id": "9fa12c44-...",
                "key_type": "EVP",
                "key": "a1b2c3d4-..."
            }
        ]
    }
}
cURL
curl -X GET "https://api.notrevepay.com.br/payfac/v1/pixkey/list" \
  -H "Authorization: Bearer {SEU_TOKEN}"
GET
/v1/pixkey/get
Consultar Chave Pix
Ambas ▼

Retorna os dados de uma chave Pix específica.

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Parametros
NomeInTipoObrigatorioDescricao
idreq query string Sim ID da chave Pix.
Responses
200 Chave encontrada ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "id": "9fa12c44-...",
        "key_type": "EVP",
        "key": "a1b2c3d4-..."
    }
}
400 Parâmetro id ausente ▼ 
{
    "success": false,
    "message": "Missing required parameter: id",
    "data": null
}
cURL
curl -X GET "https://api.notrevepay.com.br/payfac/v1/pixkey/get" \
  -H "Authorization: Bearer {SEU_TOKEN}"
GET
/v1/pixkey/delete
Remover Chave Pix
Ambas ▼

Remove uma chave Pix pelo ID. Quando a Transfeera retorna 204, confirma com GET (404 = removida).

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Parametros
NomeInTipoObrigatorioDescricao
idreq query string Sim ID da chave Pix a remover (aceita também via POST).
Responses
200 Chave removida ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "deleted": true,
        "verified": true,
        "key_id": "..."
    }
}
400 Parâmetro id ausente ▼ 
{
    "success": false,
    "message": "Missing required parameter: id",
    "data": null
}
cURL
curl -X GET "https://api.notrevepay.com.br/payfac/v1/pixkey/delete" \
  -H "Authorization: Bearer {SEU_TOKEN}"
GET
/v1/pixkey/dict_get
Consultar Chave no DICT
Ambas ▼

Consulta qualquer chave Pix no DICT do Banco Central (GET /pix/dict_key/{key}). Use para validar o destinatário antes de transferir.

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Parametros
NomeInTipoObrigatorioDescricao
keyreq query string Sim Valor da chave Pix a consultar.
key_typeopt query string Nao EMAil | CPF | CNPJ | TELEFONE | CHAVE_ALEATORIA.
Responses
200 Consulta processada ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "key": "...",
        "key_type": "CNPJ",
        "held_person": {
            "name": "Empresa Exemplo LTDA",
            "tax_id": "12.345.678/0001-99"
        }
    }
}
400 Chave ausente ▼ 
{
    "success": false,
    "message": "Missing required parameter: key",
    "data": null
}
cURL
curl -X GET "https://api.notrevepay.com.br/payfac/v1/pixkey/dict_get" \
  -H "Authorization: Bearer {SEU_TOKEN}"
💰

Saldo e Transferências

Consulte saldos e realize transferências Pix. Envie subaccount_id para operar em uma subconta; omita para usar a conta principal.

🔀 Envie subaccount_id para a subconta; omita para a conta principal.
GET
/v1/wallet/balance
Consultar Saldo
Ambas ▼

Retorna o saldo disponível e em espera da conta (principal ou subconta via subaccount_id).

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Parametros
NomeInTipoObrigatorioDescricao
subaccount_idopt query string Nao ID da subconta. Omita para a conta principal.
Responses
200 Saldo consultado ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "value": 1250.75,
        "waiting_value": 100
    }
}
401 Token inválido ▼ 
{
    "success": false,
    "message": "Invalid client token",
    "data": null
}
cURL
curl -X GET "https://api.notrevepay.com.br/payfac/v1/wallet/balance" \
  -H "Authorization: Bearer {SEU_TOKEN}"
POST
/v1/wallet/transfer
Transferir via Pix
Ambas ▼

Rota única de saque/transferência Pix (batch). Antes de transferir consulta o saldo; se insuficiente, retorna erro 400. Informe idempotency_key em retentativas para evitar duplicidade.

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Request body application/json
{
    "value": 150.25,
    "destination_bank_account": {
        "pix_key_type": "CNPJ",
        "pix_key": "12345678000199"
    },
    "receiver_document": "12345678000199",
    "pix_description": "Pagamento de serviço",
    "integration_id": "pedido_9001",
    "idempotency_key": "pedido_9001_v1"
}
CampoTipoObrigatorioDescricao
subaccount_idopt string Nao ID da subconta origem. Omita para a conta principal.
valuereq number Sim Valor em reais a transferir. Ex: 100.50
destination_bank_account.pix_key_typereq string Sim CPF | CNPJ | EMAIL | TELEFONE | CHAVE_ALEATORIA.
destination_bank_account.pix_keyreq string Sim Chave Pix do destinatário.
receiver_documentreq string Sim CPF (11) ou CNPJ (14) do favorecido, somente números.
pix_descriptionopt string Nao Descrição da transferência (máx 140 caracteres).
integration_idopt string Nao ID externo da transação no seu sistema.
idempotency_keyopt string Nao Chave de idempotência para evitar duplicatas em retentativas.
mediator_fee.tipoopt string Nao FIXED ou PERCENTAGE (taxa de processamento, quando aplicavel).
mediator_fee.valoropt number Nao Valor da taxa (reais se FIXED, percentual se PERCENTAGE).
Responses
200 Transferência iniciada ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "txid": "...",
        "integration_id": "pedido_9001"
    }
}
400 Saldo insuficiente ▼ 
{
    "success": false,
    "message": "Insufficient balance.",
    "data": {
        "saldo_disponivel": 0,
        "total_necessario": 150.25
    }
}
400 Parâmetro inválido ▼ 
{
    "success": false,
    "message": "Invalid value",
    "data": null
}
401 Token inválido ▼ 
{
    "success": false,
    "message": "Invalid client token",
    "data": null
}
cURL
curl -X POST "https://api.notrevepay.com.br/payfac/v1/wallet/transfer" \
  -H "Authorization: Bearer {SEU_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "value": 150.25,
    "destination_bank_account": {
        "pix_key_type": "CNPJ",
        "pix_key": "12345678000199"
    },
    "receiver_document": "12345678000199",
    "pix_description": "Pagamento de serviço",
    "integration_id": "pedido_9001",
    "idempotency_key": "pedido_9001_v1"
}'
⚡

Recebimentos Pix

Emita cobranças Pix imediatas (QR estático), consulte cobranças e listes os Pix recebidos. Envie subaccount_id para operar em subconta.

🔀 Envie subaccount_id para a subconta; omita para a conta principal.
POST
/v1/pix/immediate
Criar Cobrança Pix
Ambas ▼

Gera um QR Code de cobranca imediata. O sistema seleciona a chave Pix ativa da conta no escopo (principal ou subconta); o valor enviado em pix_key e mantido apenas por compatibilidade. Retorna txid, integration_id, pix_copia_cola (EMV) e qrcode_base64.

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Request body application/json
{
    "pix_key": "cliente@empresa.com.br",
    "original_value": 59.9,
    "integration_id": "pedido_001",
    "mediator_fee": {
        "tipo": "FIXED",
        "valor": 0.2
    },
    "beneficiary": "João da Silva"
}
CampoTipoObrigatorioDescricao
pix_keyopt string Nao Campo mantido por compatibilidade; a chave ativa da conta no escopo e selecionada automaticamente.
original_valuereq number Sim Valor da cobrança em reais.
expirationopt integer Nao Segundos de validade (padrão 86400).
value_change_modeopt string Nao VALOR_FIXADO (padrão) ou aceitar outro.
integration_idopt string Nao ID externo da cobrança (máx 36).
mediator_fee.tipoopt string Nao FIXED ou PERCENTAGE (taxa de processamento, quando aplicavel).
mediator_fee.valoropt number Nao Valor da taxa.
beneficiaryopt string Nao Nome do beneficiário final exibido no comprovante. Se vazio, usa o nome cadastrado na conta.
Responses
200 Cobrança criada ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "txid": "...",
        "integration_id": "pedido_001",
        "pix_copia_cola": "00020126...",
        "qrcode_base64": "iVBORw0KGgo..."
    }
}
400 Valor ausente ou sem chave ativa ▼ 
{
    "success": false,
    "message": "Missing/invalid required field: original_value ou no_pix_key",
    "data": null
}
401 Token inválido ▼ 
{
    "success": false,
    "message": "Invalid client token",
    "data": null
}
cURL
curl -X POST "https://api.notrevepay.com.br/payfac/v1/pix/immediate" \
  -H "Authorization: Bearer {SEU_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "pix_key": "cliente@empresa.com.br",
    "original_value": 59.9,
    "integration_id": "pedido_001",
    "mediator_fee": {
        "tipo": "FIXED",
        "valor": 0.2
    },
    "beneficiary": "João da Silva"
}'
GET
/v1/pix/cashin/get
Consultar Cobrança (QR)
Ambas ▼

Consulta uma cobrança/QR pelo seu ID ou TXID.

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Parametros
NomeInTipoObrigatorioDescricao
idreq query string Sim ID ou TXID do QR Code.
Responses
200 Cobrança encontrada ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "txid": "...",
        "status": "paid",
        "value": 59.9
    }
}
400 Parâmetro id ausente ▼ 
{
    "success": false,
    "message": "Missing required parameter: id",
    "data": null
}
cURL
curl -X GET "https://api.notrevepay.com.br/payfac/v1/pix/cashin/get" \
  -H "Authorization: Bearer {SEU_TOKEN}"
GET
/v1/pix/cashin/list
Listar Pix Recebidos
Ambas ▼

Lista os Pix recebidos (cashin). Tem método GET obrigatório (senão 405). Todos os filtros são opcionais.

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Parametros
NomeInTipoObrigatorioDescricao
pageopt query integer Nao Número da página.
page_sizeopt query integer Nao Registros por página (máx 100).
typeopt query string Nao DEPOSIT | DEPOSIT_REFUND | PENDING_DEPOSIT_REFUND | CANCELLED_DEPOSIT_REFUND.
initial_dateopt query string Nao Data inicial.
end_dateopt query string Nao Data final.
pix_keyopt query string Nao Filtra por chave Pix.
txidopt query string Nao Filtra por TXID.
integration_idopt query string Nao Filtra pelo ID de integração externo.
valueopt query string Nao Filtra por valor.
payer_documentopt query string Nao CPF/CNPJ do pagador.
Responses
200 Lista retornada ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "entries": [
            {
                "id": "...",
                "value": 59.9,
                "type": "DEPOSIT",
                "txid": "...",
                "payer": {
                    "name": "João da Silva",
                    "document": "12345678901"
                },
                "receiver": {
                    "name": "Empresa Exemplo",
                    "document": "12345678000199"
                }
            }
        ],
        "metadata": null
    }
}
405 Método não permitido ▼ 
{
    "success": false,
    "message": "Method not allowed",
    "data": null
}
cURL
curl -X GET "https://api.notrevepay.com.br/payfac/v1/pix/cashin/list" \
  -H "Authorization: Bearer {SEU_TOKEN}"
📄

Extratos

Solicite e consulte relatórios de extrato (statement report) em CSV, XLSX, OFX ou PDF. subaccount_id define conta principal ou subconta.

🔀 Envie subaccount_id para a subconta; omita para a conta principal.
POST
/v1/statement/report_request
Solicitar Extrato
Ambas ▼

Solicita a geração assíncrona de um relatório de extrato. Consulte o ID retornado em /report_get até o status ficar pronto.

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Request body application/json
{
    "format": "pdf",
    "created_at__gte": "2026-03-01",
    "created_at__lte": "2026-03-31"
}
CampoTipoObrigatorioDescricao
subaccount_idopt string Nao ID da subconta. Omita para a conta principal.
formatreq string Sim csv | xlsx | ofx | pdf
created_at__gtereq string Sim Data inicial do período. Formato: YYYY-MM-DD
created_at__ltereq string Sim Data final do período. Formato: YYYY-MM-DD
Responses
200 Solicitação registrada ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "id": "stmt_a1b2c3",
        "status": "processing",
        "format": "pdf"
    }
}
400 Formato inválido ▼ 
{
    "success": false,
    "message": "Invalid format (use csv, xlsx, ofx or pdf)",
    "data": null
}
405 Método não permitido ▼ 
{
    "success": false,
    "message": "Method not allowed",
    "data": null
}
cURL
curl -X POST "https://api.notrevepay.com.br/payfac/v1/statement/report_request" \
  -H "Authorization: Bearer {SEU_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "format": "pdf",
    "created_at__gte": "2026-03-01",
    "created_at__lte": "2026-03-31"
}'
GET
/v1/statement/report_get
Consultar Extrato
Ambas ▼

Consulta o status de um relatório. Quando pronto, retorna file_url e file_name.

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Parametros
NomeInTipoObrigatorioDescricao
idreq query string Sim ID do relatório retornado em /report_request.
Responses
200 Relatório disponível ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "id": "stmt_a1b2c3",
        "status": "done",
        "format": "pdf",
        "file_url": "https://...",
        "file_name": "..."
    }
}
400 Parâmetro id ausente ▼ 
{
    "success": false,
    "message": "Missing required query param: id",
    "data": null
}
cURL
curl -X GET "https://api.notrevepay.com.br/payfac/v1/statement/report_get" \
  -H "Authorization: Bearer {SEU_TOKEN}"
⚠️

Infrações MED

Consulte e responda infrações do MED (Mecanismo Especial de Devolução) pela conta principal. O retorno inclui registros da conta principal e das subcontas vinculadas, mantendo os identificadores de conta para permitir a identificação da origem. Os valores retornados são convertidos para reais com o sufixo _brl.

⚠️ Consulta sempre na conta principal; o retorno inclui MED da conta principal e das subcontas vinculadas, com os identificadores de conta preservados.
GET
/v1/infractions/list
Listar Infrações
Conta Mãe ▼

Lista as infrações MED da conta principal e das subcontas vinculadas. Não envie subaccount_id: a consulta é feita no escopo principal e cada item mantém os identificadores de conta retornados pelo provedor. Converte amount e refund.refunded_amount (centavos) para *_brl.

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Parametros
NomeInTipoObrigatorioDescricao
infraction_date__gteopt query string Nao Data inicial. Formato: YYYY-MM-DD
infraction_date__lteopt query string Nao Data final.
transaction_idopt query string Nao EndToEndID da transação (E2E).
analysis_status__inopt query string Nao pending | accepted | rejected | delayed (separar por vírgula).
payer_tax_idopt query string Nao CPF ou CNPJ do pagador.
page_cursoropt query string Nao Cursor de paginação.
page_sizeopt query integer Nao Registros por página (máx 200).
Responses
200 Lista retornada ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "items": [
            {
                "id": "1f0f23d1-...",
                "account_id": "id-da-conta-ou-subconta",
                "situation_type": "scam",
                "analysis_status": "pending",
                "amount": 50000,
                "amount_brl": 500,
                "infraction_date": "2026-03-25"
            }
        ],
        "metadata": null
    }
}
401 Token inválido ▼ 
{
    "success": false,
    "message": "Invalid client token",
    "data": null
}
cURL
curl -X GET "https://api.notrevepay.com.br/payfac/v1/infractions/list" \
  -H "Authorization: Bearer {SEU_TOKEN}"
GET
/v1/infractions/get
Consultar Infração
Conta Mãe ▼

Retorna os dados de uma infração por ID usando a conta principal. O registro pode ser da conta principal ou de uma subconta vinculada, conforme o identificador de conta retornado. Valores convertidos para *_brl.

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Parametros
NomeInTipoObrigatorioDescricao
idreq query string Sim ID da infração.
Responses
200 Infração encontrada ▼ 
{
    "success": true,
    "message": "OK",
    "data": {
        "id": "1f0f23d1-...",
        "account_id": "id-da-conta-ou-subconta",
        "analysis_status": "pending",
        "amount": 50000,
        "amount_brl": 500,
        "transaction_id": "E000000..."
    }
}
400 Parâmetro id ausente ▼ 
{
    "success": false,
    "message": "Missing required param: id",
    "data": null
}
cURL
curl -X GET "https://api.notrevepay.com.br/payfac/v1/infractions/get" \
  -H "Authorization: Bearer {SEU_TOKEN}"
POST
/v1/infractions/analysis
Enviar Análise
Conta Mãe ▼

Submete o parecer pela conta principal, inclusive para uma infração originada em subconta, e opcionalmente arquivos de evidência (multipart/form-data, campo attachments). Não envie subaccount_id.

🔑 Requer Authorization: Bearer {SEU_TOKEN}
Request body multipart/form-data
curl -X POST "https://api.notrevepay.com.br/payfac/v1/infractions/analysis" \
  -H "Authorization: Bearer {SEU_TOKEN}" \
  -F "id=1f0f23d1-26be-6834-a9a2-aaf954149dd3" \
  -F "analysis=rejected" \
  -F "analysis_description=Transação legítima confirmada pelo cliente."
CampoTipoObrigatorioDescricao
idreq string Sim ID da infração (aceita via GET ?id= ou POST).
analysisreq string Sim accepted | rejected
analysis_descriptionreq string Sim Justificativa da análise.
attachmentsopt file Nao Evidências (anexos).
Responses
200 Análise enviada ▼ 
{
    "success": true,
    "message": "OK",
    "data": null
}
400 Análise inválida ▼ 
{
    "success": false,
    "message": "Invalid analysis (use accepted or rejected)",
    "data": null
}
405 Método não permitido ▼ 
{
    "success": false,
    "message": "Method not allowed",
    "data": null
}
cURL
curl -X POST "https://api.notrevepay.com.br/payfac/v1/infractions/analysis" \
  -H "Authorization: Bearer {SEU_TOKEN}" \
  -F "id=1f0f23d1-26be-6834-a9a2-aaf954149dd3" \
  -F "analysis=rejected" \
  -F "analysis_description=Transação legítima confirmada pelo cliente."
Notreve Pagamentos · Notreve Pay API v1.0