v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB

CriaTransacaoPixSplit

Cria uma transação via pix com split dos valores

Este método permite criar uma transação com o Pix, sendo que o pagamento deverá ser efetuado pelo cliente final abrindo o aplicativo do banco no qual possua conta e efetuando a leitura do QRCode gerado. A transação via Pix é criada no estado pendente, e será válida por um determinado tempo definido. Caso a mesma seja confirmada dentro do prazo proposto, esta será confirmada na URL de confirmação do comércio, o qual deve consultar o estado da mesma. Caso o tempo máximo seja ultrapassado, está será confirmada posteriormente como cancelada. <br /> A versão “split” permite distribuir automaticamente os créditos do pagamento via Pix em diversas contas K8 Fintech, 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. <br />

Requisição

Campo	Tipo	Descrição	Obrigatório
SplitValores	TransacaoSplit[]	Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas do meuK8, a partir do código de cliente e do valor respectivo	Sim
ClientId	Texto	Id do seller cadastrado	Não
Valor	Numérico com 2 decimais	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
Tipo	Texto	Informar D= para tipo de pix dinâmico, e E= para tipo de pix estático. Se não for informado o valor padrão é D	Não
SegundosExpiracao	Numérico	Tempo de validade do pagamento via Pix, em segundos, sendo aceitos valores de 300 (5 minutos) até 2592000 (30 dias)	Não (1)
DataVencimento	Dia/Mês/Ano	Data de validade do pagamento via Pix	Não(2)(3)
URLConfirmacao	Texto	URL de confirmação do comércio para indicar que o pagamento está em estado final	Não
ClienteDescricao	Texto	Descrição da compra	Sim
ClienteIP	Texto	IP do cliente final da transação	Não
ClienteCPFCNPJ	Texto	CPF/CNPJ do cliente final da transação	Sim
ClienteNome	Texto	Nome do cliente final da transação	Sim
ClienteEMail	Texto	E-mail do cliente final da transação	Não
NumeroPedido	Texto	Número interno do pedido	Não
Referencia	Texto	Referência para localização futura da transação	Não
TipoMulta	Texto	Tipo da multa a ser aplicada	Não
ValorMulta	Numérico com 2 decimais	Valor da multa a ser aplicada	Não
TipoJuros	Texto	Tipo do juro a ser aplicado	Não
ValorJuros	Numérico com 2 decimais	Valor do Juros a ser aplicado	Não
TipoDesconto	Texto	Tipo do desconto a ser aplicado	Não
ValorDesconto	Numérico	Numérico com 2 decimais	Não
DescontosDataFixa	Array	Desconto concedido por data fixa, sendo composto por: Data (no formato YYYY-MM-DD) e ValorDesconto(numérico com 2 casas decimais)	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

(1) - Se o SegundosExpiracao for preenchido, o DataVencimento não deve ser preenchido! (2) - Se o DataVencimento for preenchido, o SegundosExpiracao não deve ser preenchido! (3) - Horário de vencimento: quando enviado a DataVencimento o complemento de horário deve ser informado como T23:59:59. Exemplo: DataVencimento": "2025-10-14T23:59:59".

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
QRCodeTexto	Texto	Texto do QRCode para realizar o pagamento via Pix
QRCodeImagem	Texto	URL que gera a imagem do QRCode relacionado a transação

post/api/CriaTransacaoPixSplit

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

Método executado com sucesso

Retorno'OK' | 'ERRO'

DetalhesErrostring

Identificadorstring

QRCodeTextostring

QRCodeImagemstring