CriaTransacaoPixSplit

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

Changed on

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 MeuK8, 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

CampoTipoDescriçãoObrigatório
SplitValoresArray de ObjetoArray especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas do K8 Fintech, a partir do código de cliente e do valor respectivoSim
ClienteIdGUIDIdentificador do ClienteSim
ValorNúmeroValor da TransaçãoSim
ValorRoyaltiesNúmeroValor da parte da transação referente ao seller ou marketplaceNão
DecisaoTextoInforma se o split já está aprovado ou não para efetivação da transferência para o recebedorNão
--------
TipoTextoInformar D = para tipo de pix dinâmico, e E = para tipo de pix estáticoSim
ValorNuméricoValor da compraSim
SegundosExpiracaoNúmeroTempo 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âmicoNão(1)(3)
DataVencimentoDataData de validade do pagamento via PixNão(2)(3)
DataLimitePagamentoDataData limite do pagamento via PixNão
URLConfirmacaoTextoURL de confirmação do comércio para indicar que o pagamento está em estado finalNão
ClienteDescricaoTextoDescrição da compraSim
ClienteIPTextoIP do cliente final da transaçãoNão
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transaçãoSim
ClienteNomeTextoNome do cliente final da transaçãoSim
ClienteEmailTextoE-mail do cliente final da transaçãoNão
NumeroPedidoTextoNúmero interno do pedidoNão
ReferenciaTextoReferência para localização futura da transaçãoNão
TipoMultaTextoTipo da multa a ser aplicada - NaoTemMulta, ValorFixo, ValorPercentualNão
ValorMultaNuméricoValor da multa a ser aplicadaNão (4)
TipoJurosTextoTipo do juro a ser aplicado - ValorAoDia, TaxaMensal, IsentoNão
ValorJurosNuméricoValor do Juros a ser aplicadoNão (5)
TipoDescontoTextoTipo do desconto a ser aplicado - NaoTemDesconto, ValorFixoAteDataInformada, PercentualADataInformadaNão
ValorDescontoNumérico com 2 decimaisValor do desconto a ser aplicadoNão (6)
DescontosDataFixaArray de ObjetoDesconto concedido por data fixaNão (6)
DataDataData do descontoNão (7)
ValorDescontoNuméricoValor do descontoNão (7)
--------
PdvBooleanoIndica 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) - Obrigatório informar quando PDV = true, e devem estar entre 30 e 2.592.000 segundos (30 dias) (2) - Quando PDV = true, deve ser informado apenas o campo SegundosExpiracao (3) - Quando Tipo = "D" (Dinâmico) deve ser informado somente SegundosExpiracao ou DataVencimento (4) - Obrigatório informar caso TipoMulta for enviado (5) - Obrigatório informar caso TipoJuros for enviado (6) - Quando for enviado TipoDesconto um dos campos ValorDesconto ou DescontosDataFixa deve ser informado

Resposta

CampoTipoDescrição
RetornoTextoRetorno da chamada, podendo possuir os valores OK ou ERRO
DetalhesErroTextoDetalhes do erro gerado, caso o retorno seja ERRO
IdentificadorTextoIdentificador da transação
QRCodeTextoTextoTexto do QRCode para realizar o pagamento via Pix
QRCodeImagemTextoURL que gera a imagem do QRCode relacionado a transação
post/api/CriaTransacaoPixSplit

Request

  • Base URL
    https://pagamentos.meuk8.com.br/PagamentosAPI
  • URL
    https://pagamentos.meuk8.com.br/PagamentosAPI/api/CriaTransacaoPixSplit
  • Auth
    OAuth 2
    Password
    Token URL: /BknBankPagamentosAPI/token scopes: BknBankPagamentosAPI

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": "7dffb6aa-6626-4ee2-b1fb-e4fcee212a2b",
      "Valor": 70,
      "ValorRoyalties": 0
    },
    {
      "ClienteId": "8017157b-ecf9-4bdf-a823-92dabbec614d",
      "Valor": 80.77,
      "ValorRoyalties": 0
    }
  ],
  "Tipo": "E",
  "Valor": 103.24,
  "SegundosExpiracao": 300,
  "DataVencimento": "2026-08-19T10:20:28.6835343-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.2026081910",
  "Referencia": "pag123",
  "TipoMulta": "ValorFixo",
  "ValorMulta": 10,
  "TipoJuros": "TaxaMensal",
  "ValorJuros": 12.3,
  "TipoDesconto": "ValorFixoAteDataInformada",
  "ValorDesconto": 5,
  "DescontosDataFixa": [
    {
      "Data": "2026-08-20T10:15:28.6835343-03:00",
      "ValorDesconto": 10
    },
    {
      "Data": "2026-08-22T10:15:28.6835343-03:00",
      "ValorDesconto": 5
    },
    {
      "Data": "2026-08-24T10:15:28.6835343-03:00",
      "ValorDesconto": 3
    }
  ],
  "Pdv": false
}

Response

Método executado

Retorno'OK' | 'ERRO'
DetalhesErrostring
Identificadorstring
QRCodeTextostring
QRCodeImagemstring

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

      removed the non-success response with the status