HTTPS + JSON
Contratos simples, respostas estruturadas e exemplos prontos para o backend.
Integração HTTPS/JSON para os produtos publicados. Esta especificação descreve somente contratos disponíveis no domínio atual; recursos não publicados aparecem na matriz de disponibilidade e não devem ser inferidos.
https://api.witevexus.funContratos simples, respostas estruturadas e exemplos prontos para o backend.
Repetições seguras nas operações financeiras sem duplicar movimentações.
Entrega autenticada e retentativas com identificador estável.
As rotas privadas usam duas credenciais enviadas somente pelo seu servidor. Nunca exponha o Client Secret no navegador, aplicativo móvel ou repositório.
Apikey: SEU_CLIENT_ID
X-Client-Secret: SEU_CLIENT_SECRET
Content-Type: application/json
Use de 8 a 100 caracteres e repita a mesma chave somente com a mesma credencial, identidade, operação, método, URL e corpo. As escritas cripto B2B publicadas criam uma intent durável antes do envio; após timeout, recupere pela chave original e nunca tente novamente com outra chave.
A API cripto usa as mesmas credenciais servidor-a-servidor. Consulte o catálogo antes de operar: ele é a fonte de verdade para moedas, redes, confirmações e disponibilidade de entrada ou saída.
Liste /api/v1/crypto/assets e envie o par asset/network para /api/v1/crypto/wallets. A criação é idempotente por conta, moeda e rede.
Consulte o endereço da carteira. A WiteVexus monitora a blockchain, aguarda as confirmações da rede e credita o ledger sem ação manual.
Calcule o preview, confirme com a mesma cotação e uma Idempotency-Key. Reserva, assinatura KMS, transmissão e confirmação continuam em segundo plano.
cashout autenticam o servidor integrador. Nunca coloque essas credenciais no frontend./api/v1/crypto/withdrawals/{withdrawalId} até o estado terminal e use /api/v1/crypto/transactions para conciliação. Repetições devem preservar corpo e chave de idempotência.Valide a assinatura usando o corpo bruto recebido antes de interpretar o JSON. Respostas 2xx confirmam a entrega.
X-WiteVexus-Event: checkout.order.status_changed
X-WiteVexus-Delivery: <uuid>
X-WiteVexus-Timestamp: <unix_timestamp>
X-WiteVexus-Signature: v1=<hmac_sha256>
Os exemplos abaixo são derivados do mesmo contrato que gera o OpenAPI e a coleção Postman.
Disponibilidade técnica sem autenticação.
/health/live
Público
Verifica se o processo HTTP está ativo.
curl -X GET 'https://api.witevexus.fun/health/live'
/health/ready
Público
Valida banco, migrações e dependências internas necessárias para receber tráfego.
curl -X GET 'https://api.witevexus.fun/health/ready'
Entrada, saída, leitura e pagamento de QR Code PIX.
/api/v1/cashin
Credenciais
Cria uma cobrança PIX dinâmica.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/cashin' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"amount": 25.9,
"payer_name": "Cliente de Exemplo",
"payer_document": "52998224725",
"payer_email": "cliente@example.com",
"description": "Pedido 1024",
"external_id": "pedido-1024"
}'
{
"amount": 25.9,
"payer_name": "Cliente de Exemplo",
"payer_document": "52998224725",
"payer_email": "cliente@example.com",
"description": "Pedido 1024",
"external_id": "pedido-1024"
}
/api/v1/cashout
Credenciais
Envia um PIX para a chave informada, sujeito a saldo, produto e limites da conta.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/cashout' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"amount": 20,
"pix_key": "<chave-pix-destino>",
"pix_key_type": "random",
"description": "Repasse"
}'
{
"amount": 20,
"pix_key": "<chave-pix-destino>",
"pix_key_type": "random",
"description": "Repasse"
}
/api/v1/pix/qr/decode
Credenciais
Valida e decodifica um payload EMV PIX sem movimentar saldo.
curl -X POST 'https://api.witevexus.fun/api/v1/pix/qr/decode' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Content-Type: application/json' \
--data '{
"payload": "00020101021226810014br.gov.bcb.pix2559https://example.invalid/pix/cobranca-exemplo520400005303986540539.905802BR5907EXEMPLO6009SAO PAULO62070503***6304ABCD"
}'
{
"payload": "00020101021226810014br.gov.bcb.pix2559https://example.invalid/pix/cobranca-exemplo520400005303986540539.905802BR5907EXEMPLO6009SAO PAULO62070503***6304ABCD"
}
/api/v1/pix/qr/pay
Credenciais
Paga um QR Code PIX após validação do payload e dos limites.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/pix/qr/pay' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"payload": "00020101021226810014br.gov.bcb.pix2559https://example.invalid/pix/cobranca-exemplo520400005303986540539.905802BR5907EXEMPLO6009SAO PAULO62070503***6304ABCD",
"amount": 39.9,
"description": "Fornecedor"
}'
{
"payload": "00020101021226810014br.gov.bcb.pix2559https://example.invalid/pix/cobranca-exemplo520400005303986540539.905802BR5907EXEMPLO6009SAO PAULO62070503***6304ABCD",
"amount": 39.9,
"description": "Fornecedor"
}
Emissão, consulta e pagamento de boleto.
/api/v1/boleto/issue
Credenciais
Emite uma cobrança por boleto para um produto habilitado.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/boleto/issue' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"product_id": "00000000-0000-4000-8000-000000000001",
"amount": 99.9,
"buyer_name": "Cliente de Exemplo",
"buyer_email": "cliente@example.com",
"buyer_cpf": "52998224725",
"buyer_address": {
"zip_code": "01001000",
"street_name": "Praça da Sé",
"street_number": "100",
"neighborhood": "Sé",
"city": "São Paulo",
"state": "SP"
}
}'
{
"product_id": "00000000-0000-4000-8000-000000000001",
"amount": 99.9,
"buyer_name": "Cliente de Exemplo",
"buyer_email": "cliente@example.com",
"buyer_cpf": "52998224725",
"buyer_address": {
"zip_code": "01001000",
"street_name": "Praça da Sé",
"street_number": "100",
"neighborhood": "Sé",
"city": "São Paulo",
"state": "SP"
}
}
/api/v1/boleto/info
Credenciais
Consulta os dados de um boleto sem movimentar saldo.
curl -X POST 'https://api.witevexus.fun/api/v1/boleto/info' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Content-Type: application/json' \
--data '{
"billetCode": "00000000000000000000000000000000000000000000"
}'
{
"billetCode": "00000000000000000000000000000000000000000000"
}
/api/v1/boleto/pay
Credenciais
Paga um boleto após a aplicação validar código, beneficiário, saldo e limites.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/boleto/pay' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"billetCode": "00000000000000000000000000000000000000000000",
"amount": 149.9,
"beneficiary_name": "Empresa de Exemplo"
}'
{
"billetCode": "00000000000000000000000000000000000000000000",
"amount": 149.9,
"beneficiary_name": "Empresa de Exemplo"
}
Catálogo, carteiras, saldos, depósitos, saques, swaps e transferências internas. Conversões aparecem como preparadas enquanto o gate financeiro estiver fechado.
/api/v1/crypto/networks
Credenciais
Lista redes e capacidades efetivamente habilitadas.
curl -X GET 'https://api.witevexus.fun/api/v1/crypto/networks' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/crypto/assets
Credenciais
Lista ativos, redes, casas decimais e capacidades efetivas.
curl -X GET 'https://api.witevexus.fun/api/v1/crypto/assets' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/crypto/swap-pairs
Credenciais
Lista somente pares publicados para a conta.
curl -X GET 'https://api.witevexus.fun/api/v1/crypto/swap-pairs' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/crypto/wallets
Credenciais
Retorna uma página de carteiras pertencentes ao contexto individual derivado no backend.
curl -X GET 'https://api.witevexus.fun/api/v1/crypto/wallets' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/crypto/wallets
Credenciais
Cria uma carteira BSC ou TRON de forma idempotente. Exige também account.read para recuperação. A intent local vincula credencial, usuário, hash do custody subject, operação, método, rota, corpo canônico e chave; em resultado incerto, use recovery com a mesma chave.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/crypto/wallets' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"network": "TRON"
}'
{
"network": "TRON"
}
/api/v1/crypto/wallets/{walletId}
Credenciais
Retorna a carteira individual, inclusive o endereço de recebimento.
curl -X GET 'https://api.witevexus.fun/api/v1/crypto/wallets/{walletId}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/crypto/wallets/{walletId}/balances
Credenciais
Retorna uma lista de saldos por ativo; uma mesma carteira pode conter vários ativos.
curl -X GET 'https://api.witevexus.fun/api/v1/crypto/wallets/{walletId}/balances' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/crypto/wallets/{walletId}/transactions
Credenciais
Lista depósitos e saques desta carteira com asset_id e unidades inteiras.
curl -X GET 'https://api.witevexus.fun/api/v1/crypto/wallets/{walletId}/transactions' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/crypto/deposits
Credenciais
Lista depósitos pertencentes ao contexto individual.
curl -X GET 'https://api.witevexus.fun/api/v1/crypto/deposits' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/crypto/deposits/{depositId}
Credenciais
Retorna confirmações e estado observado do depósito.
curl -X GET 'https://api.witevexus.fun/api/v1/crypto/deposits/{depositId}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/crypto/withdrawals/quote
Credenciais
Cria uma cotação idempotente em unidades inteiras; não execute outra intenção após timeout sem recuperar a chave. A intent local vincula credencial, usuário, hash do custody subject, operação, método, rota, corpo canônico e chave; em resultado incerto, use recovery com a mesma chave.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/crypto/withdrawals/quote' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"network": "TRON",
"asset": "USDT_TRC20",
"destination_address": "TExampleAddressForDocumentationOnly",
"amount_units": "1000000",
"amount_mode": "NET"
}'
{
"network": "TRON",
"asset": "USDT_TRC20",
"destination_address": "TExampleAddressForDocumentationOnly",
"amount_units": "1000000",
"amount_mode": "NET"
}
/api/v1/crypto/withdrawals
Credenciais
Executa somente quote_id válido. Exige account.read e acompanhamento por GET até estado terminal. A intent local vincula credencial, usuário, hash do custody subject, operação, método, rota, corpo canônico e chave; em resultado incerto, use recovery com a mesma chave.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/crypto/withdrawals' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"quote_id": "00000000-0000-4000-8000-000000000002"
}'
{
"quote_id": "00000000-0000-4000-8000-000000000002"
}
/api/v1/crypto/withdrawals/{withdrawalId}
Credenciais
Retorna lifecycle e TXID quando disponível.
curl -X GET 'https://api.witevexus.fun/api/v1/crypto/withdrawals/{withdrawalId}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/crypto/swaps/quote
Credenciais
Cria uma cotação idempotente para um par publicado. A intent local vincula credencial, usuário, hash do custody subject, operação, método, rota, corpo canônico e chave; em resultado incerto, use recovery com a mesma chave.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/crypto/swaps/quote' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"asset_in": "USDT_TRC20",
"asset_out": "TRX",
"amount_in_units": "1000000",
"slippage_bps": 50
}'
{
"asset_in": "USDT_TRC20",
"asset_out": "TRX",
"amount_in_units": "1000000",
"slippage_bps": 50
}
/api/v1/crypto/swaps
Credenciais
Executa um quote_id de swap e exige polling até estado terminal. A intent local vincula credencial, usuário, hash do custody subject, operação, método, rota, corpo canônico e chave; em resultado incerto, use recovery com a mesma chave.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/crypto/swaps' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"quote_id": "00000000-0000-4000-8000-000000000003"
}'
{
"quote_id": "00000000-0000-4000-8000-000000000003"
}
/api/v1/crypto/swaps/{swapId}
Credenciais
Retorna valores realizados, hashes e estado conciliado.
curl -X GET 'https://api.witevexus.fun/api/v1/crypto/swaps/{swapId}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/crypto/internal-transfers
Credenciais
O cliente informa somente recipient_user_id local. A WiteVexus resolve o custody subject no backend e rejeita auto-transferência. A intent local vincula credencial, usuário, hash do custody subject, operação, método, rota, corpo canônico e chave; em resultado incerto, use recovery com a mesma chave.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/crypto/internal-transfers' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"recipient_user_id": 2,
"network": "TRON",
"asset": "USDT_TRC20",
"amount_units": "1000000"
}'
{
"recipient_user_id": 2,
"network": "TRON",
"asset": "USDT_TRC20",
"amount_units": "1000000"
}
/api/v1/crypto/conversions/capabilities
Credenciais
Contrato preparado, mas indisponível enquanto o gate de conversão estiver fechado.
curl -X GET 'https://api.witevexus.fun/api/v1/crypto/conversions/capabilities' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/crypto/conversions/markets
Credenciais
Contrato preparado, mas indisponível enquanto o gate de conversão estiver fechado.
curl -X GET 'https://api.witevexus.fun/api/v1/crypto/conversions/markets' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/crypto/conversions
Credenciais
Contrato preparado, mas indisponível enquanto o gate de conversão estiver fechado.
curl -X GET 'https://api.witevexus.fun/api/v1/crypto/conversions' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/crypto/conversions/deposit-address
Credenciais
Contrato preparado, mas indisponível enquanto o gate de conversão estiver fechado.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/crypto/conversions/deposit-address' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"asset": "USDT",
"network": "TRX"
}'
{
"asset": "USDT",
"network": "TRX"
}
/api/v1/crypto/conversion-operations
Credenciais
Contrato preparado, mas indisponível enquanto o gate de conversão estiver fechado. Consulte uma operação conhecida por ID para recuperação.
curl -X GET 'https://api.witevexus.fun/api/v1/crypto/conversion-operations' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/crypto/conversions/quote
Credenciais
Contrato preparado, mas indisponível enquanto o gate de conversão estiver fechado.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/crypto/conversions/quote' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"direction": "FIAT_TO_CRYPTO",
"asset": "USDT",
"network": "TRX",
"brl_amount_minor": "10000",
"destination_address": "TExampleAddressForDocumentationOnly"
}'
{
"direction": "FIAT_TO_CRYPTO",
"asset": "USDT",
"network": "TRX",
"brl_amount_minor": "10000",
"destination_address": "TExampleAddressForDocumentationOnly"
}
/api/v1/crypto/conversions/{conversionId}/confirm
Credenciais
Contrato preparado, mas indisponível enquanto o gate de conversão estiver fechado. A confirmação pública também exige coordenação atômica de reserva e ledger.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/crypto/conversions/{conversionId}/confirm' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{}'
{}
/api/v1/crypto/conversions/{conversionId}
Credenciais
Retorna o estado auditável. CONFIRMED/202 não comprova liquidação; aguarde settled_at.
curl -X GET 'https://api.witevexus.fun/api/v1/crypto/conversions/{conversionId}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
Consulta de saldo conforme o produto habilitado.
/api/v1/account/operations/by-idempotency/{idempotencyKey}
Credenciais
Recupera a intenção da mesma credencial e contexto individual após timeout. Codifique o segmento conforme RFC 3986 (`:` vira `%3A`). ACCEPTED encerra esta consulta; acompanhe o resource_id no GET específico e nunca o trate como liquidação.
curl -X GET 'https://api.witevexus.fun/api/v1/account/operations/by-idempotency/{idempotencyKey}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/account/fees
Credenciais
Retorna as taxas comerciais efetivas para PIX, boleto, cartão, cartão virtual, transferência interna e regras por ativo/rede cripto.
curl -X GET 'https://api.witevexus.fun/api/v1/account/fees' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/account/limits
Credenciais
Retorna os limites financeiros efetivos da conta em BRL para agregado, PIX, boleto e transferência interna.
curl -X GET 'https://api.witevexus.fun/api/v1/account/limits' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/balance
Credenciais
Consulta o saldo exposto pelo contrato da conta. Envie um objeto JSON vazio.
curl -X POST 'https://api.witevexus.fun/api/v1/balance' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Content-Type: application/json' \
--data '{}'
{}
Emissão e gestão de cartões virtuais pela WiteVexus.
/api/v1/cards/capabilities
Credenciais
Retorna a interseção das capacidades locais e dos produtos habilitados para a conta. O cliente não envia identidade externa: ela é estável e derivada no backend a partir da credencial autenticada.
curl -X GET 'https://api.witevexus.fun/api/v1/cards/capabilities' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/cards/products
Credenciais
Retorna os tipos de cartão virtual habilitados para a conta WiteVexus.
curl -X GET 'https://api.witevexus.fun/api/v1/cards/products' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/cards/rates
Credenciais
Retorna as taxas e limites publicados para cartões virtuais WiteVexus.
curl -X GET 'https://api.witevexus.fun/api/v1/cards/rates' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/cards/operations/by-idempotency/{idempotencyKey}
Credenciais
Consulta de forma sanitizada uma intenção criada pela mesma credencial e pelo mesmo titular. Use após timeout ou OPERATION_STATUS_AMBIGUOUS. ACCEPTED nunca comprova liquidação financeira. Uma recuperação de display não reexibe display_url; depois da expiração, crie outra sessão com uma nova chave.
curl -X GET 'https://api.witevexus.fun/api/v1/cards/operations/by-idempotency/{idempotencyKey}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/cards
Credenciais
Lista somente cartões vinculados localmente ao titular estável derivado da credencial. PAN e CVV nunca são retornados.
curl -X GET 'https://api.witevexus.fun/api/v1/cards' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/cards
Credenciais
Rota preparada em modo fail-closed. Só pode emitir quando capability mutável e política de tesouraria estiverem explicitamente liberadas.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/cards' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"product_code": "codigo-do-produto-habilitado",
"amount": "10.00",
"name_on_card": "CLIENTE EXEMPLO"
}'
{
"product_code": "codigo-do-produto-habilitado",
"amount": "10.00",
"name_on_card": "CLIENTE EXEMPLO"
}
/api/v1/cards/{cardId}
Credenciais
Retorna o estado e os dados não sensíveis somente após validar ownership local do titular.
curl -X GET 'https://api.witevexus.fun/api/v1/cards/{cardId}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/cards/{cardId}
Credenciais
Rota preparada em modo fail-closed. Não aceita corpo e só executa quando a capability efetiva de cancelamento estiver liberada.
Idempotency-Key.curl -X DELETE 'https://api.witevexus.fun/api/v1/cards/{cardId}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1'
/api/v1/cards/{cardId}/fund
Credenciais
Rota preparada em modo fail-closed. A recarga exige capability mutável, ownership local e tesouraria conciliada.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/cards/{cardId}/fund' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"amount": "10.00"
}'
{
"amount": "10.00"
}
/api/v1/cards/{cardId}/freeze
Credenciais
Rota preparada em modo fail-closed. Não aceita corpo e exige capability efetiva e ownership local.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/cards/{cardId}/freeze' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1'
/api/v1/cards/{cardId}/unfreeze
Credenciais
Rota preparada em modo fail-closed. Não aceita corpo e exige capability efetiva e ownership local.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/cards/{cardId}/unfreeze' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1'
/api/v1/cards/{cardId}/transactions
Credenciais
Lista as transações do cartão virtual sem expor dados sensíveis.
curl -X GET 'https://api.witevexus.fun/api/v1/cards/{cardId}/transactions' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/cards/{cardId}/display-sessions
Credenciais
Cria uma URL HTTPS de uso único e curta duração para iframe. A origem permitida é a origem HTTPS exata cadastrada na credencial; não envie corpo. A resposta usa no-store e a URL nunca é persistida, registrada nem reexibida por recovery.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/cards/{cardId}/display-sessions' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1'
Meios, produtos, links e relatório do checkout WiteVexus.
/api/v1/checkout/methods
Credenciais
Retorna somente meios de pagamento homologados e disponíveis para a conta autenticada.
curl -X GET 'https://api.witevexus.fun/api/v1/checkout/methods' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/checkout/report
Credenciais
Retorna métricas agregadas dos links e pedidos pertencentes à conta autenticada.
curl -X GET 'https://api.witevexus.fun/api/v1/checkout/report' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/checkout/products
Credenciais
Lista produtos ativos e arquivados do catálogo da conta.
curl -X GET 'https://api.witevexus.fun/api/v1/checkout/products' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/checkout/products
Credenciais
Cria um produto no catálogo. Meios que exigem identificação de produto externo só podem ser usados quando provider_product_id for informado.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/checkout/products' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"name": "Produto de exemplo",
"price": "49.90",
"currency": "BRL",
"payment_methods": [
"PIX"
]
}'
{
"name": "Produto de exemplo",
"price": "49.90",
"currency": "BRL",
"payment_methods": [
"PIX"
]
}
/api/v1/checkout/products/{productId}
Credenciais
Retorna o produto do catálogo pertencente à conta autenticada.
curl -X GET 'https://api.witevexus.fun/api/v1/checkout/products/{productId}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/checkout/products/{productId}
Credenciais
Atualiza uma versão do produto. Envie version retornado na leitura para impedir sobrescrita concorrente.
Idempotency-Key.curl -X PUT 'https://api.witevexus.fun/api/v1/checkout/products/{productId}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"name": "Produto atualizado",
"price": "59.90",
"currency": "BRL",
"payment_methods": [
"PIX"
],
"version": 1
}'
{
"name": "Produto atualizado",
"price": "59.90",
"currency": "BRL",
"payment_methods": [
"PIX"
],
"version": 1
}
/api/v1/checkout/products/{productId}
Credenciais
Arquiva o produto e os links ativos associados. A ação exige Idempotency-Key e não aceita corpo.
Idempotency-Key.curl -X DELETE 'https://api.witevexus.fun/api/v1/checkout/products/{productId}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1'
/api/v1/checkout/links
Credenciais
Lista links de pagamento, estado e métricas da conta autenticada.
curl -X GET 'https://api.witevexus.fun/api/v1/checkout/links' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/checkout/links
Credenciais
Cria um link avulso ou associado a produto. O payment_path retornado deve ser combinado com o domínio da sua operação.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/checkout/links' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"title": "Link de exemplo",
"product_id": 1,
"payment_methods": [
"PIX"
]
}'
{
"title": "Link de exemplo",
"product_id": 1,
"payment_methods": [
"PIX"
]
}
/api/v1/checkout/links/{linkId}
Credenciais
Retorna a configuração e o payment_path do link pertencente à conta autenticada.
curl -X GET 'https://api.witevexus.fun/api/v1/checkout/links/{linkId}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/checkout/links/{linkId}
Credenciais
Atualiza uma versão do link. Envie version retornado na leitura para impedir sobrescrita concorrente.
Idempotency-Key.curl -X PUT 'https://api.witevexus.fun/api/v1/checkout/links/{linkId}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"title": "Link atualizado",
"product_id": 1,
"payment_methods": [
"PIX"
],
"version": 1
}'
{
"title": "Link atualizado",
"product_id": 1,
"payment_methods": [
"PIX"
],
"version": 1
}
/api/v1/checkout/links/{linkId}/archive
Credenciais
Arquiva o link e impede novos pagamentos. Exige Idempotency-Key e não aceita corpo.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/checkout/links/{linkId}/archive' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1'
/api/v1/checkout/links/{linkId}/cancel
Credenciais
Cancela o link com motivo auditável e impede novos pagamentos. Exige Idempotency-Key.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/checkout/links/{linkId}/cancel' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"reason": "Cancelamento solicitado pelo integrador."
}'
{
"reason": "Cancelamento solicitado pelo integrador."
}
Contrato, plano, taxas, cobrança e status da conta WiteVexus.
/api/v1/white-label
Credenciais
Retorna, em uma única resposta, a situação do contrato, plano, adicionais, cobrança, taxas e produtos efetivamente habilitados.
curl -X GET 'https://api.witevexus.fun/api/v1/white-label' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/white-label/plan
Credenciais
Retorna o plano e os adicionais contratados pela conta autenticada.
curl -X GET 'https://api.witevexus.fun/api/v1/white-label/plan' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/white-label/fees
Credenciais
Retorna as taxas comerciais do plano, incluindo PIX, boleto, cartão virtual e regras por ativo/rede cripto.
curl -X GET 'https://api.witevexus.fun/api/v1/white-label/fees' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/white-label/billing
Credenciais
Retorna mensalidade, entrada, valor pendente, vencimento e situação de acesso. Não cria cobrança nem movimenta saldo.
curl -X GET 'https://api.witevexus.fun/api/v1/white-label/billing' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/white-label/status
Credenciais
Retorna somente a situação do contrato e se operações financeiras pela API estão liberadas.
curl -X GET 'https://api.witevexus.fun/api/v1/white-label/status' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
Regras, execução, consulta, cancelamento, devolução e relatório de Split Payment.
/api/v1/splits/rules
Credenciais
Lista as regras pertencentes à conta autenticada.
curl -X GET 'https://api.witevexus.fun/api/v1/splits/rules' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/splits/rules
Credenciais
Cria uma regra versionada por percentuais ou valores fixos.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/splits/rules' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"name": "Parceiros",
"mode": "PERCENTAGE",
"currency": "BRL",
"participants": [
{
"handle": "conta-parceira",
"percentage": "20.00"
}
]
}'
{
"name": "Parceiros",
"mode": "PERCENTAGE",
"currency": "BRL",
"participants": [
{
"handle": "conta-parceira",
"percentage": "20.00"
}
]
}
/api/v1/splits/rules/{ruleId}
Credenciais
Arquiva a versão anterior e cria uma nova versão da regra.
Idempotency-Key.curl -X PUT 'https://api.witevexus.fun/api/v1/splits/rules/{ruleId}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"name": "Parceiros v2",
"mode": "PERCENTAGE",
"currency": "BRL",
"participants": [
{
"handle": "conta-parceira",
"percentage": "25.00"
}
]
}'
{
"name": "Parceiros v2",
"mode": "PERCENTAGE",
"currency": "BRL",
"participants": [
{
"handle": "conta-parceira",
"percentage": "25.00"
}
]
}
/api/v1/splits/rules/{ruleId}
Credenciais
Arquiva a regra da conta. Esta operação não aceita corpo.
curl -X DELETE 'https://api.witevexus.fun/api/v1/splits/rules/{ruleId}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/splits
Credenciais
Cria a operação financeira e suas alocações a partir de uma regra ativa.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/splits' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"rule_id": "00000000-0000-4000-8000-000000000001",
"amount": 100,
"payer": {
"name": "Cliente de Exemplo",
"document": "52998224725",
"email": "cliente@example.com"
}
}'
{
"rule_id": "00000000-0000-4000-8000-000000000001",
"amount": 100,
"payer": {
"name": "Cliente de Exemplo",
"document": "52998224725",
"email": "cliente@example.com"
}
}
/api/v1/splits/{splitId}
Credenciais
Retorna a operação e as alocações visíveis à conta proprietária.
curl -X GET 'https://api.witevexus.fun/api/v1/splits/{splitId}' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/splits/{splitId}/cancel
Credenciais
Cancela um split somente quando o estado financeiro permitir. Não aceita corpo.
curl -X POST 'https://api.witevexus.fun/api/v1/splits/{splitId}/cancel' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'
/api/v1/splits/{splitId}/refund
Credenciais
Solicita devolução parcial ou total; uma resposta 202 indica processamento assíncrono.
Idempotency-Key.curl -X POST 'https://api.witevexus.fun/api/v1/splits/{splitId}/refund' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET' \
-H 'Idempotency-Key: pedido-1024-tentativa-1' \
-H 'Content-Type: application/json' \
--data '{
"amount": 25,
"comment": "Devolução parcial solicitada pelo cliente"
}'
{
"amount": 25,
"comment": "Devolução parcial solicitada pelo cliente"
}
/api/v1/splits/report
Credenciais
Retorna itens da conta autenticada no intervalo UTC informado.
curl -X GET 'https://api.witevexus.fun/api/v1/splits/report' \
-H 'Apikey: SEU_CLIENT_ID' \
-H 'X-Client-Secret: SEU_CLIENT_SECRET'