Cria uma transação via boleto para marketplace com split dos valores entre o marketplace e sellers participantes.
- O campo SplitValores deve conter entre 2 e 10 participantes, cada um identificado por seu ClienteId e valor de participação.
- O Marketplace deve cadastrar previamente os sellers antes de incluí-los como participantes (utilize o endpoint /seller).
- A transação gerada precisa ser decidida após a criação; caso contrário, os valores permanecem suspensos.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| SplitValores | TransacaoSplit[] | Lista de participantes do split | Sim |
| Valor | Numérico com 2 decimais | Valor total da transação | Sim |
| DataVencimento | Data | Data de vencimento do boleto | Sim |
| DataLimitePagamento | Data | Data limite para pagamento | Não |
| URLConfirmacao | Texto | URL chamada quando pagamento for finalizado | Não |
| ClienteDescricao | Texto | Descrição da compra | Sim |
| ClienteIP | Texto | IP do cliente | Sim |
| ClienteCPFCNPJ | Texto | CPF ou CNPJ do cliente final | Sim |
| ClienteNome | Texto | Nome do cliente final | Sim |
| ClienteEmail | Texto | E-mail do cliente | Não |
| ClienteEndereco | Texto | Endereço do cliente | Sim |
| ClienteBairro | Texto | Nome do bairro | Sim |
| ClienteCidade | Texto | Nome da cidade | Sim |
| ClienteCEP | Texto | CEP | Sim |
| ClienteUF | Texto | Unidade da federação (UF), ex: SP, RJ | Sim |
| ClienteDDD | Texto | DDD do telefone | Não |
| ClienteNumeroCelular | Texto | Número do celular | Não |
| NumeroPedido | Texto | Número do pedido no sistema do marketplace | Não |
| TipoMulta | Texto | Tipo da multa a ser aplicado | Não |
| ValorMulta | Numérico com 2 decimais | Valor da multa | Não |
| Multa | Numérico com 2 decimais | Valor da multa | Não |
| TipoJuros | Texto | Tipo de juros a ser aplicado | Não |
| ValorJuros | Numérico com 2 decimais | Valor dos juros | Não |
| TipoDesconto | Texto | Tipo de desconto a ser aplicado | Não |
| ValorDesconto | Numérico com 2 decimais | Valor do desconto | Não |
| DataDesconto | Data | Data de validade do desconto | Não |
| ValorDesconto2 | Numérico com 2 decimais | Segundo valor de desconto | Não |
| DataDesconto2 | Data | Data de validade do segundo desconto | Não |
| ValorDesconto3 | Numérico com 2 decimais | Terceiro valor de desconto | Não |
| DataDesconto3 | Data | Data de validade do terceiro desconto | Não |
| Mensagem2 | Texto | Mensagem personalizada no boleto | Não |
| Mensagem3 | Texto | Mensagem personalizada no boleto | Não |
| Mensagem4 | Texto | Mensagem personalizada no boleto | Não |
| Mensagem5 | Texto | Mensagem personalizada no boleto | Não |
| NumeroDocumento | Texto | Número do documento | Não |
| Referencia | Texto | Referência para controle | Não |
| RetornarBase64 | Booleano | Se true, retorna o PDF codificado em Base64 | Não |
| EntradaCNAB | Booleano | Se true, indica origem CNAB | Não |
| NossoNumero | Texto | Nosso número do boleto | Não |
| Carteira | Texto | Número da carteira | Não |
| ArbiCnabNumeroOperacao | Texto | Número da operação utilizada no CNAB | Não |
Campos dentro de SplitValores
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| ClienteId | Texto | Identificador do cliente (seller ou marketplace) | Sim |
| Valor | Numérico | Valor da transação destinado ao Marketplace ou Seller | Sim |
| ValorRoyalties | Numérico | 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 |
| Decisao | Texto | Se preenchido, define se o split está aprovado automaticamente | Não |
Enums
TipoMultaArbi
| Valor | Descrição |
|------------------|-------------------------------------|
| NaoTemMulta (0) | Não aplica multa |
| ValorFixo (1) | Aplica multa com valor fixo |
| ValorPercentual (2)| Aplica multa percentual sobre valor |
TipoJurosArbi
| Valor | Descrição |
|-----------------|---------------------------------------------|
| ValorAoDia (1) | Aplica juros por valor fixo ao dia |
| TaxaMensal (2) | Aplica juros com taxa mensal |
| Isento (3) | Sem juros |
TipoDescontoArbi
| Valor | Descrição |
|-------------------------------|----------------------------------------------------|
| NaoTemDesconto (0) | Sem desconto |
| ValorFixoAteDataInformada (1) | Desconto fixo até determinada data |
| PercentualADataInformada (2) | Desconto percentual até determinada data |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Retorno | Texto | OK ou ERRO |
| DetalhesErro | Texto | Detalhes em caso de erro |
| Identificador | Texto | Identificador da transação criada |
| NossoNumero | Texto | Nosso número do boleto gerado |
| LinhaDigitavel | Texto | Linha digitável do boleto |
| CodigoBarras | Texto | Código de barras do boleto |
| BoletoPDF | Texto | PDF do boleto em formato Base64 (caso RetornarBase64 = true) |
| CodigoErro | Texto | Código interno do erro |