v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB

Marketplace

Cria uma transação pix

Cria uma transação via Pix para marketplace com split dos valores, tendo como participantes o Marketplace e os Sellers. Cada participante é identificado pelo seu ClienteId. O Marketplace deve cadastrar os sellers previamente para utilizar seus respectivos IDs.

Uma transação de split:

Requer entre 2 e 10 participantes, todos devidamente informados por seu ClienteId e qual seu valor de participação sobre o valor total da transação.

O tipo de Pix pode ser:

E = Estático
D = Dinâmico

Requisição

Campo	Tipo	Descrição	Obrigatório
SplitValores	TransacaoSplit[]	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	Sim
Tipo	Texto	Informar D = para tipo de pix dinâmico, e E = para tipo de pix estático	Sim
Valor	Numérico com 2 decimais	Valor total da compra	Sim
SegundosExpiracao	Inteiro	Tempo de validade do pagamento via Pix, em segundos, sendo aceitos valores de 300 até 2592000 (30 dias) para Pix Estático e 86400 (24 horas) para Pix Dinâmico	Não
DataVencimento	Data	Data de vencimento no formato YYYY-MM-DD	Não
DataLimitePagamento	Data	Data limite para pagamento	Não
URLConfirmacao	Texto	URL para callback de confirmação	Não
ClienteDescricao	Texto	Descrição da compra	Sim
ClienteIP	Texto	IP do cliente final	Sim
ClienteCPFCNPJ	Texto	CPF ou CNPJ do cliente final	Sim
ClienteNome	Texto	Nome completo do cliente final, tamanho máximo de 100 caracteres	Sim
ClienteEmail	Texto	E-mail do cliente final	Não
NumeroPedido	Texto	Número interno da transação,tamanho máximo de 20 caracteres	Não
Referencia	Texto	Referência de controle	Não
TipoMulta	Texto	Tipo da multa aplicada	Não
ValorMulta	Numérico com 2 decimais	Valor da multa	Não
TipoJuros	Texto	Tipo de juros aplicado	Não
ValorJuros	Numérico com 2 decimais	Valor do juros	Não
TipoDesconto	Texto	Tipo do desconto aplicado	Não
ValorDesconto	Numérico com 2 decimais	Valor do desconto	Não
DescontosDataFixa	Array	Lista de descontos por data fixa	Não
Pdv	Booleano	Indica se a transação foi realizada em um ponto de venda físico (PDV). Quando definido como true, a transação passa a seguir regras e validações específicas.	Não

Enums utilizados

TipoMultaArbi

Valor	Nome	Descrição
0	NaoTemMulta	Não será aplicada multa
1	ValorFixo	Multa será um valor fixo
2	ValorPercentual	Multa será um percentual do valor total

TipoJurosArbi

Valor	Nome	Descrição
1	ValorAoDia	Juros em valor fixo por dia
2	TaxaMensal	Juros aplicados como taxa percentual mensal
3	Isento	Sem cobrança de juros

TipoDescontoArbi

Valor	Nome	Descrição
0	NaoTemDesconto	Sem desconto
1	ValorFixoAteDataInformada	Desconto fixo até a data limite
2	PercentualADataInformada	Desconto percentual até a data limite

Resposta

Campo	Tipo	Descrição
Retorno	Texto	OK ou ERRO
DetalhesErro	Texto	Detalhes do erro (quando houver)
Identificador	Texto	Identificador único da transação
QRCodeTexto	Texto	Código Pix em formato de texto
QRCodeImagem	Texto	URL da imagem do QRCode gerado

post/api/marketplace/pix

Headers

Aeskeystring required

Request body

Tipostring required

Valornumber double

SegundosExpiracaointeger

DataVencimentostring date-time

DataLimitePagamentostring date-time

URLConfirmacaostring

ClienteDescricaostring required

ClienteIPstring

ClienteCPFCNPJstring required

ClienteNomestring required

ClienteEmailstring

NumeroPedidostring

Referenciastring

TipoMulta'NaoTemMulta' | 'ValorFixo' | 'ValorPercentual'

ValorMultanumber double

TipoJuros'ValorAoDia' | 'TaxaMensal' | 'Isento'

ValorJurosnumber double

TipoDesconto'NaoTemDesconto' | 'ValorFixoAteDataInformada' | 'PercentualADataInformada'

ValorDescontonumber double

Pdvboolean

Example request

{
  "SplitValores": [
    {
      "ClienteId": "4448eb20-3918-4cee-87b4-1f026e255687",
      "Valor": 70,
      "ValorRoyalties": 0
    },
    {
      "ClienteId": "06698162-731a-434f-a5f7-8ef5185ccb9b",
      "Valor": 80.77,
      "ValorRoyalties": 0
    }
  ],
  "Tipo": "E",
  "Valor": 103.24,
  "SegundosExpiracao": 300,
  "DataVencimento": "2026-05-21T09:52:51.0156089-03:00",
  "DataLimitePagamento": "0001-01-01T00:00: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",
  "NumeroPedido": "pedido.2026052109",
  "Referencia": "pag123",
  "TipoMulta": "ValorFixo",
  "ValorMulta": 10,
  "TipoJuros": "TaxaMensal",
  "ValorJuros": 12.3,
  "TipoDesconto": "ValorFixoAteDataInformada",
  "ValorDesconto": 5,
  "DescontosDataFixa": [
    {
      "Data": "2026-05-22T09:47:51.0156089-03:00",
      "ValorDesconto": 10
    },
    {
      "Data": "2026-05-24T09:47:51.0156089-03:00",
      "ValorDesconto": 5
    },
    {
      "Data": "2026-05-26T09:47:51.0156089-03:00",
      "ValorDesconto": 3
    }
  ],
  "Pdv": false
}

Response

Criacao da transacao

Retorno'OK' | 'ERRO'

DetalhesErrostring

Identificadorstring

QRCodeTextostring

QRCodeImagemstring