Visão Geral
O split de pagamento permite que, no momento do desembolso de uma CCB, um percentual ou valor fixo do valor seja direcionado automaticamente para uma conta beneficiária externa — sem intervenção manual. Isso é configurado diretamente no payload de criação da application, via o objeto split_beneficiary_account.
Endpoint
POST /banking/originator/applications
Payload Completo
Exemplo com percentage (percentual)
percentage (percentual){
"borrower": {
"id": "{{borrowerId}}"
},
"product": {
"id": "{{productId}}"
},
"funding": {
"id": "{{fundingId}}"
},
"simulation_id": "cfdd28ea-94aa-4f7b-806e-3b156bd0e90c",
"signature_collect_method": "LINK",
"signature_provider": "ZAPSIGN",
"split_beneficiary_account": {
"external_bank_account": {},
"holder": {
"name": "Felipe Tavares",
"taxpayer_id": "123456789"
},
"pix": {
"key": "[email protected]",
"key_type": "EMAIL"
},
"percentage": 10
}
}Exemplo com amount (valor monetário fixo)
amount (valor monetário fixo){
"requested_amount": 10000,
"interest_rate": 0.01,
"tac_amount": 0,
"finance_fee": 0,
"insurance_amount": 0,
"num_payments": 12,
"first_payment_date": "2026-05-17",
"disbursement_date": "2026-04-17",
"amortization_type": "PRICE",
"amortization_frequency": "MONTHLY",
"grace_period_amortization": [],
"interest_pre_type": "BASE_360",
"interest_rate_frequency": "MONTHLY",
"borrower": {
"id": "{{borrowerId}}"
},
"product": {
"id": "{{productId}}"
},
"funding": {
"id": "{{fundingId}}"
},
"simulation_id": "{{simulationId}}",
"signature_collect_method": "LINK",
"signature_provider": "CELCOIN",
"split_beneficiary_account": {
"external_bank_account": {
"ispb_code": "00000000",
"bank_account": "31231",
"bank_account_digit": "2",
"bank_branch": "0001",
"bank_account_type": "CACC"
},
"holder": {
"name": "Felipe Tavares",
"taxpayer_id": "12345678900"
},
"pix": {
"key": "[email protected]",
"key_type": "EMAIL"
},
"amount": 1000
}
}Referência de Campos
Campos raiz
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
borrower.id | uuid | sim | ID do tomador cadastrado |
product.id | uuid | sim | ID do produto configurado |
funding.id | uuid | sim | ID do fundo/originador |
simulation_id | uuid | sim | Retornado pelo endpoint /preview. Vincula os dados da simulação |
amortization_type | enum | sim | Tabela de amortização. PRICE (parcelas fixas) | SAC (parcelas decrescentes) |
amortization_frequency | enum | sim | Frequência de amortização. MONTHLY | outros conforme produto |
interest_rate_frequency | enum | sim | Frequência da taxa de juros. MONTHLY | ANNUAL |
signature_collect_method | enum | sim | Método de coleta de assinatura. LINK | WHATSAPP |
signature_provider | enum | sim | Provedor de assinatura. ZAPSIGN | CELCOIN |
split_beneficiary_account | object | não* | Configuração do split de pagamento no desembolso |
*
split_beneficiary_accounté obrigatório apenas quando o produto ou a operação exige split. Se omitido, o desembolso segue o fluxo padrão sem divisão.
Objeto split_beneficiary_account
split_beneficiary_account| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
external_bank_account | object | não | Dados de conta bancária convencional para o split. Pode ser enviado vazio {} quando o split é feito via PIX |
holder.name | string | sim | Nome completo do beneficiário do split |
holder.taxpayer_id | string | sim | CPF ou CNPJ do beneficiário (somente números) |
pix.key | string | sim* | Chave PIX do beneficiário |
pix.key_type | enum | sim* | Tipo da chave PIX: EMAIL | CPF | CNPJ | PHONE | EVP |
percentage | number | não** | Percentual do valor desembolsado a ser direcionado ao beneficiário (ex: 10 = 10%) |
amount | number | não** | Valor monetário fixo em reais a ser direcionado ao beneficiário (ex: 1000 = R$ 1.000,00) |
*
pixé obrigatório quandoexternal_bank_accountfor enviado vazio. Se ambos forem preenchidos, o PIX tem precedência — confirmar comportamento no ambiente de destino.
**
percentagevsamount— os dois campos são mutuamente exclusivos. Usepercentagepara definir um percentual sobre o valor total desembolsado, ouamountpara definir um valor fixo em reais. Envie apenas um deles por operação.
Como Funciona o Split
O split é executado automaticamente no momento do desembolso, após a application atingir o estado PENDING_DISBURSEMENT ou SCHEDULED_DISBURSEMENT.
Desembolso aprovado
→ Valor total calculado
→ Split: X% ou R$ X fixo → conta beneficiária (PIX ou conta bancária)
→ Restante → destino padrão do produto
→ Application → ISSUED
Exemplo com percentage: 10 e desembolso de R$ 1.500:
| Destino | Valor |
|---|---|
| Beneficiário do split | R$ 150,00 (10%) |
| Destino padrão | R$ 1.350,00 (90%) |
Exemplo com amount: 1000 e desembolso de R$ 10.000:
| Destino | Valor |
|---|---|
| Beneficiário do split | R$ 1.000,00 (fixo) |
| Destino padrão | R$ 9.000,00 |
Tipos de Chave PIX Suportados
key_type | Formato esperado em key |
|---|---|
EMAIL | [email protected] |
TAXPAYER_ID | CPF: 12345678900 · CNPJ: 12345678000100 (somente números) |
PHONE_NUMBER | +5511999999999 (com DDI) |
ALEATORY_KEY | UUID aleatório gerado pelo banco (chave aleatória) |
Provedores de Assinatura
signature_provider | signature_collect_method compatível | Observação |
|---|---|---|
ZAPSIGN | LINK | WHATSAPP | EMAIL | Recomendado para fluxos digitais |
CELCOIN | LINK | WHATSAPP | EMAIL | Verificar disponibilidade por produto |
UNICO | LINK | WHATSAPP | SMS | Validação biométrica — não suporta EMAIL |
CLICKSIGN | LINK | WHATSAPP | EMAIL | Suporte completo a métodos digitais |
Observações Importantes
simulation_id — gerado pelo endpoint /preview. Expira após um período configurado no produto. Sempre crie a application logo após a simulação para evitar expiração.
Percentual máximo — o campo percentage aceita valores de 1 a 100. Um split de 100 direciona o valor total ao beneficiário. Validar com o time de produto se há limite configurado por produto.
Valor fixo (amount) — o campo amount deve ser menor que o valor total do desembolso. Não envie amount e percentage simultaneamente no mesmo payload.
Erros Comuns
| Situação | Causa provável |
|---|---|
Erro na criação com split_beneficiary_account | taxpayer_id com formatação incorreta (enviar somente números) |
| PIX rejeitado no desembolso | Chave PIX inválida ou não cadastrada no banco do beneficiário |
simulation_id expirado | Tempo entre simulação e criação excedeu o limite configurado no produto |
| Split rejeitado no desembolso | amount e percentage enviados simultaneamente no mesmo payload |