---
title: "Cria uma transação via boleto com split dos valores"
method: POST
path: "/api/CriaTransacaoBoletoSplit"
tags: ["CriaTransacaoBoletoSplit"]
---

# Cria uma transação via boleto com split dos valores

`POST /api/CriaTransacaoBoletoSplit`

Este método permite criar uma transação de boleto, para a função de checkout transparente (implementado dentro do sistema web do comércio) de forma a permitir gerar um boleto com as informações indicadas e receber a linha digitável, nosso número e PDF do referido boleto, além de enviar um E-mail ao usuário final que deverá realizar o pagamento.
<br /> 

Notar que no momento da criação do boleto, a transação apresentará o estado “Pendente”. O sistema então verificará automaticamente pelo pagamento do referido boleto, e quanto este ocorrer, invoca a URL de confirmação indicada pelo comércio, para notificar do pagamento, o qual deverá consultar o estado da transação neste momento e realizar a respectiva baixa no seu sistema.
<br /> 

A versão “split” permite distribuir automaticamente os créditos do boleto em diversas contas K8 Fintech, para o caso de receitas rateadas, evitando a necessidades de repasses posteriores, sendo útil para casos de múltiplas empresas prestadoras de serviço de um grupo ou de múltiplos profissionais liberais.
<br /> 

**Importante:** é preciso ter em mãos os IDs dos clientes participantes do split. No exemplo do payload, os IDs são apenas de exemplo.
<br /> 

### Requisição 
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** | 
|--|--|--|--| 
| **SplitValores**            | **TransacaoSplit** | **-** | Sim |
| ClienteId              | GUID          | O Id do seller(ou do marketplace) que terá a decisão aprovada | Sim |
| Valor                  | Número         | Valor da transação destinado ao Marketplace ou Seller | Sim |
| ValorRoyalties          | Número         | Valor da transação destinado ao Marketplace ou Seller, sobre o qual poderão incidir taxas, conforme a configuração prévia definida para o participante do split | Não |
|--|--|--|--|
| Valor |  Numérico com 2 decimais |  Valor da transação destinado ao Marketplace ou Seller | Sim |
| DataVencimento | Texto | Data de vencimento quando pago via boleto | Sim |
| DataLimitePagamento  | Texto | Data limite para pagamento do título. Após esta data, o mesmo é baixado junto a CIP | Não |
| URLConfirmacao | Texto | URL de confirmação do comércio para indicar que o pagamento está em estado final | Não | 
| ClienteDescricao | Texto | Descrição da compra | Sim |
| ClienteIP | Texto | IP do cliente final da transação | Não | 
| ClienteCPFCNPJ | Texto | CPF/CNPJ do cliente final da transação | Sim | 
| ClienteNome | Texto | Nome do cliente final da transação | Sim |
| ClienteEMail | Texto | E-mail do cliente final da transação | Não | 
| ClienteEndereco | Texto |Endereço do cliente final da transação | Sim | 
| ClienteBairro | Texto | Bairro do cliente final da transação | Sim | 
| ClienteCidade | Texto | Cidade do cliente final da transação | Sim ||
| ClienteCEP | Texto |CEP do cliente final da transação | Sim | 
| ClienteUF | Texto |  UF do cliente final da transação | Sim | 
| ClienteDDD | Texto | DDD do telefone do cliente final da transação | Não | 
| ClienteNumeroCelular | Texto |Número do telefone do cliente final da transação | Não | 
| NumeroPedido | Texto |  Número do pedido e/ou carrinho de compras | Não |
| TipoMulta               | Texto    | Tipo da multa a ser aplicada | Não |
| ValorMulta              | Número   | Valor da multa a ser aplicada | Não |
| Multa                   | Número   | Valor de multa após vencimento | Não |
| TipoJuros               | Texto    | Tipo do juro a ser aplicado | Não |
| ValorJuros              | Número   | Valor do Juros a ser aplicado | Não |
| TipoDesconto            | Texto    | Tipo do desconto a ser aplicado | Não |
| ValorDesconto           | Número   | Valor do desconto a ser aplicado | Não |
| DataDesconto            | Texto    | Data do desconto | Não |
| ValorDesconto2          | Número   | Valor do desconto a ser aplicado | Não |
| DataDesconto2           | Texto    | Data do desconto | Não |
| ValorDesconto3          | Número   | Valor do desconto a ser aplicado | Não |
| DataDesconto3           | Texto    | Data do desconto | Não |
| Mensagem2               | Texto    | Mensagem orientativa inserida no boleto | Não |
| Mensagem3               | Texto    | Mensagem orientativa inserida no boleto | Não |
| Mensagem4               | Texto    | Mensagem orientativa inserida no boleto | Não |
| Mensagem5               | Texto    | Mensagem orientativa inserida no boleto | Não |
| NumeroDocumento          | Texto    | Descritivo para localização futura do boleto | Não |
| Referencia              | Texto    | Referência para localização futura do boleto | Não |
| RetornoBase64           | Booleano  | Aceita os valores true ou false, informando para retornar PDF do boleto codificado em texto formato Base64 | Não |
| EntradaCNAB             | Booleano  | Aceita os valores true ou false, informando se a origem do boleto é CNAB | Não |
| NossoNumero             | Texto    | Nosso número do boleto gerado | Não |
| Carteira                | Texto    | Número identificador da carteira junto ao banco | Não |
| ArbiCnabNumeroOperacao  | Texto    | Código do número de operação utilizado para geração de boleto via CNAB | Não |
| NotaFiscal              | Texto    | Número da nota fiscal | Não |

