Emitir boleto com split de valores
POST
/api/CashIn/GerarBoletoSplit
CashIn
Funcionalidade principal
A requisição é similar à de um boleto padrão, com o acréscimo do array DadosSplit. Dentro deste array, você deve enviar uma lista de objetos, onde cada objeto representa um participante que receberá uma parte do valor, identificado por seuCodigoCanaleCodigoCliente, e oValorespecífico que lhe é destinado.
Casos de uso comuns
1.
2.
3.
Nota importante: A soma dos campos Valorde todos os objetos dentro do arrayDadosSplitdeve ser exatamente igual aoValortotal do boleto. A divisão dos valores ocorrerá automaticamente após a compensação bancária do boleto, que pode levar de 1 a 3 dias úteis.
Requisição
Parâmetros Header
Parâmetros Bodyapplication/json
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/CashIn/GerarBoletoSplit' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"Data": {
"CodigoCanal": 0,
"CodigoCliente": 0,
"DataVencimento": "string",
"Valor": 0,
"Email": "string",
"DadosSacado": {
"CpfCnpj": 0,
"Nome": "string",
"Endereco": "string",
"Bairro": "string",
"Cidade": "string",
"Cep": 0,
"Uf": "st",
"DdiTerceiro": 0,
"DddTerceiro": 0,
"NumeroCelularTerceiro": 0
},
"IdentificadorCliente": "string",
"RetornarBase64": false,
"Juros": {
"Valor": 0
},
"Multa": {
"Valor": 0
},
"DadosSplit": [
{
"CodigoCanal": 0,
"CodigoCliente": 0,
"Valor": 0
}
]
}
}'Response Response Example
{
"Data": {
"NossoNumero": "string",
"LinhaDigitavel": "string",
"Base64": "string"
},
"ResultCode": 0,
"Message": "string",
"ValidationData": {
"ResultCode": 0,
"Message": "string",
"Errors": [
{
"ErrorMessage": "string",
"FieldName": "string"
}
]
}
}Modificado em 2026-03-03 14:57:19