Marketplace
Cria uma transação via boleto
Changed onCria uma transação via boleto para marketplace com split dos valores entre o marketplace e sellers participantes. <br />
- O campo SplitValores deve conter entre 2 e 10 participantes, cada um identificado por seu ClienteId e valor de participação.<br />
- O Marketplace deve cadastrar previamente os sellers antes de incluí-los como participantes (utilize o endpoint /seller).<br />
- 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 | Array de Objeto | Lista de participantes do split | Sim |
| ClienteId | GUID | Identificador do Cliente | Sim |
| Valor | Número | Valor da Transação | Sim |
| ValorRoyalties | Número | Valor da parte da transação referente ao seller ou marketplace | Não |
| Decisao | Texto | Informa se o split já está aprovado ou não para efetivação da transferência para o recebedor | Não |
| -- | -- | -- | -- |
| Valor | Numérico | 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 | Valor da multa | Não |
| Multa | Numérico | Valor da multa | Não |
| TipoJuros | Texto | Tipo de juros a ser aplicado | Não |
| ValorJuros | Numérico | Valor dos juros | Não |
| TipoDesconto | Texto | Tipo de desconto a ser aplicado | Não |
| ValorDesconto | Numérico | Valor do desconto | Não |
| DataDesconto | Data | Data de validade do desconto | Não |
| ValorDesconto2 | Numérico | Segundo valor de desconto | Não |
| DataDesconto2 | Data | Data de validade do segundo desconto | Não |
| ValorDesconto3 | Numérico | 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 | Este campo não deve ser utilizado | 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 |
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 |
post/api/marketplace/boleto
Request
- Base URLhttps://pagamentos.meuk8.com.br/PagamentosAPI
- URLhttps://pagamentos.meuk8.com.br/PagamentosAPI/api/marketplace/boleto
- AuthOAuth 2PasswordToken URL: /BknBankPagamentosAPI/token scopes: BknBankPagamentosAPI
Headers
Aeskeystring required
Request body
Example request
{
"SplitValores": [
{
"ClienteId": "5fc653b6-7fcb-4ec1-839b-12f6b27e7306",
"Valor": 70,
"ValorRoyalties": 0
},
{
"ClienteId": "61ab97db-e379-4c62-b877-f5116ad4a42f",
"Valor": 80.77,
"ValorRoyalties": 0
}
],
"Valor": 150.77,
"DataVencimento": "2026-09-03T10:15:28.6689382-03:00",
"DataLimitePagamento": "2026-09-18T10:15:28.6689382-03:00",
"URLConfirmacao": "https://www.meusite.com.br/webhook/confirmacao-transacao",
"ClienteDescricao": "Cliente Gold Nivel 25",
"ClienteIP": "127.0.0.1",
"ClienteCPFCNPJ": "48455151480",
"ClienteNome": "Renato Samuel Augusto Baptista",
"ClienteEmail": "renatosamuel@umdominio.com.br",
"ClienteEndereco": "Rua Canadá, 257",
"ClienteBairro": "Bacacheri",
"ClienteCidade": "Curitiba",
"ClienteCEP": "82510290",
"ClienteUF": "PR",
"ClienteDDD": "41",
"ClienteNumeroCelular": "999293802",
"NumeroPedido": "pedido.2026081910",
"TipoMulta": "ValorPercentual",
"ValorMulta": 3.22,
"Multa": 13.04,
"TipoJuros": "ValorAoDia",
"ValorJuros": 2.75,
"TipoDesconto": "ValorFixoAteDataInformada",
"ValorDesconto": 9.99,
"DataDesconto": "2026-08-23T10:15:28.6689382-03:00",
"ValorDesconto2": 6.99,
"DataDesconto2": "2026-08-27T10:15:28.6689382-03:00",
"ValorDesconto3": 3.99,
"DataDesconto3": "2026-08-31T10:15:28.6689382-03:00",
"Mensagem2": "Nao receber depois de 03/09/2026",
"Mensagem3": "Não aplicar o desconto após o vencimento.",
"Mensagem4": "Aplicar 5% de desconto antes do vencimento.",
"Mensagem5": "Inseria sua mensgagem aqui.",
"NumeroDocumento": "1829310288",
"Referencia": "2112513",
"RetornarBase64": false,
"EntradaCNAB": false,
"NossoNumero": "00009540025",
"Carteira": "121",
"ArbiCnabNumeroOperacao": "0000496",
"NotaFiscal": "004179629",
"CNABArquivo": "CNAB arquivo.txt"
}Response
Criacao da transacao
Changes
- info
removed the pattern
^(\d)+$from the request property(media type: application/json) - info
removed the pattern
^(\d)+$from the request property(media type: text/json) - info
removed the pattern
^(\d)+$from the request property(media type: application/xml) - info
removed the pattern
^(\d)+$from the request property(media type: text/xml) - info
removed the pattern
^(\d)+$from the request property(media type: application/x-www-form-urlencoded) - info
added the media type
application/jsonfor the response with the status - info
added the media type
application/xmlfor the response with the status - info
added the media type
text/jsonfor the response with the status - info
added the media type
text/xmlfor the response with the status
- info