Como funciona
- Você cria uma configuração de Split associada a uma conta de recebimento (
bankAccountNumber). - Para cada configuração, você cadastra uma ou mais instruções (
instructions), cada uma definindo quanto repassar (amount+type), como o repasse é feito (transferType) e para quem (beneficiary). - A partir daí, todo pagamento recebido na conta de origem é dividido automaticamente conforme as instruções vigentes no momento do recebimento.
O Split é aplicado a todos os pagamentos recebidos na conta configurada. Não é possível aplicar o split apenas a transações específicas: a configuração vale para a conta como um todo.
O que é uma instrução e o que é um beneficiário?
Instrução é a regra de repasse: quanto sai (
amount), de que forma é calculado (type: PERCENTAGE ou FIXED) e por qual meio o dinheiro é enviado (transferType).Beneficiário é o objeto dentro da instrução com os dados da conta de destino: número da conta, agência, ISPB e os dados do titular (holder).Uma configuração pode ter várias instruções. O valor que não foi destinado a nenhuma delas permanece normalmente na conta de recebimento.Tipos de instrução (type)
PERCENTAGE
O valor repassado é calculado como uma porcentagem do valor total do pagamento. A porcentagem máxima permitida por instrução é de 5%.
FIXED
O valor repassado é um valor absoluto e fixo, independente do valor do pagamento recebido. Se o valor definido exceder 50% do valor da transação, o split não é executado para aquela instrução naquele pagamento.
Formas de repasse (transferType)
O campo transferType define por qual meio o beneficiário recebe o valor. Cada opção tem um comportamento e um nível de validação diferente.
Estrutura de dados
Configuração de Split
Instrução
Beneficiário (beneficiary)
Titular (holder)
Próximos passos
Configurar
Crie uma configuração de split e cadastre ou atualize instruções, por tipo de repasse.
Consultar
Liste todas as configurações ou consulte uma configuração específica por ID.
Remover
Remova uma configuração inteira ou apenas uma instrução específica.

