←Trocar docs

Docs/Split de pagamentos

Split de pagamentos (USDT)

Repasse opcional de parte do valor de cada depósito USDT para outras empresas cadastradas na plataforma. O split é definido por depósito, no momento da criação da cobrança via API.

Ver autenticação Referência: POST /v1/deposits

Como funciona

  • Na criação do depósito (POST /v1/deposits), envie o array opcional splits com uma ou mais linhas.
  • Cada linha tem id (ULID da empresa que receberá o repasse) e percent (fração entre 0 e 1; por exemplo 0.03 = 3%).
  • Os percentuais incidem sobre o valor líquido após a taxa AurePay daquele depósito (valor da cobrança menos feeAmount), e não sobre o bruto.
  • A soma de todos os percent não pode ultrapassar 100%. Não é permitido informar a própria empresa da cobrança como destino.
  • Se o mesmo id aparecer mais de uma vez no array, os percentuais são somados antes da validação.
  • Quando o depósito on-chain for confirmado, o valor líquido fica para a empresa da cobrança e cada parceira recebe o USDT calculado; os percentuais são recalculados com o valor real recebido. O histórico aparece no painel para quem recebeu split.

Corpo da requisição (splits)

Além dos campos obrigatórios do depósito USDT (amount, network, customer, reference, etc.), inclua:

Formato do array splits (opcional)
{
  "splits": [
    { "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "percent": 0.03 },
    { "id": "01BX5ZZKBKACTAV9WEVGEMMVRZ", "percent": 0.02 }
  ]
}

Exemplos

Os exemplos abaixo usam a mesma autenticação dos demais endpoints. Substitua o ULID de exemplo pelo da empresa parceira real.

curl — depósito USDT com split
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": 100.00,
    "network": "trx",
    "customer": {
      "name": "Maria Souza",
      "email": "[email protected]",
      "phone": "+5511987654321",
      "document": "98765432100"
    },
    "reference": "pedido-loja-8821-split",
    "splits": [
      { "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "percent": 0.03 }
    ]
  }'
Node.js — depósito USDT com split
const response = await fetch('https://api.aure-ex.com/v1/deposits', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'SUA_API_KEY',
    'X-Api-Secret': 'SUA_API_SECRET',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 100.0,
    network: 'trx',
    customer: {
      name: 'Maria Souza',
      email: '[email protected]',
      phone: '+5511987654321',
      document: '98765432100'
    },
    reference: 'pedido-loja-8821-split',
    splits: [{ id: '01ARZ3NDEKTSV4RRFFQ69G5FAV', percent: 0.03 }]
  })
})

const data = await response.json()

Erros comuns da API

  • SPLIT_SELF_REFERENCE — tentativa de repasse para a mesma empresa que emite a cobrança.
  • SPLIT_EXCEEDS_DEPOSIT — soma dos splits maior que o líquido após taxa.
  • Validação Zod — percentual fora de 0–1, ULID inválido ou soma de percentuais maior que 100%.