Logo

Crypto

Gerar Endereço de Depósito

POST/v1/crypto/deposits

Cria uma nova transação de depósito em criptomoedas. Retorna o endereço de depósito e QR Code para o cliente enviar os fundos.

Rate limit: 20 requisições por minuto

Definição do Body

Interface TypeScripttypescript
interface CreateCryptoDepositRequest {
  asset: "BTC" | "USDT" | "USDC" | "ETH";
  chain: "TRC20" | "ERC20" | "BEP20" | "BTC" | "POLYGON";
  amount: string;          // Número positivo, até 18 casas decimais
  webhook_url?: string;    // Máximo 255 caracteres
}

Parâmetros

CampoTipoDescrição
assetobrigatório
stringMoeda do depósito. Aceitos: BTC, USDT, USDC, ETH.
chainobrigatório
stringRede blockchain. Aceitas: TRC20, ERC20, BEP20, BTC, POLYGON. Deve ser compatível com o asset.
amountobrigatório
stringValor a depositar. Número positivo maior que zero, até 18 casas decimais.
webhook_url
stringURL para receber notificações de atualização (máx. 255 caracteres).
Use o endpoint GET /v1/crypto/chains para descobrir quais chains são compatíveis com cada asset antes de criar o depósito.

Campos da Resposta

CampoTipoDescrição
transaction_id
string (UUID)ID único da transação
asset
stringMoeda depositada (maiúsculas)
chain
string | nullRede blockchain (maiúsculas)
amount
stringValor original solicitado (antes da taxa)
net_amount
stringValor líquido creditado (amount - fee)
fee
stringTaxa da plataforma
deposit_address
stringEndereço blockchain para envio dos fundos
qr_code
stringQR Code do endereço em base64
expires_at
DateExpiração do endereço de depósito
status
stringPENDING_CONFIRMATION logo após a criação
created_at
DateData e hora de criação

Erros Possíveis

401

Não autenticado

  • "API Secret inválida"
400

Dados inválidos ou serviço desabilitado

  • "Serviço não habilitado"
  • "Chain incompatível com o asset informado"
POSThttps://api.connectpay.vc/v1/crypto/deposits
Headers
api-secret: sua-api-secret-aqui
idempotency-key: unique-key-12345
Content-Type: application/json
Request Body (JSON)
{
  "asset": "USDT",
  "chain": "ERC20",
  "amount": "100.50",
  "webhook_url": "https://seu-servidor.com/webhook"
}
cURL
curl -X POST "https://api.connectpay.vc/v1/crypto/deposits" \
  -H "api-secret: sua-api-secret-aqui" \
  -H "idempotency-key: unique-key-12345" \
  -H "Content-Type: application/json" \
  -d '{
    "asset": "USDT",
    "chain": "ERC20",
    "amount": "100.50",
    "webhook_url": "https://seu-servidor.com/webhook"
  }'
Response 200
{
  "hasError": false,
  "data": {
    "transaction_id": "550e8400-e29b-41d4-a716-446655440000",
    "asset": "USDT",
    "chain": "ERC20",
    "amount": "100.50",
    "net_amount": "99.50",
    "fee": "1.00",
    "deposit_address": "0x742d35Cc1D1B2F48dE3D7d8c53c4E7Db0C4bC123",
    "qr_code": "data:image/png;base64,iVBORw0KG...",
    "expires_at": "2024-01-15T10:30:00.000Z",
    "status": "PENDING_CONFIRMATION",
    "created_at": "2024-01-15T09:30:00.000Z"
  }
}