post https://pagamentos.k8bank.com.br/PagamentosAPI/api/marketplace/boleto
Cria uma transação via boleto para marketplace com split dos valores, tendo como participantes do split o Marketplace e os Sellers.
Cada participante é identificado pelo seu ClienteId, porém o Marketplace deve realizar o cadastro do seller primeiro para depois utilizar seu ClienteId como participante do split(utilize a rota seller para cadastro).
Uma transação de split precisa ser decidida depois de cadastrada, caso contrário os valores são considerados como suspensos e não são liberados para os participantes.
Um split requer no mínimo 2 e no máximo 10 participantes, todos devidamente informados por seu ClienteId e qual seu valor de participação sobre o valor total da transação.
Requisição
| Campo | Tipo | Descrição |
|---|---|---|
| SplitValores | Array | Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas do K8Bank, a partir do código de cliente e do valor respectivo |
| Valor | Numérico com 2 decimais | Valor da compra a ser pago via boleto (opcional) |
| DataVencimento | Data | Data de vencimento quando pago via boleto (opcional) |
| DataLimitePagamento | Data | Data limite para pagamento do título.Após esta data, o mesmo é baixado junto a CIP (opcional) |
| URLConfirmacao | Texto | URL de confirmação do comércio para indicar que o pagamento está em estado final (opcional) |
| 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 | UF do cliente final da transação (opcional) |
| ClienteNumeroCelular | Texto | DDD do telefone do cliente final da transação (opcional) |
| NumeroPedido | Texto | Número interno do pedido para controle do marketplace (opcional) |
| TipoMulta | Texto | Tipo da multa a ser aplicada, sendo os valores possíveis: NaoTemMulta, ValorFixo ou ValorPercentual. (opcional) |
| ValorMulta | Numérico com 2 decimais | Valor da multa a ser aplicada |
| Multa | Moeda | Valor de multa após vencimento |
| TipoJuros | Texto | Tipo do juro a ser aplicado, sendo os valores possíveis: Isento, ValorAoDia ou TaxaMensal. (opcional) |
| ValorJuros | Numérico com 2 decimais | Valor do Juros a ser aplicado |
| TipoDesconto | Texto | Tipo do desconto a ser aplicado, sendo os valores possíveis: NaoTemDesconto, ValorFixoAteDataInformada ou PercentualADataInformada. (opcional) |
| ValorDesconto | Numérico com 2 decimais | Valor do desconto a ser aplicado. |
| DataDesconto | Texto | Data do desconto (opcional) |
| ValorDesconto2 | Número | Valor do desconto a ser aplicado (opcional) |
| DataDesconto2 | Texto | Data do desconto (opcional) |
| ValorDesconto3 | Número | Valor do desconto a ser aplicado (opcional) |
| DataDesconto3 | Texto | Data do desconto (opcional) |
| 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 (opcional) |
| Referencia | Texto | Referência para localização futura do boleto (opcional) |
| RetornarBase64 | 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 (opcional) |
| NossoNumero | Texto | Nosso número do boleto gerado (opcional) |
| Carteira | Texto | Número identificador da carteira junto ao banco (opcional) |
| ArbiCnabNumeroOperacao | Texto | Código do número de operação utilizado para geração de boleto via CNAB (opcional) |
| 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) |
| Decisao | Texto | Informa se o slipt será criado como auto aprovado. (opcional) |
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 gerada, caso chamada seja exitosa |
| 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 |
| CodigoErro | Texto | Código do erro retornado |