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.

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.

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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

requisição de entrada

SplitValores
array of objects
SplitValores
string
required
E|D
double
≤ 2147483647
int32
date-time
date-time
string
string
required
string
string
required
string
required
string
string
string
string
enum
Allowed:
double
string
enum
Allowed:
double
string
enum
Allowed:
double
DescontosDataFixa
array of objects
DescontosDataFixa
boolean
Headers
string
required
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json