Split de Pagamentos
O que você vai aprender com este artigo?
- Como configurar o Split de Pagamento no painel da iugu
- Diferença entre Split via Alia e Split via API
- Como agregar valores fixos e percentuais ao realizar o Split de Pagamento via API
- Limitações do Split de Pagamento, como o número máximo de contas para dividir os valores
- Como configurar o Split de Pagamento por fatura para maior flexibilidade
Para contas no Plano Marketplace, é possível usar o Split de Pagamento através da estrutura de Conta Mestre e Subcontas, permitindo que a conta criadora da fatura divida e transfira os valores automaticamente assim que o pagamento for realizado.
Split via Alia
O Split de Pagamento utilizando o painel da iugu é configurado na Conta Mestre e no momento da criação de uma Subconta. Esta configuração será global, ou seja, todas as faturas irão splitar para estas contas.
Durante a criação, é possível escolher se o split será:
- Valor fixo (
cents
) ou percentual do valor total da fatura (percent
) - Valor (fixo ou percentual) se pago com Cartão de Crédito
- Valor (fixo ou percentual) se pago com Boleto Bancário
- Valor (fixo ou percentual) se pago com Pix
É possível realizar o split para contas não iugu?
Não. Hoje, a divisão de valores é realizada apenas entre contas iugu (mestre e sub).
Agregar %
e cents
%
e cents
É possível somar valores fixos (cents
) e percentual (percent
), porém, apenas via API, nos endpoints Criar Fatura, Configurar Conta, Criar Assinatura e Criar Splits através do objeto e parâmetro abaixo:
{
"splits": [
{
"permit_aggregated": true
}
]
}
Caso contrário...
A mensagem de erro "Split deve ter valor em centavos ou em percentual" será exibida no retorno desta chamada.
Split via API
Dada a sua natureza, o Split por API tem um grau de personalização muito maior do que o Alia. Um exemplo já citado é permitir agregar o valor percentual + fixo. Abaixo está uma lista do que é possível e parâmetro:
Parâmetro | Descrição | API | Alia |
---|---|---|---|
bank_slip_cents | Valor em centavos a ser cobrado apenas em transações no boleto | ✅ | ✅ |
credit_card_cents | Valor em centavos a ser cobrado apenas em transações no cartão de crédito | ✅ | ✅ |
pix_cents | Valor em centavos a ser cobrado apenas em transações no pix | ✅ | ✅ |
bank_slip_percent | Valor em porcentagem a ser cobrado apenas em transações no boleto | ✅ | ✅ |
credit_card_percent | Valor em porcentagem a ser cobrado apenas em transações no cartão de crédito. | ✅ | ✅ |
pix_percent | Valor em porcentagem a ser cobrado apenas em transações no pix | ✅ | ✅ |
permit_aggregated | Permite agregar comissionamento percentual + fixo | ✅ | ❌ |
credit_card_1x_cents | Valor em centavos a ser cobrado apenas em transações em 1x no cartão de crédito | ✅ | ❌ |
credit_card_1x_percent | Valor em porcentagem a ser cobrado apenas em transações em 1x no cartão de crédito | ✅ | ❌ |
credit_card_Yx_cents
/credit_card_Yx_percent
credit_card_Yx_cents
/credit_card_Yx_percent
Para otimizar sua leitura, ocultamos as parcelas de 2 a 12 (percent e cents) para faturas pagas com Cartão de Crédito. No entanto, é possível definir um valor de split específico para cada número de parcelas, de 2x até 12x (ou até 18x para contas antigas).
Requisição exemplo
{
"splits": [
{
"recipient_account_id": "27016E1AD888499A98994E781B6C3762",
"permit_aggregated": true,
"percent": 3,
"cents": 200
}
]
}
Importante ⚠️
- Nunca insira o
account_id
da conta criadora da Fatura. - A soma dos Splits nunca deve totalizar 100% do valor da fatura; caso contrário, a divisão entre as contas não será processada, e, quando a invoice for paga, o valor total será destinado à conta criadora
Split por Fatura (Split Variável)
O Split por Fatura é uma alternativa ao Split Padrão da Conta, que permite tornar as regras/valores variáveis aumentando o grau de flexibilidade deste recurso.
Para isso, utilize o objeto splits
do endpoint Criar Fatura — POST
/v1/invoices
ao invés de apenas utilizar o Configurar Conta para isso.
Split por Assinatura (Split Variável)
O Split por Assinatura funciona semelhantemente ao Split por Fatura, contando também com o objeto splits
sem sua composição.
Ao utilizá-lo, todas as faturas desta assinatura, respeitarão a regra aplicada no momento da requisição de criação.
Requisição exemplo
curl --request POST \
--url 'https://api.iugu.com/v1/subscriptions?api_token=seu-api_token' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--'data
{
"plan_identifier": "basic_plan",
"customer_id": "282BF13F9DBF4D3D8C5D344FEA370F78",
"splits": [
{
"recipient_account_id": "ID da Conta",
"cents": 45
}
]
}
'
Há limite de contas para Split?
Há uma resposta para cada meio:
Alia
Sim. O split está limitado à uma Conta (Conta Mestre e Subconta).
API
Não! Não há limite de contas para splitar uma fatura API. Insira quantos objetos precisar:
{
"splits": [
{
"recipient_account_id": "Subconta A",
"cents": 120,
"percent": 3
},
{
"recipient_account_id": "Subconta B",
"cents": 234,
"percent": 2
},
{
"recipient_account_id": "Subconta C",
"cents": 231,
"percent": 2
}
]
}
Updated 4 days ago