{"info":{"_postman_id":"8c567547-4a0d-49ad-b9ab-f49b9840ec82","name":"Vexus Public API 2026-08-21","description":"Coleção gerada a partir do mesmo contrato da documentação pública. Nunca grave segredos no arquivo exportado.","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"variable":[{"key":"baseUrl","value":"https://api.hpgroupllc.com.br","type":"string"},{"key":"clientId","value":"SEU_CLIENT_ID","type":"string"},{"key":"clientSecret","value":"SEU_CLIENT_SECRET","type":"string"},{"key":"idempotencyKey","value":"substitua-por-uma-chave-estavel","type":"string"},{"key":"walletId","value":"00000000-0000-4000-8000-000000000003","type":"string"},{"key":"withdrawalId","value":"00000000-0000-4000-8000-000000000004","type":"string"},{"key":"ruleId","value":"00000000-0000-4000-8000-000000000001","type":"string"},{"key":"splitId","value":"00000000-0000-4000-8000-000000000002","type":"string"}],"item":[{"name":"Status","item":[{"name":"Liveness","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/health/live","host":["{{baseUrl}}"],"path":["health","live"]},"description":"Verifica se o processo HTTP está ativo."},"response":[]},{"name":"Readiness","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/health/ready","host":["{{baseUrl}}"],"path":["health","ready"]},"description":"Valida banco, migrações e dependências internas necessárias para receber tráfego."},"response":[]}]},{"name":"PIX","item":[{"name":"Criar cobrança PIX","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/cashin","host":["{{baseUrl}}"],"path":["api","v1","cashin"]},"description":"Cria uma cobrança PIX dinâmica.","body":{"mode":"raw","raw":"{\n    \"amount\": 25.9,\n    \"payer_name\": \"Cliente de Exemplo\",\n    \"payer_document\": \"52998224725\",\n    \"payer_email\": \"cliente@example.com\",\n    \"description\": \"Pedido 1024\",\n    \"external_id\": \"pedido-1024\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Enviar PIX","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/cashout","host":["{{baseUrl}}"],"path":["api","v1","cashout"]},"description":"Envia um PIX para a chave informada, sujeito a saldo, produto e limites da conta.","body":{"mode":"raw","raw":"{\n    \"amount\": 20,\n    \"pix_key\": \"<chave-pix-destino>\",\n    \"pix_key_type\": \"random\",\n    \"description\": \"Repasse\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Ler QR Code PIX","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/pix/qr/decode","host":["{{baseUrl}}"],"path":["api","v1","pix","qr","decode"]},"description":"Valida e decodifica um payload EMV PIX sem movimentar saldo.","body":{"mode":"raw","raw":"{\n    \"payload\": \"00020101021226810014br.gov.bcb.pix2559https://example.invalid/pix/cobranca-exemplo520400005303986540539.905802BR5905VEXUS6009SAO PAULO62070503***6304ABCD\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Pagar QR Code PIX","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/pix/qr/pay","host":["{{baseUrl}}"],"path":["api","v1","pix","qr","pay"]},"description":"Paga um QR Code PIX após validação do payload e dos limites.","body":{"mode":"raw","raw":"{\n    \"payload\": \"00020101021226810014br.gov.bcb.pix2559https://example.invalid/pix/cobranca-exemplo520400005303986540539.905802BR5905VEXUS6009SAO PAULO62070503***6304ABCD\",\n    \"amount\": 39.9,\n    \"description\": \"Fornecedor\"\n}","options":{"raw":{"language":"json"}}}},"response":[]}]},{"name":"Boleto","item":[{"name":"Emitir boleto","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/boleto/issue","host":["{{baseUrl}}"],"path":["api","v1","boleto","issue"]},"description":"Emite uma cobrança por boleto para um produto habilitado.","body":{"mode":"raw","raw":"{\n    \"product_id\": \"00000000-0000-4000-8000-000000000001\",\n    \"amount\": 99.9,\n    \"buyer_name\": \"Cliente de Exemplo\",\n    \"buyer_email\": \"cliente@example.com\",\n    \"buyer_cpf\": \"52998224725\",\n    \"buyer_address\": {\n        \"zip_code\": \"01001000\",\n        \"street_name\": \"Praça da Sé\",\n        \"street_number\": \"100\",\n        \"neighborhood\": \"Sé\",\n        \"city\": \"São Paulo\",\n        \"state\": \"SP\"\n    }\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Consultar boleto","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/boleto/info","host":["{{baseUrl}}"],"path":["api","v1","boleto","info"]},"description":"Consulta os dados de um boleto sem movimentar saldo.","body":{"mode":"raw","raw":"{\n    \"billetCode\": \"00000000000000000000000000000000000000000000\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Pagar boleto","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/boleto/pay","host":["{{baseUrl}}"],"path":["api","v1","boleto","pay"]},"description":"Paga um boleto após a aplicação validar código, beneficiário, saldo e limites.","body":{"mode":"raw","raw":"{\n    \"billetCode\": \"00000000000000000000000000000000000000000000\",\n    \"amount\": 149.9,\n    \"beneficiary_name\": \"Empresa de Exemplo\"\n}","options":{"raw":{"language":"json"}}}},"response":[]}]},{"name":"Cripto","item":[{"name":"Listar ativos cripto","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/crypto/assets","host":["{{baseUrl}}"],"path":["api","v1","crypto","assets"]},"description":"Retorna somente moedas e redes habilitadas em produção, incluindo capacidade de depósito, envio, casas decimais, confirmações e ícone."},"response":[]},{"name":"Listar carteiras cripto","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/crypto/wallets","host":["{{baseUrl}}"],"path":["api","v1","crypto","wallets"]},"description":"Retorna as carteiras da conta, saldo disponível/bloqueado, rede, ativo e disponibilidade de envio."},"response":[]},{"name":"Criar ou obter carteira","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/crypto/wallets","host":["{{baseUrl}}"],"path":["api","v1","crypto","wallets"]},"description":"Cria de forma idempotente uma carteira para o par ativo/rede. Chamadas repetidas retornam a mesma carteira e o monitoramento automático já fica ativo.","body":{"mode":"raw","raw":"{\n    \"asset\": \"USDT\",\n    \"network\": \"BSC_BNB\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Consultar endereço de recebimento","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/crypto/wallets/{{walletId}}/address","host":["{{baseUrl}}"],"path":["api","v1","crypto","wallets","{{walletId}}","address"]},"description":"Revela o endereço e, quando aplicável, memo/tag. Depósitos são detectados, confirmados e creditados automaticamente."},"response":[]},{"name":"Listar movimentações cripto","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/crypto/transactions","host":["{{baseUrl}}"],"path":["api","v1","crypto","transactions"]},"description":"Lista depósitos e envios da conta, com status, confirmações, valores, taxas e hash blockchain quando disponível."},"response":[]},{"name":"Calcular envio cripto","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/crypto/withdrawals/preview","host":["{{baseUrl}}"],"path":["api","v1","crypto","withdrawals","preview"]},"description":"Valida destino e saldo e retorna uma cotação de 60 segundos com taxa de rede, taxa VexusPay e débito total. Não movimenta saldo.","body":{"mode":"raw","raw":"{\n    \"wallet_id\": \"00000000-0000-4000-8000-000000000001\",\n    \"amount\": \"1.00\",\n    \"destination\": \"0x1111111111111111111111111111111111111111\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Confirmar envio cripto","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/crypto/withdrawals","host":["{{baseUrl}}"],"path":["api","v1","crypto","withdrawals"]},"description":"Confirma uma cotação válida. A reserva, assinatura local KMS, transmissão e confirmação blockchain seguem automaticamente. Nunca reenvie com outra chave enquanto o resultado estiver pendente.","body":{"mode":"raw","raw":"{\n    \"quote_id\": \"00000000-0000-4000-8000-000000000002\",\n    \"destination\": \"0x1111111111111111111111111111111111111111\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Consultar envio cripto","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/crypto/withdrawals/{{withdrawalId}}","host":["{{baseUrl}}"],"path":["api","v1","crypto","withdrawals","{{withdrawalId}}"]},"description":"Retorna estado, hash blockchain, valores e taxas sem expor o endereço completo de destino."},"response":[]},{"name":"Cotar swap cripto","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/crypto/swaps/quote","host":["{{baseUrl}}"],"path":["api","v1","crypto","swaps","quote"]},"description":"Consulta uma cotação real entre duas carteiras da mesma rede. A resposta sempre informa execution_ready=false: não há execução on-chain publicada nesta rota.","body":{"mode":"raw","raw":"{\n    \"source_wallet_id\": \"00000000-0000-4000-8000-000000000001\",\n    \"target_wallet_id\": \"00000000-0000-4000-8000-000000000002\",\n    \"amount\": \"10.00\",\n    \"slippage_bps\": 50\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Prévia BRL para USDT BEP20","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/crypto/conversions/brl-usdt/preview","host":["{{baseUrl}}"],"path":["api","v1","crypto","conversions","brl-usdt","preview"]},"description":"Calcula valor estimado, taxa, saldo necessário e destino. Não cria PIX nem movimenta saldo.","body":{"mode":"raw","raw":"{\n    \"amount\": \"100.00\",\n    \"destination_mode\": \"VEXUS_WALLET\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Confirmar BRL para USDT BEP20","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/crypto/conversions/brl-usdt","host":["{{baseUrl}}"],"path":["api","v1","crypto","conversions","brl-usdt"]},"description":"Inicia a conversão pelo PIX de saída configurado para a conta. Exige PIN da conta e Idempotency-Key; jamais troque a chave ao repetir uma tentativa pendente.","body":{"mode":"raw","raw":"{\n    \"amount\": \"100.00\",\n    \"destination_mode\": \"VEXUS_WALLET\",\n    \"pin\": \"1234\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Consultar conversão BRL para USDT","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/crypto/conversions/brl-usdt/{{conversionId}}","host":["{{baseUrl}}"],"path":["api","v1","crypto","conversions","brl-usdt","{{conversionId}}"]},"description":"Retorna o estado conciliado da conversão e o valor entregue quando disponível."},"response":[]}]},{"name":"Cartões","item":[{"name":"Listar produtos de cartão","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/cards/products","host":["{{baseUrl}}"],"path":["api","v1","cards","products"]},"description":"Retorna os tipos de cartão virtual habilitados para a conta Vexus."},"response":[]},{"name":"Consultar taxas de cartões","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/cards/rates","host":["{{baseUrl}}"],"path":["api","v1","cards","rates"]},"description":"Retorna as taxas e limites publicados para cartões virtuais Vexus."},"response":[]},{"name":"Listar webhooks de OTP","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/cards/webhooks","host":["{{baseUrl}}"],"path":["api","v1","cards","webhooks"]},"description":"Lista os endpoints HTTPS cadastrados para receber eventos de OTP de cartão virtual."},"response":[]},{"name":"Configurar webhook de OTP","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/cards/webhooks","host":["{{baseUrl}}"],"path":["api","v1","cards","webhooks"]},"description":"Cadastra um endpoint HTTPS para receber eventos assinados de OTP de cartão virtual.","body":{"mode":"raw","raw":"{\n    \"label\": \"Meu endpoint OTP\",\n    \"url\": \"https://example.com/vexus/card-otp\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Listar cartões virtuais","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/cards","host":["{{baseUrl}}"],"path":["api","v1","cards"]},"description":"Lista os cartões virtuais pertencentes à conta autenticada."},"response":[]},{"name":"Emitir cartão virtual","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/cards","host":["{{baseUrl}}"],"path":["api","v1","cards"]},"description":"Emite um cartão virtual VexusPay para o produto e valor informados.","body":{"mode":"raw","raw":"{\n    \"product_code\": \"vexus_international\",\n    \"amount\": \"10.00\",\n    \"name_on_card\": \"CLIENTE EXEMPLO\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Consultar cartão virtual","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/cards/{{cardId}}","host":["{{baseUrl}}"],"path":["api","v1","cards","{{cardId}}"]},"description":"Retorna o estado e os dados não sensíveis do cartão virtual."},"response":[]},{"name":"Cancelar cartão virtual","request":{"method":"DELETE","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/cards/{{cardId}}","host":["{{baseUrl}}"],"path":["api","v1","cards","{{cardId}}"]},"description":"Cancela o cartão virtual. A operação não pode ser desfeita.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Recarregar cartão virtual","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/cards/{{cardId}}/fund","host":["{{baseUrl}}"],"path":["api","v1","cards","{{cardId}}","fund"]},"description":"Adiciona saldo ao cartão virtual usando a conta Vexus.","body":{"mode":"raw","raw":"{\n    \"amount\": \"10.00\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Congelar cartão virtual","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/cards/{{cardId}}/freeze","host":["{{baseUrl}}"],"path":["api","v1","cards","{{cardId}}","freeze"]},"description":"Congela temporariamente o cartão virtual.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Descongelar cartão virtual","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/cards/{{cardId}}/unfreeze","host":["{{baseUrl}}"],"path":["api","v1","cards","{{cardId}}","unfreeze"]},"description":"Descongela o cartão virtual.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Listar transações do cartão","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/cards/{{cardId}}/transactions","host":["{{baseUrl}}"],"path":["api","v1","cards","{{cardId}}","transactions"]},"description":"Lista as transações do cartão virtual sem expor dados sensíveis."},"response":[]}]},{"name":"Checkout","item":[{"name":"Listar meios de checkout","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/checkout/methods","host":["{{baseUrl}}"],"path":["api","v1","checkout","methods"]},"description":"Retorna somente meios de pagamento homologados e disponíveis para a conta autenticada."},"response":[]},{"name":"Consultar relatório de checkout","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/checkout/report","host":["{{baseUrl}}"],"path":["api","v1","checkout","report"]},"description":"Retorna métricas agregadas dos links e pedidos pertencentes à conta autenticada."},"response":[]},{"name":"Listar produtos de checkout","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/checkout/products","host":["{{baseUrl}}"],"path":["api","v1","checkout","products"]},"description":"Lista produtos ativos e arquivados do catálogo da conta."},"response":[]},{"name":"Criar produto de checkout","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/checkout/products","host":["{{baseUrl}}"],"path":["api","v1","checkout","products"]},"description":"Cria um produto no catálogo. Meios que exigem identificação de produto externo só podem ser usados quando provider_product_id for informado.","body":{"mode":"raw","raw":"{\n    \"name\": \"Produto de exemplo\",\n    \"price\": \"49.90\",\n    \"currency\": \"BRL\",\n    \"payment_methods\": [\n        \"PIX\"\n    ]\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Consultar produto de checkout","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/checkout/products/{{productId}}","host":["{{baseUrl}}"],"path":["api","v1","checkout","products","{{productId}}"]},"description":"Retorna o produto do catálogo pertencente à conta autenticada."},"response":[]},{"name":"Atualizar produto de checkout","request":{"method":"PUT","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/checkout/products/{{productId}}","host":["{{baseUrl}}"],"path":["api","v1","checkout","products","{{productId}}"]},"description":"Atualiza uma versão do produto. Envie version retornado na leitura para impedir sobrescrita concorrente.","body":{"mode":"raw","raw":"{\n    \"name\": \"Produto atualizado\",\n    \"price\": \"59.90\",\n    \"currency\": \"BRL\",\n    \"payment_methods\": [\n        \"PIX\"\n    ],\n    \"version\": 1\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Arquivar produto de checkout","request":{"method":"DELETE","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/checkout/products/{{productId}}","host":["{{baseUrl}}"],"path":["api","v1","checkout","products","{{productId}}"]},"description":"Arquiva o produto e os links ativos associados. A ação exige Idempotency-Key e não aceita corpo."},"response":[]},{"name":"Listar links de checkout","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/checkout/links","host":["{{baseUrl}}"],"path":["api","v1","checkout","links"]},"description":"Lista links de pagamento, estado e métricas da conta autenticada."},"response":[]},{"name":"Criar link de checkout","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/checkout/links","host":["{{baseUrl}}"],"path":["api","v1","checkout","links"]},"description":"Cria um link avulso ou associado a produto. O payment_path retornado deve ser combinado com seu domínio Vexus.","body":{"mode":"raw","raw":"{\n    \"title\": \"Link de exemplo\",\n    \"product_id\": 1,\n    \"payment_methods\": [\n        \"PIX\"\n    ]\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Consultar link de checkout","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/checkout/links/{{linkId}}","host":["{{baseUrl}}"],"path":["api","v1","checkout","links","{{linkId}}"]},"description":"Retorna a configuração e o payment_path do link pertencente à conta autenticada."},"response":[]},{"name":"Atualizar link de checkout","request":{"method":"PUT","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/checkout/links/{{linkId}}","host":["{{baseUrl}}"],"path":["api","v1","checkout","links","{{linkId}}"]},"description":"Atualiza uma versão do link. Envie version retornado na leitura para impedir sobrescrita concorrente.","body":{"mode":"raw","raw":"{\n    \"title\": \"Link atualizado\",\n    \"product_id\": 1,\n    \"payment_methods\": [\n        \"PIX\"\n    ],\n    \"version\": 1\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Arquivar link de checkout","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/checkout/links/{{linkId}}/archive","host":["{{baseUrl}}"],"path":["api","v1","checkout","links","{{linkId}}","archive"]},"description":"Arquiva o link e impede novos pagamentos. Exige Idempotency-Key e não aceita corpo."},"response":[]},{"name":"Cancelar link de checkout","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/checkout/links/{{linkId}}/cancel","host":["{{baseUrl}}"],"path":["api","v1","checkout","links","{{linkId}}","cancel"]},"description":"Cancela o link com motivo auditável e impede novos pagamentos. Exige Idempotency-Key.","body":{"mode":"raw","raw":"{\n    \"reason\": \"Cancelamento solicitado pelo integrador.\"\n}","options":{"raw":{"language":"json"}}}},"response":[]}]},{"name":"Conta","item":[{"name":"Taxas da conta","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/account/fees","host":["{{baseUrl}}"],"path":["api","v1","account","fees"]},"description":"Retorna as taxas comerciais efetivas para PIX, boleto, cartão, cartão virtual, transferência interna e regras por ativo/rede cripto."},"response":[]},{"name":"Limites da conta","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/account/limits","host":["{{baseUrl}}"],"path":["api","v1","account","limits"]},"description":"Retorna os limites financeiros efetivos da conta em BRL para agregado, PIX, boleto e transferência interna."},"response":[]},{"name":"Consultar saldo","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/balance","host":["{{baseUrl}}"],"path":["api","v1","balance"]},"description":"Consulta o saldo exposto pelo contrato da conta. Envie um objeto JSON vazio.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}},"response":[]}]},{"name":"White Label","item":[{"name":"Consultar White Label","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/white-label","host":["{{baseUrl}}"],"path":["api","v1","white-label"]},"description":"Retorna, em uma única resposta, a situação do contrato, plano, adicionais, cobrança, taxas e produtos efetivamente habilitados."},"response":[]},{"name":"Consultar plano White Label","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/white-label/plan","host":["{{baseUrl}}"],"path":["api","v1","white-label","plan"]},"description":"Retorna o plano e os adicionais contratados pela conta autenticada."},"response":[]},{"name":"Consultar taxas White Label","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/white-label/fees","host":["{{baseUrl}}"],"path":["api","v1","white-label","fees"]},"description":"Retorna as taxas comerciais do plano, incluindo PIX, boleto, cartão virtual e regras por ativo/rede cripto."},"response":[]},{"name":"Consultar cobrança White Label","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/white-label/billing","host":["{{baseUrl}}"],"path":["api","v1","white-label","billing"]},"description":"Retorna mensalidade, entrada, valor pendente, vencimento e situação de acesso. Não cria cobrança nem movimenta saldo."},"response":[]},{"name":"Consultar status White Label","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/white-label/status","host":["{{baseUrl}}"],"path":["api","v1","white-label","status"]},"description":"Retorna somente a situação do contrato e se operações financeiras pela API estão liberadas."},"response":[]}]},{"name":"Split","item":[{"name":"Listar regras de split","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/splits/rules","host":["{{baseUrl}}"],"path":["api","v1","splits","rules"]},"description":"Lista as regras pertencentes à conta autenticada."},"response":[]},{"name":"Criar regra de split","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/splits/rules","host":["{{baseUrl}}"],"path":["api","v1","splits","rules"]},"description":"Cria uma regra versionada por percentuais ou valores fixos.","body":{"mode":"raw","raw":"{\n    \"name\": \"Parceiros\",\n    \"mode\": \"PERCENTAGE\",\n    \"currency\": \"BRL\",\n    \"participants\": [\n        {\n            \"handle\": \"conta-parceira\",\n            \"percentage\": \"20.00\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Revisar regra de split","request":{"method":"PUT","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/splits/rules/{{ruleId}}","host":["{{baseUrl}}"],"path":["api","v1","splits","rules","{{ruleId}}"]},"description":"Arquiva a versão anterior e cria uma nova versão da regra.","body":{"mode":"raw","raw":"{\n    \"name\": \"Parceiros v2\",\n    \"mode\": \"PERCENTAGE\",\n    \"currency\": \"BRL\",\n    \"participants\": [\n        {\n            \"handle\": \"conta-parceira\",\n            \"percentage\": \"25.00\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Arquivar regra de split","request":{"method":"DELETE","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/splits/rules/{{ruleId}}","host":["{{baseUrl}}"],"path":["api","v1","splits","rules","{{ruleId}}"]},"description":"Arquiva a regra da conta. Esta operação não aceita corpo."},"response":[]},{"name":"Criar split","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/splits","host":["{{baseUrl}}"],"path":["api","v1","splits"]},"description":"Cria a operação financeira e suas alocações a partir de uma regra ativa.","body":{"mode":"raw","raw":"{\n    \"rule_id\": \"00000000-0000-4000-8000-000000000001\",\n    \"amount\": 100,\n    \"payer\": {\n        \"name\": \"Cliente de Exemplo\",\n        \"document\": \"52998224725\",\n        \"email\": \"cliente@example.com\"\n    }\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Consultar split","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/splits/{{splitId}}","host":["{{baseUrl}}"],"path":["api","v1","splits","{{splitId}}"]},"description":"Retorna a operação e as alocações visíveis à conta proprietária."},"response":[]},{"name":"Cancelar split","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/splits/{{splitId}}/cancel","host":["{{baseUrl}}"],"path":["api","v1","splits","{{splitId}}","cancel"]},"description":"Cancela um split somente quando o estado financeiro permitir. Não aceita corpo."},"response":[]},{"name":"Solicitar devolução do split","request":{"method":"POST","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"},{"key":"Idempotency-Key","value":"{{idempotencyKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/splits/{{splitId}}/refund","host":["{{baseUrl}}"],"path":["api","v1","splits","{{splitId}}","refund"]},"description":"Solicita devolução parcial ou total; uma resposta 202 indica processamento assíncrono.","body":{"mode":"raw","raw":"{\n    \"amount\": 25,\n    \"comment\": \"Devolução parcial solicitada pelo cliente\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Relatório de participante","request":{"method":"GET","header":[{"key":"Apikey","value":"{{clientId}}","type":"text"},{"key":"X-Client-Secret","value":"{{clientSecret}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/splits/report","host":["{{baseUrl}}"],"path":["api","v1","splits","report"],"query":[{"key":"from","value":"","disabled":true},{"key":"to","value":"","disabled":true}]},"description":"Retorna itens da conta autenticada no intervalo UTC informado."},"response":[]}]}]}