Portal para desenvolvedores Domvex

Envie client_id e client_secret no corpo JSON. O token tem validade de uma hora; autentique novamente quando expirar.

curl -X POST https://api.domvexbr.com/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"client_id":"SEU_CLIENT_ID","client_secret":"SEU_CLIENT_SECRET"}'

{
  "message": "Authentication successful.",
  "token": "eyJ...token",
  "user": {
    "id": 42,
    "name": "Sua empresa",
    "email": "financeiro@exemplo.com",
    "client_id": "SEU_CLIENT_ID"
  }
}

curl https://api.domvexbr.com/api/accounts/balance \
  -H "Authorization: Bearer SEU_TOKEN"

{
  "message": "Wallet balance retrieved successfully.",
  "total_balance": 1250.50,
  "balance": 1200.50,
  "balance_block": 50.00
}

total_balance corresponde à soma de balance e balance_block.

O código qrcode é o Pix copia e cola. A cobrança fica pendente até a confirmação e o saldo líquido é creditado conforme as tarifas da conta.

curl -X POST https://api.domvexbr.com/api/payments/deposit \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 25.90,
    "external_id": "pedido-1042-pix",
    "clientCallbackUrl": "https://app.exemplo.com.br/hooks/avalonpay",
    "payer": {
      "name": "João da Silva",
      "email": "joao@exemplo.com",
      "document": "12345678901"
    }
  }'

{
  "message": "Deposit created successfully.",
  "qrCodeResponse": {
    "transactionId": "identificador-da-transacao",
    "status": "PENDING",
    "qrcode": "00020126...",
    "amount": "25.90"
  }
}

Defina payment_method como card para cartão ou boleto para boleto via checkout. Abra a URL retornada no navegador. Os dados do cartão são informados no checkout hospedado.

curl -X POST https://api.domvexbr.com/api/payments/checkout \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 89.90,
    "external_id": "pedido-1042-card",
    "clientCallbackUrl": "https://app.exemplo.com.br/hooks/avalonpay",
    "payment_method": "card",
    "description": "Pedido 1042",
    "return_url": "https://app.exemplo.com.br/pedido/1042",
    "payer": {
      "name": "João da Silva",
      "email": "joao@exemplo.com",
      "document": "12345678901"
    }
  }'

{
  "message": "Payment checkout created successfully.",
  "paymentResponse": {
    "transactionId": "referencia-da-transacao",
    "status": "PENDING",
    "amount": "89.90",
    "payment_method": "card",
    "checkoutUrl": "URL HTTPS retornada pela operação",
    "preferenceId": "identificador-do-checkout"
  }
}

O mesmo endpoint atende depósito e cobrança. Use external_id exclusivo para identificar cada finalidade e envie o endereço completo do pagador.

curl -X POST https://api.domvexbr.com/api/payments/boleto \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 120.00,
    "external_id": "cobranca-1042",
    "description": "Pedido 1042",
    "payer": {
      "name": "João da Silva",
      "email": "joao@exemplo.com",
      "document": "12345678901",
      "address": {
        "street_name": "Rua das Flores",
        "street_number": "123",
        "neighborhood": "Centro",
        "city": "Florianópolis",
        "state": "SC",
        "zip_code": "88010000"
      }
    }
  }'

{
  "message": "Boleto created successfully.",
  "paymentResponse": {
    "transactionId": "identificador-da-transacao",
    "external_id": "cobranca-1042",
    "status": "PENDING",
    "amount": "120.00",
    "payment_method": "boleto",
    "boleto": {
      "barcode_content": "codigo-de-barras-quando-disponivel",
      "digitable_line": "linha-digitavel",
      "expiration_date": "data-de-vencimento"
    }
  }
}

O prazo de vencimento vem na resposta. Para atualizar o estado, consulte o endpoint de status. A página Domvex também gera um PDF próprio com a linha digitável e o código de barras retornados.

curl "https://api.domvexbr.com/api/payments/boleto/cobranca-1042/status" \
  -H "Authorization: Bearer SEU_TOKEN"

Uma referência repetida com o mesmo valor retorna a cobrança existente; se o valor for diferente, a API responde 409.

A operação reserva o valor mais as tarifas da conta. A resposta pode indicar PROCESSING; nesse caso, consulte o extrato e não envie uma nova referência até confirmar o estado.

curl -X POST https://api.domvexbr.com/api/withdrawals/withdraw \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 40.00,
    "external_id": "saque-1042",
    "pix_key": "12345678901",
    "key_type": "CPF",
    "name": "João da Silva",
    "taxId": "12345678901",
    "description": "Saque 1042",
    "clientCallbackUrl": "https://app.exemplo.com.br/hooks/avalonpay"
  }'

{
  "message": "Withdrawal processed successfully.",
  "withdrawal": {
    "transaction_id": "identificador-da-transacao",
    "status": "PROCESSING",
    "amount": 40.00,
    "type": "Withdrawal"
  }
}

Envie qr_code e, quando o código não incluir valor, informe também amount. A cotação não debita saldo.

{
  "qr_code": "00020126...",
  "amount": 20.00
}

{
  "merchant": "LOJA EXEMPLO",
  "city": "FLORIANOPOLIS",
  "amount": 20.00,
  "fee": 0.20,
  "api_fee": 0.10,
  "total": 20.30,
  "available_balance": 100.00,
  "sufficient_balance": true,
  "requires_amount": false
}

Confirme a cotação enviando o mesmo código e o valor total calculado em expected_total. A referência deve ter de 16 a 191 caracteres e conter letras, números, hífen ou sublinhado.

{
  "qr_code": "00020126...",
  "external_id": "pagamento-qr-1042-001",
  "expected_total": 20.30,
  "amount": 20.00
}