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.
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.
A versão “split” permite distribuir automaticamente os créditos do boleto em diversas contas K8Bank, 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.
Importante: é preciso ter em mãos os IDs dos clientes participantes do split. No exemplo do payload, os IDs são apenas de exemplo.
Requisição
| Campo | Tipo | Descrição |
|---|---|---|
| SplitValores | TransacaoSplit | - |
| ClienteId | Texto | O Id do seller(ou do marketplace) que terá a decisão aprovada. |
| Valor | Número | Valor da parte da transação referente ao seller ou marketplace. |
| ValorRoyalties | Número | Valor da parte da transação referente ao seller ou marketplace (opcional). |
| Valor | Numérico com 2 decimais | Valor da compra |
| DataVencimento | Texto | Data de vencimento quando pago via boleto |
| DataLimitePagamento | Texto | Data limite para pagamento do título. Após esta data, o mesmo é baixado junto a CIP |
| URLConfirmacao | Texto | URL de confirmação do comércio para indicar que o pagamento está em estado final. |
| ClienteDescricao | Texto | Descrição da compra. |
| ClienteIP | Texto | IP do cliente final da transação. |
| ClienteCPFCNPJ | Texto | CPF/CNPJ do cliente final da transação. |
| ClienteNome | Texto | Nome do cliente final da transação. |
| ClienteEMail | Texto | E-Mail do cliente final da transação (opcional) |
| ClienteEndereco | Texto | Endereço do cliente final da transação (opcional). |
| ClienteBairro | Texto | Bairro do cliente final da transação (opcional). |
| ClienteCidade | Texto | Cidade do cliente final da transação (opcional). |
| ClienteCEP | Texto | CEP do cliente final da transação (opcional). |
| ClienteUF | Texto | UF do cliente final da transação (opcional). |
| ClienteDDD | Texto | DDD do telefone do cliente final da transação (opcional). |
| ClienteNumeroCelular | Texto | Número do telefone do cliente final da transação (opcional). |
| NumeroPedido | Texto | Número do pedido e/ou carrinho de compras (opcional). |
| TipoMulta | Texto | Tipo da multa a ser aplicada, sendo os valores possíveis: NaoTemMulta, ValorFixo ou ValorPercentual. |
| ValorMulta | Número | Valor da multa a ser aplicada. |
| Multa | Número | Valor de multa após vencimento. |
| TipoJuros | Texto | Tipo do juro a ser aplicado, sendo os valores possíveis: Isento, ValorAoDia ou TaxaMensal. |
| ValorJuros | Número | Valor do Juros a ser aplicado. |
| TipoDesconto | Texto | Tipo do desconto a ser aplicado, sendo os valores possíveis: NaoTemDesconto, ValorFixoAteDataInformada ou PercentualADataInformada. |
| ValorDesconto | Número | Valor do desconto a ser aplicado. |
| DataDesconto | Texto | Data do desconto. |
| ValorDesconto2 | Número | Valor do desconto a ser aplicado. |
| DataDesconto2 | Texto | Data do desconto. |
| ValorDesconto3 | Número | Valor do desconto a ser aplicado. |
| DataDesconto3 | Texto | Data do desconto. |
| Mensagem2 | Texto | Mensagem orientativa inserida no boleto (opcional). |
| Mensagem3 | Texto | Mensagem orientativa inserida no boleto (opcional). |
| Mensagem4 | Texto | Mensagem orientativa inserida no boleto (opcional). |
| Mensagem5 | Texto | Mensagem orientativa inserida no boleto (opcional). |
| NumeroDocumento | Texto | Descritivo para localização futura do boleto. |
| Referencia | Texto | Referência para localização futura do boleto. |
| RetornoBase64 | Boleano | Aceita os valores true ou false, informando para retornar PDF do boleto codificado em texto formato Base64. |
| EntradaCNAB | Boleano | Aceita os valores true ou false, informando se a origem do boleto é CNAB. |
| NossoNumero | Texto | Nosso número do boleto gerado. |
| Carteira | Texto | Número identificador da carteira junto ao banco. |
| ArbiCnabNumeroOperacao | Texto | Código do número de operação utilizado para geração de boleto via CNAB. |
| NotaFiscal | Texto | Número da nota fiscal. |
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. |