Splits

Split divide o valor líquido de uma venda entre múltiplos destinatários — comum em marketplaces (plataforma + vendedor) ou em qualquer cenário de repasse automático.

Dois conceitos separados

Recipient (/v1/recipients) — dá identidade a QUEM pode receber (nome, documento, conta bancária). Cadastre um pra cada destinatário possível.
Regra de split — define O QUANTO cada Recipient recebe de uma venda. Configurada hoje via a API admin (Backoffice ou POST /admin/split-rules), não por /v1.

const recipient = await gateway.recipients.create({
  name: 'Loja Parceira LTDA',
  document: '12345678000190',
  bankAccount: { bankCode: '341', agency: '0001', account: '123456-7', accountType: 'checking' },
});

Depois de cadastrado, referencie recipient.id na regra de split (Backoffice → Split Rules, ou POST /admin/split-rules com uma sessão de admin) — percentual ou valor fixo por destinatário, com prioridade entre regras quando mais de uma casa com a venda.

Limitação desta entrega

Configurar uma regra de split direto via /v1 (sem passar pelo Backoffice/API admin) não está disponível nesta entrega — só o cadastro de destinatários (Recipient) é público.

Como aparece no dinheiro

Cada venda com uma regra de split aplicável gera recebíveis (Receivable) separados por destinatário — um pro merchant, um pra cada Recipient — que depois viram repasses (Settlement) na liquidação. Ver GET /v1/receivables e GET /v1/settlements.