{
  "info": {
    "name": "Notreve Pay API",
    "_postman_id": "notreve-payfac-v1",
    "description": "API Notreve Pay v1.0\n\nVariaveis necessarias:\n- base_url: https://api.notrevepay.com.br/payfac\n- token: Bearer token do cliente (disponivel no painel)\n- subconta_id: ID de uma subconta para testes (opcional nas rotas que aceitam escopo)\n\nMED: use a conta principal. A listagem, consulta e analise retornam/operam sobre a conta principal e suas subcontas; use os identificadores de conta presentes nos registros para identificar a origem. Nao envie subaccount_id nas rotas MED.\n\nPadrao de resposta: { \"success\": bool, \"message\": string, \"data\": ... | null }",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{token}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://api.notrevepay.com.br/payfac",
      "type": "string"
    },
    {
      "key": "token",
      "value": "",
      "type": "string",
      "description": "Token do cliente (Bearer)"
    },
    {
      "key": "subconta_id",
      "value": "",
      "type": "string",
      "description": "ID de subconta para testes (opcional)"
    }
  ],
  "item": [
    {
      "name": "Subcontas",
      "description": "Criacao e gestao de contas vinculadas.",
      "item": [
        {
          "name": "Criar Conta",
          "request": {
            "method": "POST",
            "header": [
              {"key": "Content-Type", "value": "application/json", "type": "text"}
            ],
            "url": {
              "raw": "{{base_url}}/v1/accounts/new",
              "host": ["{{base_url}}"],
              "path": ["v1", "accounts", "new"]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"tax_id\": \"12345678000199\",\n  \"external_id\": \"cliente_001\"\n}",
              "options": {"raw": {"language": "json"}}
            }
          },
          "response": []
        },
        {
          "name": "Listar Contas",
          "request": {
            "method": "GET",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/accounts/list?page_size=20",
              "host": ["{{base_url}}"],
              "path": ["v1", "accounts", "list"],
              "query": [
                {"key": "status", "value": "active", "disabled": true},
                {"key": "page_cursor", "value": "", "disabled": true},
                {"key": "page_size", "value": "20"}
              ]
            }
          },
          "response": []
        },
        {
          "name": "Consultar Conta",
          "request": {
            "method": "GET",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/accounts/get?id={{subconta_id}}",
              "host": ["{{base_url}}"],
              "path": ["v1", "accounts", "get"],
              "query": [{"key": "id", "value": "{{subconta_id}}"}]
            }
          },
          "response": []
        },
        {
          "name": "Encerrar Conta",
          "request": {
            "method": "GET",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/accounts/close?id={{subconta_id}}",
              "host": ["{{base_url}}"],
              "path": ["v1", "accounts", "close"],
              "query": [{"key": "id", "value": "{{subconta_id}}"}]
            }
          },
          "response": []
        }
      ]
    },
    {
      "name": "Chaves Pix",
      "description": "Gestao de chaves Pix. Envie subaccount_id na query para subconta.",
      "item": [
        {
          "name": "Criar Chave Pix",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/pixkey/new",
              "host": ["{{base_url}}"],
              "path": ["v1", "pixkey", "new"]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"key\": \"cliente@empresa.com.br\"\n}",
              "options": {"raw": {"language": "json"}}
            }
          },
          "response": []
        },
        {
          "name": "Listar Chaves Pix",
          "request": {
            "method": "GET",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/pixkey/list?subaccount_id={{subconta_id}}",
              "host": ["{{base_url}}"],
              "path": ["v1", "pixkey", "list"],
              "query": [{"key": "subaccount_id", "value": "{{subconta_id}}"}]
            }
          },
          "response": []
        },
        {
          "name": "Consultar Chave Pix",
          "request": {
            "method": "GET",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/pixkey/get?id=PIXKEY_ID&subaccount_id={{subconta_id}}",
              "host": ["{{base_url}}"],
              "path": ["v1", "pixkey", "get"],
              "query": [
                {"key": "id", "value": "PIXKEY_ID"},
                {"key": "subaccount_id", "value": "{{subconta_id}}", "disabled": true}
              ]
            }
          },
          "response": []
        },
        {
          "name": "Remover Chave Pix",
          "request": {
            "method": "GET",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/pixkey/delete?id=PIXKEY_ID",
              "host": ["{{base_url}}"],
              "path": ["v1", "pixkey", "delete"],
              "query": [{"key": "id", "value": "PIXKEY_ID"}]
            }
          },
          "response": []
        },
        {
          "name": "Consultar Chave no DICT",
          "request": {
            "method": "GET",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/pixkey/dict_get?key=12345678000199&key_type=CNPJ",
              "host": ["{{base_url}}"],
              "path": ["v1", "pixkey", "dict_get"],
              "query": [
                {"key": "key", "value": "12345678000199"},
                {"key": "key_type", "value": "CNPJ", "disabled": true}
              ]
            }
          },
          "response": []
        }
      ]
    },
    {
      "name": "Saldo e Transferencias",
      "description": "Saldo e transferencias Pix. Envie subaccount_id (query/body/JSON) para subconta.",
      "item": [
        {
          "name": "Consultar Saldo",
          "request": {
            "method": "GET",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/wallet/balance",
              "host": ["{{base_url}}"],
              "path": ["v1", "wallet", "balance"],
              "query": [{"key": "subaccount_id", "value": "{{subconta_id}}", "disabled": true}]
            }
          },
          "response": []
        },
        {
          "name": "Transferir via Pix",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/wallet/transfer",
              "host": ["{{base_url}}"],
              "path": ["v1", "wallet", "transfer"]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"value\": 150.25,\n  \"destination_bank_account\": {\n    \"pix_key_type\": \"CNPJ\",\n    \"pix_key\": \"12345678000199\"\n  },\n  \"receiver_document\": \"12345678000199\",\n  \"pix_description\": \"Pagamento de servico\",\n  \"integration_id\": \"pedido_9001\",\n  \"idempotency_key\": \"pedido_9001_v1\"\n}",
              "options": {"raw": {"language": "json"}}
            }
          },
          "response": []
        },
        {
          "name": "Saque (Withdraw)",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/wallet/withdraw",
              "host": ["{{base_url}}"],
              "path": ["v1", "wallet", "withdraw"]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"value\": 100.50,\n  \"pix_key_type\": \"CPF\",\n  \"pix_key\": \"12345678901\",\n  \"external_id\": \"saque_001\",\n  \"pix_description\": \"Saque do saldo\"\n}",
              "options": {"raw": {"language": "json"}}
            }
          },
          "response": []
        }
      ]
    },
    {
      "name": "Recebimentos Pix",
      "description": "Cobrancas Pix (QR) e Pix recebidos.",
      "item": [
        {
          "name": "Criar Cobranca Pix (QR)",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/pix/immediate",
              "host": ["{{base_url}}"],
              "path": ["v1", "pix", "immediate"]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"pix_key\": \"cliente@empresa.com.br\",\n  \"original_value\": 59.90,\n  \"integration_id\": \"pedido_001\",\n  \"mediator_fee\": {\n    \"tipo\": \"FIXED\",\n    \"valor\": 0.20\n  }\n}",
              "options": {"raw": {"language": "json"}}
            }
          },
          "response": []
        },
        {
          "name": "Criar Cobranca (cashin)",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/pix/cashin/immediate",
              "host": ["{{base_url}}"],
              "path": ["v1", "pix", "cashin", "immediate"]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"pix_key\": \"cliente@empresa.com.br\",\n  \"original_value\": 59.90,\n  \"integration_id\": \"pedido_001\"\n}",
              "options": {"raw": {"language": "json"}}
            }
          },
          "response": []
        },
        {
          "name": "Consultar Cobranca",
          "request": {
            "method": "GET",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/pix/cashin/get?id=PIX_ID",
              "host": ["{{base_url}}"],
              "path": ["v1", "pix", "cashin", "get"],
              "query": [{"key": "id", "value": "PIX_ID"}]
            }
          },
          "response": []
        },
        {
          "name": "Listar Pix Recebidos",
          "request": {
            "method": "GET",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/pix/cashin/list?page_size=20",
              "host": ["{{base_url}}"],
              "path": ["v1", "pix", "cashin", "list"],
              "query": [
                {"key": "page", "value": "1", "disabled": true},
                {"key": "page_size", "value": "20"},
                {"key": "type", "value": "DEPOSIT", "disabled": true},
                {"key": "initial_date", "value": "2026-03-01", "disabled": true},
                {"key": "end_date", "value": "2026-03-31", "disabled": true},
                {"key": "pix_key", "value": "", "disabled": true},
                {"key": "txid", "value": "", "disabled": true},
                {"key": "integration_id", "value": "", "disabled": true},
                {"key": "payer_document", "value": "", "disabled": true}
              ]
            }
          },
          "response": []
        }
      ]
    },
    {
      "name": "Extratos",
      "description": "Solicitacao e consulta de extratos (statement report).",
      "item": [
        {
          "name": "Solicitar Extrato",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/statement/report_request",
              "host": ["{{base_url}}"],
              "path": ["v1", "statement", "report_request"]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"format\": \"pdf\",\n  \"created_at__gte\": \"2026-03-01\",\n  \"created_at__lte\": \"2026-03-31\"\n}",
              "options": {"raw": {"language": "json"}}
            }
          },
          "response": []
        },
        {
          "name": "Consultar Extrato",
          "request": {
            "method": "GET",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/statement/report_get?id=STATEMENT_ID",
              "host": ["{{base_url}}"],
              "path": ["v1", "statement", "report_get"],
              "query": [{"key": "id", "value": "STATEMENT_ID"}]
            }
          },
          "response": []
        }
      ]
    },
    {
      "name": "Infracoes MED",
      "description": "Consulta e resposta a infracoes MED pela conta principal. O retorno inclui a conta principal e as subcontas vinculadas; os identificadores de conta presentes em cada registro permitem identificar a origem. Nao enviar subaccount_id.",
      "item": [
        {
          "name": "Listar Infracoes",
          "request": {
            "method": "GET",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/infractions/list?analysis_status__in=pending",
              "host": ["{{base_url}}"],
              "path": ["v1", "infractions", "list"],
              "query": [
                {"key": "infraction_date__gte", "value": "2026-03-01", "disabled": true},
                {"key": "infraction_date__lte", "value": "2026-03-31", "disabled": true},
                {"key": "transaction_id", "value": "", "disabled": true},
                {"key": "analysis_status__in", "value": "pending"},
                {"key": "payer_tax_id", "value": "", "disabled": true},
                {"key": "page_cursor", "value": "", "disabled": true},
                {"key": "page_size", "value": "20", "disabled": true}
              ]
            }
          },
          "response": []
        },
        {
          "name": "Consultar Infracao",
          "request": {
            "method": "GET",
            "header": [{"key": "Content-Type", "value": "application/json", "type": "text"}],
            "url": {
              "raw": "{{base_url}}/v1/infractions/get?id=INFRACAO_ID",
              "host": ["{{base_url}}"],
              "path": ["v1", "infractions", "get"],
              "query": [{"key": "id", "value": "INFRACAO_ID"}]
            }
          },
          "response": []
        },
        {
          "name": "Enviar Analise",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/v1/infractions/analysis?id=INFRACAO_ID",
              "host": ["{{base_url}}"],
              "path": ["v1", "infractions", "analysis"],
              "query": [{"key": "id", "value": "INFRACAO_ID", "disabled": true}]
            },
            "body": {
              "mode": "formdata",
              "formdata": [
                {"key": "id", "value": "INFRACAO_ID", "type": "text"},
                {"key": "analysis", "value": "rejected", "type": "text"},
                {"key": "analysis_description", "value": "Transacao legitima confirmada pelo cliente.", "type": "text"},
                {"key": "attachments", "type": "file", "src": []}
              ]
            }
          },
          "response": []
        }
      ]
    }
  ]
}