<br /> 

### Resposta 
|Campo | Tipo | Descrição | 
|--|--|--| 
| Retorno | Texto | Retorno da chamada, podendo possuir os valores OK ou ERRO | 
| DetalhesErro | Texto | Detalhes do erro gerado, caso o retorno seja ERRO | 
| Identificador | Texto | Identificador da transação | 
| NossoNumero | Texto | Nosso número do boleto gerado | 
| LinhaDigitavel | Texto | Linha digitável do boleto gerado | 
| CodigoBarras | Texto | Código equivalente ao binário do código de barras do boleto gerado | 
| BoletoPDF| Texto | PDF do boleto codificado em texto formato Base64 |

## Headers

- `Aeskey` string, required

## Request body

- BknBankPagamentosBusinessCriaTransacaoBoletoSplitRequest
  - `SplitValores` BknBankPagamentosBusinessTransacaoSplit[], required
    - `ClienteId` string, uuid
    - `Valor` number, double
    - `ValorRoyalties` number, double
    - `Decisao` string
  - `Valor` number, double
  - `DataVencimento` string, date-time
  - `DataLimitePagamento` string, date-time
  - `URLConfirmacao` string
  - `ClienteDescricao` string, required
  - `ClienteIP` string
  - `ClienteCPFCNPJ` string, required
  - `ClienteNome` string, required
  - `ClienteEmail` string
  - `ClienteEndereco` string
  - `ClienteBairro` string
  - `ClienteCidade` string
  - `ClienteCEP` string
  - `ClienteUF` string
  - `ClienteDDD` string
  - `ClienteNumeroCelular` string
  - `NumeroPedido` string
  - `TipoMulta` 'NaoTemMulta' | 'ValorFixo' | 'ValorPercentual'
  - `ValorMulta` number, double
  - `Multa` number, double
  - `TipoJuros` 'ValorAoDia' | 'TaxaMensal' | 'Isento'
  - `ValorJuros` number, double
  - `TipoDesconto` 'NaoTemDesconto' | 'ValorFixoAteDataInformada' | 'PercentualADataInformada'
  - `ValorDesconto` number, double
  - `DataDesconto` string, date-time
  - `ValorDesconto2` number, double
  - `DataDesconto2` string, date-time
  - `ValorDesconto3` number, double
  - `DataDesconto3` string, date-time
  - `Mensagem2` string
  - `Mensagem3` string
  - `Mensagem4` string
  - `Mensagem5` string
  - `NumeroDocumento` string
  - `Referencia` string
  - `RetornarBase64` boolean
  - `EntradaCNAB` boolean
  - `NossoNumero` string
  - `Carteira` string
  - `ArbiCnabNumeroOperacao` string
  - `NotaFiscal` string
  - `CNABArquivo` string

## Response `200`

Método executado com sucesso

- BknBankPagamentosBusinessCriaTransacaoBoletoSplitResponse
  - `Retorno` 'OK' | 'ERRO'
  - `DetalhesErro` string
  - `Identificador` string
  - `NossoNumero` string
  - `LinhaDigitavel` string
  - `CodigoBarras` string
  - `BoletoPDF` string
  - `CodigoErro` string

## Other responses

- `500` — Erro executando método

---

[API](https://skmtc.net/meuk8/apis/k8-fintech.md) · [All operations](https://skmtc.net/meuk8/apis/k8-fintech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meuk8/k8-fintech/revisions/14db4977f490/schema)