Documentação das APIs

Cria uma transação pix

Cria uma transação via pix para marketplace com split dos valores, tendo como participantes do split o Marketplace e os Sellers.
Cada participante é identificado pelo seu ClienteId, porém o Marketplace deve realizar o cadastro da seller primeiro para depois utilizar seu ClienteId como participante do split(utilize a rota seller para cadastro).
Uma transação de split precisa ser decidida depois de cadastrada, caso contrário os valores são considerados como suspensos e não são liberados para os participantes.
Um split requer no mínimo 2 e no máximo 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

CampoTipoDescrição
SplitValoresArrayArray 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.
TipoTextoE (tipo de PIX estático) ou D(tipo de pix dinâmico)
ValorNumérico com 2 decimaisValor da compra a ser pago(opcional)
SegundosExpiracaoNuméricoTempo de validade do pagamento via Pix, em segundos, sendo aceitos valores de 300 (5 minutos) até 2592000 (30 dias)
DataVencimentoDataData de vencimento no formato YYYY-MM-DD(opcional)
DataLimitePagamentoDataData limite para pagamento do título.Após esta data, o mesmo é baixado junto a CIP(opcional)
URLConfirmacaoTextoURL de confirmação do comércio para indicar que o pagamento está em estado final(opcional)
ClienteDescricaoTextoDescrição da compra(opcional)
ClienteIPTextoIP do cliente final da transação(opcional)
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transação
ClienteNomeTextoNome do cliente final da transação
ClienteEmailTextoE-mail do cliente final da transação(opcional)
NumeroPedidoTextoNúmero interno do pedido para controle do marketplace(opcional)
ReferenciaTextoReferência para localização futura do boleto(opcional)
TipoMultaTextoTipo da multa a ser aplicada, sendo os valores possíveis: NaoTemMulta, ValorFixo ou ValorPercentual(opcional)
ValorMultaNumérico com 2 decimaisValor da multa a ser aplicada
TipoJurosTextoTipo do juro a ser aplicado, sendo os valores possíveis: Isento, ValorAoDia ou TaxaMensal(opcional)
ValorJurosNumérico com 2 decimaisValor do Juros a ser aplicado
TipoDescontoTextoTipo do desconto a ser aplicado, sendo os valores possíveis: NaoTemDesconto, ValorFixoAteDataInformada ou PercentualADataInformada. (opcional)
ValorDescontoNumérico com 2 decimaisValor do desconto a ser aplicado
DescontosDataFixaArrayDesconto concedido por data fixa, sendo composto por: Data(no formato YYYY-MM-DD) e ValorDesconto(numérico com 2 casas decimais)
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
ClienteIdTextoO Id do seller(ou do marketplace) que terá a decisão aprovada(opcional)
ValorNumérico com 2 decimaisValor da parte da transação referente ao seller ou marketplace
ValorRoyaltiesNúmeroValor da parte da transação referente ao seller ou marketplace(opcional)
DecisaoTextoInforma se o slipt será criado como auto aprovado(opcional)
DescontoDataFixa--
DataTextoData limite para o desconto(opcional)
ValorDescontoNúmeroValor de desconto aplicado para pagamento até a data limite cadastrada(opcional)

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 gerada, caso chamada seja exitosa
QRCodeTextoTextoTexto do QRCode para realizar o pagamento via Pix.
QRCodeImagemTextoURL que gera a imagem do QRCode relacionado a transação.
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!