Splits

Splits permitem distribuir automaticamente uma fração do valor líquido de uma transação para outros vendedores cadastrados na plataforma — sem intervenção manual. É útil para modelos de co-venda, royalties, parcerias e repasses automáticos.

Como funciona

Ao criar uma transação, envie o campo splits com a lista de e-mails e os respectivos percentuais. Quando o pagamento for confirmado, a ÁureaPag calcula e credita automaticamente cada parcela no saldo de cada vendedor.

Valor bruto da transação
  − Taxas da plataforma
  = Valor líquido

Valor líquido × percentual do split  →  creditado ao parceiro
Valor líquido − total dos splits     →  creditado ao dono da transação

Campo splits no body

Regras e validações

• Mínimo por split: 1 bp (0,01%)
• Máximo por split: 9000 bp (90%)
• Sem e-mails repetidos: o mesmo e-mail não pode aparecer mais de uma vez na mesma transação
• Soma dos splits: a soma total não pode exceder o valor líquido da transação
• Os splits são calculados sobre o valor líquido (após taxas), não sobre o valor bruto

Exemplo

Transação de R$ 100,00 com taxa de 5% e um split de 20% para um parceiro:

Request

{
  "external_id": "pedido-456",
  "payment_method": "pix",
  "amount": 10000,
  "buyer": {
    "name": "Maria Souza",
    "email": "maria@email.com"
  },
  "splits": [
    {
      "email": "parceiro@email.com",
      "percentage_bps": 2000
    }
  ]
}

Múltiplos splits

É possível enviar mais de um split na mesma transação:

{
  "splits": [
    { "email": "parceiro-a@email.com", "percentage_bps": 1500 },
    { "email": "parceiro-b@email.com", "percentage_bps": 500 }
  ]
}

Neste caso, 15% vai para o parceiro A e 5% para o parceiro B — totalizando 20% distribuído. O vendedor principal fica com 80% do líquido.

Erros

E-mail duplicado na mesma requisição

{
  "error": {
    "message": "invalid_split",
    "detail": "O email 'parceiro@email.com' foi enviado mais de uma vez no mesmo split."
  }
}

E-mail não encontrado

{
  "error": {
    "message": "split_seller_not_found",
    "detail": "Nenhum seller encontrado com o email 'parceiro@email.com'."
  }
}

Vendedor inativo

{
  "error": {
    "message": "split_seller_inactive",
    "detail": "O seller com o email 'parceiro@email.com' não está ativo."
  }
}

percentage_bps fora do intervalo

{
  "error": "Invalid split percentage_bps: <valor>. Must be between 1 and 9000."
}

Visualização no dashboard

• Extrato (Balances): os vendedores que receberam splits visualizam as entradas com o tipo Split (badge laranja) no extrato
• Transações: o dono da transação vê um indicador Split na listagem e, nos detalhes, o percentual e o valor total distribuído