Docs/Depósitos

Depósitos (USDT)

Gere endereço para depósito em USDT e acompanhe o status de liquidação em tempo real.

Ver requisitos de autenticação

Headers

X-Api-Key

stringobrigatório

chave da empresa

X-Api-Secret

stringobrigatório

secret da empresa

Content-Type

stringobrigatório

application/json

Parâmetros do body

amount

numberobrigatório

Valor em USDT (ex.: 297.97).

network

stringobrigatório

Rede aceita: ETH, MATIC, TRX ou TON.

customer

object | stringobrigatório

Objeto do cliente ou ID do cliente já existente na AureEX.

stringopcional

ID do cliente na AureEX.

name

stringobrigatório

Nome completo.

stringobrigatório

E-mail do cliente.

phone

stringobrigatório

Telefone do cliente.

document

stringopcional

CPF ou CNPJ (opcional).

metadata

objectopcional

Objeto opcional com valores string, number e boolean.

expiration

datetimeopcional

Data/hora em ISO 8601. Mínimo de 30 minutos e máximo de 24 horas a partir de agora. Se omitido, o padrão é 24 horas.

reference

stringobrigatório

ID único no seu sistema. Requisições repetidas com a mesma referência e os mesmos parâmetros retornam o mesmo depósito (idempotência).

splits

arrayopcional

Repasse USDT opcional por depósito. Cada item repassa parte do valor líquido (após taxa AurePay) para outra empresa.

string (ULID)obrigatório

Identificador da empresa que receberá o repasse.

percent

numberobrigatório

Percentual em fração decimal (ex.: 0.03 = 3%). A soma de todas as linhas não pode passar de 1.

curl

curl -X POST "https://api.aure-ex.com/v1/deposits" \
  -H "X-Api-Key: SUA_API_KEY" \
  -H "X-Api-Secret: SUA_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 99.97,
    "network": "trx",
    "customer": {
      "name": "João Silva Santos",
      "email": "[email protected]",
      "phone": "+5511987654321",
      "document": "12345678909"
    },
    "metadata": {
      "number": 1,
      "string": "yes",
      "boolean": true
    },
    "expiration": "2026-03-26T18:34:54.603Z",
    "reference": "6f1c0d9a-2d4f-4c86-8c9f-7d0c11c9b2a1"
  }'

200Response

{
  "success": true,
  "data": {
    "id": "01KJ8EXJCD435Q2AK9T6J6BE8H",
    "amount": 99.97,
    "feeAmount": 2.59922,
    "netAmount": 97.37078,
    "type": "deposit",
    "method": "usdt",
    "network": "trx",
    "currency": "usdt",
    "status": "pending",
    "qrCode": {
      "payload": "TJq2t8gHmwgymsJy447pqx5kTfKFW5wcsp",
      "imageEncoded": "data:image/png;base64,FAKE_IMAGE_BASE64"
    },
    "customer": {
      "id": "01K82CM4XJV9WHQY9EKMX0WV0S",
      "name": "João Silva Santos",
      "email": "[email protected]",
      "phone": "+5511987654321",
      "document": "12345678909"
    },
    "address": "TJq2t8gHmwgymsJy447pqx5kTfKFW5wcsp",
    "metadata": {
      "number": 1,
      "string": "yes",
      "boolean": true
    },
    "reference": "6f1c0d9a-2d4f-4c86-8c9f-7d0c11c9b2a1",
    "expiresAt": "2026-02-24T19:04:54.603Z",
    "createdAt": "2026-02-24T18:34:54.276Z",
    "updatedAt": "2026-02-24T18:34:54.604Z",
    "invoiceUrl": "https://checkout.aure-ex.com/payment/01KJ8EXJCD435Q2AK9T6J6BE8H"
  }
}

4xxError

{
  "error": {
    "code": "DUPLICATE_KEY",
    "message": "O valor que você informou já está cadastrado. Use outro e envie novamente.",
    "details": [
      {
        "field": "reference",
        "error": "Já existe uma transação cadastrada com esta referência."
      }
    ]
  },
  "success": false
}

Exemplo de resposta com split

Quando splits é enviado, a resposta pode incluir o snapshot splits (valores em micro USDT no servidor, exibidos em USDT) e o netAmount da empresa da cobrança já desconta esses repasses, além da taxa.

Sucesso — USDT com split (ilustrativo)

{
  "success": true,
  "data": {
    "id": "01KFAKEDEPOSIT000000000002",
    "amount": 100,
    "feeAmount": 2.6,
    "netAmount": 94.482,
    "type": "deposit",
    "method": "usdt",
    "network": "trx",
    "currency": "usdt",
    "status": "pending",
    "splits": [
      { "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "amount": 2.918, "percent": 0.03 }
    ],
    "qrCode": {
      "payload": "TJq2t8gHmwgymsJy447pqx5kTfKFW5wcsp",
      "imageEncoded": "data:image/png;base64,FAKE_IMAGE_BASE64"
    },
    "customer": {
      "id": "01KFAKECUSTOMER000000000002",
      "name": "Maria Souza",
      "email": "[email protected]",
      "phone": "+5511987654321",
      "document": "98765432100"
    },
    "address": "TJq2t8gHmwgymsJy447pqx5kTfKFW5wcsp",
    "reference": "pedido-loja-8821-split-usdt",
    "expiresAt": "2026-03-30T18:00:00.000Z",
    "createdAt": "2026-03-30T12:00:00.000Z",
    "updatedAt": "2026-03-30T12:00:00.000Z",
    "invoiceUrl": "https://checkout.aure-ex.com/payment/01KFAKEDEPOSIT000000000002"
  }
}