{"info":{"_postman_id":"8c567547-4a0d-49ad-b9ab-f49b9840ec82","name":"Vexus Public API 2026-08-15","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.vexuspayments.com","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":"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":"Criar cotação 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/quote","host":["{{baseUrl}}"],"path":["api","v1","crypto","quote"]},"description":"Obtém uma cotação para o valor em BRL sem efetuar saque.","body":{"mode":"raw","raw":"{\n    \"amount_brl\": 100\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Solicitar saque 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/withdraw","host":["{{baseUrl}}"],"path":["api","v1","crypto","withdraw"]},"description":"Solicita o saque usando uma cotação válida e uma carteira de destino.","body":{"mode":"raw","raw":"{\n    \"quote_id\": \"<quote-id>\",\n    \"amount_brl\": 100,\n    \"crypto_wallet\": \"<carteira-destino>\"\n}","options":{"raw":{"language":"json"}}}},"response":[]},{"name":"Consultar saque 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/status","host":["{{baseUrl}}"],"path":["api","v1","crypto","status"]},"description":"Consulta o saque pela identificação retornada na criação.","body":{"mode":"raw","raw":"{\n    \"withdrawal_id\": \"<withdrawal-id>\"\n}","options":{"raw":{"language":"json"}}}},"response":[]}]},{"name":"Conta","item":[{"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":"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":[]}]}]}